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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.101     rillig      6: <link rel="stylesheet" href="/global.css" type="text/css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
                     10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en">
                     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     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.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     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.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.104     rillig     33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.106     rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.76      rillig     35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
                     48: <dl>
                     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
                     67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                     68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig     69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
                     71: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     72: <dd><dl>
                     73: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     75: </dl></dd>
                     76: </dl></dd>
                     77: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     78: <dd><dl>
1.82      rillig     79: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     81: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     82: <dd><dl>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                     85: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                     86: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                     87: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                     88: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                     89: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig     90: </dl></dd>
                     91: </dl></dd>
                     92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     93: <dd><dl>
                     94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig     98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    104: </dl></dd>
                    105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    106: <dd><dl>
                    107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    110: </dl></dd>
                    111: </dl></dd>
                    112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    113: <dd><dl>
                    114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       118: <dd><dl>
1.103     wiz       119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.116     rillig    120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
                    121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88      wiz       122: </dl></dd>
1.103     wiz       123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    125: </dl></dd>
                    126: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    127: <dd><dl>
                    128: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    129: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    130: </dl></dd>
                    131: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    132: builds)</a></span></dt>
1.75      rillig    133: <dd><dl>
1.106     rillig    134: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    135: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    136: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    137: <dd><dl>
                    138: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    139: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    140: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    141: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    142: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    143: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    144: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    145: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    146: </dl></dd>
                    147: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig    148: <dd><dl>
                    149: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    150: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    151: </dl></dd>
1.106     rillig    152: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    153: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    154: </dl></dd>
                    155: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    156: <dd><dl>
1.116     rillig    157: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
                    158: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.106     rillig    159: </dl></dd>
                    160: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    161: <dd><dl>
                    162: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    165: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    166: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.116     rillig    169: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.106     rillig    170: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.116     rillig    171: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
                    172: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
                    173: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.106     rillig    174: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    175: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    176: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.116     rillig    177: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106     rillig    178: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.116     rillig    179: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.75      rillig    180: </dl></dd>
                    181: </dl></dd>
                    182: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    183: <dd><dl>
1.106     rillig    184: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    185: <dd><dl>
1.106     rillig    186: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig    187: <dd><dl>
1.106     rillig    188: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                    189: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil      190: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig    191: </dl></dd>
1.106     rillig    192: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    193: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    194: </dl></dd>
                    195: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    196: <dd><dl>
1.116     rillig    197: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
                    198: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106     rillig    199: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    200: <dd><dl>
                    201: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    202: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    203: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    204: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    205: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    206: </dl></dd>
                    207: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    208: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    209: <dd><dl>
                    210: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    211: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    212: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    213: </dl></dd>
1.116     rillig    214: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
                    215: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106     rillig    216: </dl></dd>
1.116     rillig    217: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106     rillig    218: <dd><dl>
                    219: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.116     rillig    220: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106     rillig    221: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    222: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    223: <dd><dl>
                    224: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    225: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    226: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    227: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    228: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    229: </dl></dd>
                    230: </dl></dd>
                    231: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    232: <dd><dl>
                    233: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.116     rillig    234: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
                    235: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106     rillig    236: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    237: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.116     rillig    238: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106     rillig    239: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                    240: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                    241: </dl></dd>
                    242: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    243: <dd><dl>
                    244: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.116     rillig    245: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106     rillig    246: <dd><dl>
                    247: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.116     rillig    248: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.106     rillig    249: </dl></dd>
1.116     rillig    250: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106     rillig    251: <dd><dl>
1.116     rillig    252: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106     rillig    253: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    254: </dl></dd>
                    255: </dl></dd>
                    256: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    257: <dd><dl>
                    258: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    259: <dd><dl>
                    260: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    261: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    262: </dl></dd>
                    263: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    264: <dd><dl>
1.116     rillig    265: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106     rillig    266: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    267: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    268: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    269: </dl></dd>
                    270: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    271: <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>
                    272: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    273: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    274: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    275: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    276: <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>
                    277: </dl></dd>
                    278: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    279: <dd><dl>
                    280: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.116     rillig    281: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106     rillig    282: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig    283: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    284: </dl></dd>
                    285: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    286: <dd><dl>
                    287: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    289: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    290: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.116     rillig    291: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106     rillig    292: <dd><dl>
                    293: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    294: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    295: </dl></dd>
1.116     rillig    296: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
                    297: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
                    298: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
                    299: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
                    300: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
                    301: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
                    302: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
                    303: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
                    304: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
                    305: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106     rillig    306: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    307: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    308: </dl></dd>
                    309: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    310: <dd><dl>
                    311: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    312: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    313: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    314: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    315: </dl></dd>
                    316: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    317: <dd><dl>
                    318: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    319: <dd><dl>
                    320: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.116     rillig    321: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106     rillig    322: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                    323: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                    324: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                    325: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                    326: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                    327: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                    328: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                    329: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                    330: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    331: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    332: </dl></dd>
1.116     rillig    333: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106     rillig    334: <dd><dl>
                    335: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    336: <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>
                    337: </dl></dd>
1.116     rillig    338: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106     rillig    339: <dd><dl>
                    340: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    341: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    342: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    343: </dl></dd>
                    344: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    345: <dd><dl>
                    346: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    347: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    348: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                    349: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                    350: </dl></dd>
1.116     rillig    351: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106     rillig    352: <dd><dl>
                    353: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    354: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.116     rillig    355: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106     rillig    356: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    357: </dl></dd>
1.116     rillig    358: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106     rillig    359: <dd><dl>
                    360: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    361: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    362: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    363: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    364: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    365: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    366: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    367: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig    368: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119   ! mishka    369: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig    370: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    371: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    372: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    373: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    374: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    375: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    376: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    377: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz       378:     emulation</a></span></dt>
1.106     rillig    379: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    380: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    381: </dl></dd>
1.106     rillig    382: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig    383: </dl></dd>
1.106     rillig    384: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    385: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig    386: <dd><dl>
1.106     rillig    387: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    388: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    389: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                    390: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                    391: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                    392: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
                    393: </dl></dd>
                    394: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    395: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    396: <dd><dl>
                    397: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    398: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    399: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    400: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv      401: </dl></dd>
1.75      rillig    402: </dl></dd>
                    403: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    404: <dd><dl>
1.106     rillig    405: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    406: <dd><dl>
1.106     rillig    407: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    408: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    409: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig    410: <dd><dl>
1.106     rillig    411: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    412: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig    413: </dl></dd>
1.106     rillig    414: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    415: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    416: <dd><dl>
1.106     rillig    417: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    418: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    419: </dl></dd>
1.106     rillig    420: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig    421: <dd><dl>
1.116     rillig    422: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
                    423: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75      rillig    424: </dl></dd>
                    425: </dl></dd>
1.106     rillig    426: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig    427: <dd><dl>
1.106     rillig    428: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    429: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    430: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig    431: <dd><dl>
1.106     rillig    432: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    433: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig    434: </dl></dd>
                    435: </dl></dd>
1.106     rillig    436: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig    437: <dd><dl>
1.106     rillig    438: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    439: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    440: </dl></dd>
                    441: </dl></dd>
                    442: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    443: <dd><dl>
                    444: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    445: <dd><dl>
                    446: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    447: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    448: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.116     rillig    449: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    450: </dl></dd>
                    451: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    452: </dl></dd>
                    453: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    454: <dd><dl>
                    455: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    456: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    457: </dl></dd>
1.76      rillig    458: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    459: <dd><dl>
1.116     rillig    460: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
                    461: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
                    462: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
                    463: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
                    464: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
                    465: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
                    466: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
                    467: pkgsrc-200xQy:
1.76      rillig    468: source packages</a></span></dt>
                    469: </dl></dd>
1.75      rillig    470: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    471: <dd><dl>
1.79      rillig    472: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    473: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    474: </dl></dd>
                    475: </dl>
                    476: </div>
1.82      rillig    477: <div class="list-of-tables">
                    478: <p><b>List of Tables</b></p>
                    479: <dl>
                    480: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    481: </dt>
1.106     rillig    482: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      483: </dt>
1.106     rillig    484: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      485: </dt>
1.82      rillig    486: </dl>
                    487: </div>
1.75      rillig    488: <div class="chapter" lang="en">
                    489: <div class="titlepage"><div><div><h2 class="title">
                    490: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    491: <div class="toc">
                    492: <p><b>Table of Contents</b></p>
                    493: <dl>
                    494: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    495: <dd><dl>
                    496: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    497: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    498: </dl></dd>
1.75      rillig    499: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    500: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       501: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig    502: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    503: </dl>
                    504: </div>
                    505: <div class="sect1" lang="en">
                    506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    507: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    508: <p>There is a lot of software freely available for Unix-based
                    509: systems, which is usually available in form of the source code. Before
                    510: such software can be used, it needs to be configured to the local
                    511: system, compiled and installed, and this is exactly what The NetBSD
                    512: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    513: to handle binary packages, so that not every user has to build the
                    514: packages for himself, which is a time-costly task.</p>
1.75      rillig    515: <p>pkgsrc currently contains several thousand packages,
                    516:       including:</p>
                    517: <div class="itemizedlist"><ul type="disc">
1.91      rillig    518: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
1.75      rillig    519:          web server</p></li>
1.91      rillig    520: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    521:          web browser</p></li>
1.91      rillig    522: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    523:          Desktop Environment</p></li>
1.91      rillig    524: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
1.75      rillig    525:          Desktop Environment</p></li>
                    526: </ul></div>
                    527: <p>...just to name a few.</p>
                    528: <p>pkgsrc has built-in support for handling varying dependencies,
                    529:       such as pthreads and X11, and extended features such as IPv6 support on
                    530:       a range of platforms.</p>
1.82      rillig    531: <div class="sect2" lang="en">
                    532: <div class="titlepage"><div><div><h3 class="title">
                    533: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    534: <p>
                    535: pkgsrc provides the following key features:
                    536: </p>
                    537: <div class="itemizedlist"><ul type="disc">
                    538: <li><p>Easy building of software from source as well as the creation
                    539:   and installation of binary packages. The source and latest
                    540:   patches are retrieved from a master or mirror download site, checksum
                    541:   verified, then built on your system. Support for binary-only
                    542:   distributions is available for both native platforms and NetBSD
                    543:   emulated platforms.</p></li>
                    544: <li><p>All packages are installed in a consistent directory tree,
                    545:   including binaries, libraries, man pages and other
                    546:   documentation.</p></li>
                    547: <li><p>Package dependencies, including when performing package updates,
                    548:   are handled automatically. The configuration files of various
                    549:   packages are handled automatically during updates, so local changes
                    550:   are preserved.</p></li>
                    551: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    552:   consists of highly portable code. This allows the greatest speed of
                    553:   development when porting to new a platform. This portability also
                    554:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    555:   platforms</em></span>.</p></li>
                    556: <li><p>The installation prefix, acceptable software licenses,
                    557:   international encryption requirements and build-time options for a
                    558:   large number of packages are all set in a simple, central
                    559:   configuration file.</p></li>
                    560: <li><p>The entire source (not including the distribution files) is
                    561:   freely available under a BSD license, so you may extend and adapt
                    562:   pkgsrc to your needs. Support for local packages and patches is
                    563:   available right out of the box, so you can configure it specifically
                    564:   for your environment.</p></li>
                    565: </ul></div>
1.91      rillig    566: <p>The following principles are basic to pkgsrc:</p>
                    567: <div class="itemizedlist"><ul type="disc">
                    568: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
1.114     jmcneill  569: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    570: them and to complain about them rather than to just install the package
                    571: and hope that it works. There are numerous checks in pkgsrc that try to
                    572: 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
                    573: of shell scripts), and post-installation checks (installed files,
                    574: references to shared libraries, script interpreters).</p></li>
                    575: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
1.114     jmcneill  576: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    577: pkgsrc has been ported to many operating systems. Care is taken that
                    578: packages behave the same on all platforms.</p></li>
                    579: </ul></div>
1.82      rillig    580: </div>
                    581: <div class="sect2" lang="en">
                    582: <div class="titlepage"><div><div><h3 class="title">
                    583: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    584: <p>pkgsrc consists of both a source distribution and a binary
                    585: distribution for these operating systems. After retrieving the required
                    586: source or binaries, you can be up and running with pkgsrc in just
                    587: minutes!</p>
1.75      rillig    588: <p>pkgsrc was derived from FreeBSD's ports system, and
                    589:       initially developed for NetBSD only. Since then, pkgsrc has
                    590:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    591: <div class="table">
                    592: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    593: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    594: <colgroup>
                    595: <col>
                    596: <col>
                    597: </colgroup>
                    598: <thead><tr>
                    599: <th>Platform</th>
                    600: <th>Date Support Added</th>
                    601: </tr></thead>
                    602: <tbody>
                    603: <tr>
1.110     hubertf   604: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    605: <td align="center">Aug 1997</td>
                    606: </tr>
                    607: <tr>
1.110     hubertf   608: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    609: <td align="center">Mar 1999</td>
                    610: </tr>
                    611: <tr>
1.110     hubertf   612: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    613: <td align="center">Jun 1999</td>
                    614: </tr>
                    615: <tr>
                    616: <td>
1.110     hubertf   617:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    618:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82      rillig    619:         </td>
                    620: <td align="center">Oct 2001</td>
                    621: </tr>
                    622: <tr>
1.110     hubertf   623: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    624: <td align="center">Nov 2002</td>
                    625: </tr>
                    626: <tr>
1.110     hubertf   627: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    628: <td align="center">Nov 2002</td>
                    629: </tr>
                    630: <tr>
1.110     hubertf   631: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    632: <td align="center">Dec 2002</td>
                    633: </tr>
                    634: <tr>
                    635: <td>BSD/OS</td>
                    636: <td align="center">Dec 2003</td>
                    637: </tr>
                    638: <tr>
1.110     hubertf   639: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    640: <td align="center">Dec 2003</td>
                    641: </tr>
                    642: <tr>
                    643: <td>
1.110     hubertf   644:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    645:           (Microsoft Windows Services for Unix)
                    646:         </td>
                    647: <td align="center">Mar 2004</td>
                    648: </tr>
                    649: <tr>
1.110     hubertf   650: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    651: <td align="center">Oct 2004</td>
                    652: </tr>
                    653: <tr>
1.110     hubertf   654: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    655: <td align="center">Nov 2004</td>
                    656: </tr>
1.98      wiz       657: <tr>
1.110     hubertf   658: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       659: <td align="center">Apr 2007</td>
                    660: </tr>
1.82      rillig    661: </tbody>
1.91      rillig    662: </table></div>
1.82      rillig    663: </div>
1.91      rillig    664: <br class="table-break">
1.82      rillig    665: </div>
1.75      rillig    666: </div>
                    667: <div class="sect1" lang="en">
                    668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    669: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    670: <p>This document is divided into three parts. The first,
1.110     hubertf   671:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    672:        describes how one can use one of the packages in the Package
                    673:        Collection, either by installing a precompiled binary package,
1.93      rillig    674:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   675:        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.75      rillig    676:        package so it can be easily built by other NetBSD users without
                    677:        knowing about the package's building details. The third part,
1.110     hubertf   678:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    679:        is intended for those who want to understand how pkgsrc is
                    680:        implemented.</p>
                    681: <p>This document is available in various formats:
1.110     hubertf   682:        <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.75      rillig    683: </div>
                    684: <div class="sect1" lang="en">
                    685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    686: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    687: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    688:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    689:       terminology used within this document.</p>
                    690: <div class="variablelist"><dl>
                    691: <dt><span class="term">Package</span></dt>
                    692: <dd><p>A set of files and building instructions
                    693:            that describe what's necessary
                    694:            to build a certain piece of software using
                    695:             pkgsrc. Packages are traditionally stored under
1.76      rillig    696:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    697: <dt><span class="term">The NetBSD package system</span></dt>
1.87      wiz       698: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    699:          is part of the NetBSD operating system and can be bootstrapped
                    700:          to run on non-NetBSD operating systems as well.  It handles
                    701:          building (compiling), installing, and removing of
                    702:          packages.</p></dd>
1.75      rillig    703: <dt><span class="term">Distfile</span></dt>
                    704: <dd><p>This term describes the file or files that are
                    705:            provided by the author of the piece of software to
                    706:            distribute his work. All the changes necessary to build on
                    707:            NetBSD are reflected in the corresponding package. Usually
                    708:            the distfile is in the form of a compressed tar-archive,
                    709:            but other types are possible, too. Distfiles are usually
                    710:            stored below
1.76      rillig    711:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    712: <dt><span class="term">Port</span></dt>
                    713: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    714:            for what we call a package.
                    715:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    716:            architecture.</p></dd>
                    717: <dt><span class="term">Precompiled/binary package</span></dt>
                    718: <dd>
                    719: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    720:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    721:            file so it can be installed on machines of the same
                    722:            machine architecture without the need to
                    723:            recompile. Packages are usually generated in
1.76      rillig    724:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.110     hubertf   725:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.75      rillig    726: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    727:            especially in the context of precompiled packages.</p>
                    728: </dd>
                    729: <dt><span class="term">Program</span></dt>
1.88      wiz       730: <dd><p>The piece of software to be installed which will be
                    731:          constructed from all the files in the distfile by the
                    732:          actions defined in the corresponding package.</p></dd>
1.75      rillig    733: </dl></div>
                    734: <div class="sect2" lang="en">
                    735: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       736: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75      rillig    737: <div class="variablelist"><dl>
                    738: <dt><span class="term">pkgsrc users</span></dt>
                    739: <dd>
                    740: <p>The
                    741:        pkgsrc users are people who use the packages provided by pkgsrc.
                    742:        Typically they are system administrators. The people using the
                    743:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    744:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    745: <p>There are two kinds of pkgsrc users: Some only want to
                    746:        install pre-built binary packages. Others build the pkgsrc
                    747:        packages from source, either for installing them directly or for
1.110     hubertf   748:        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.75      rillig    749:        documentation.</p>
                    750: </dd>
                    751: <dt><span class="term">package maintainers</span></dt>
                    752: <dd><p>A
1.110     hubertf   753:        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.75      rillig    754: <dt><span class="term">infrastructure developers</span></dt>
                    755: <dd><p>These people are involved in all those files
1.76      rillig    756:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   757:        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.75      rillig    758:        too.</p></dd>
                    759: </dl></div>
                    760: </div>
                    761: </div>
                    762: <div class="sect1" lang="en">
                    763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    764: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    765: <p>When giving examples for commands, shell prompts are used to
                    766:       show if the command should/can be issued as root, or if
                    767:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    768:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    769:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    770: </div>
                    771: </div>
                    772: <div class="part" lang="en">
                    773: <div class="titlepage"><div><div><h1 class="title">
                    774: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    775: <div class="toc">
                    776: <p><b>Table of Contents</b></p>
                    777: <dl>
                    778: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    779: <dd><dl>
                    780: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    781: <dd><dl>
                    782: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    783: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    784: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    785: </dl></dd>
                    786: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    787: <dd><dl>
                    788: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    789: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    790: </dl></dd>
                    791: </dl></dd>
                    792: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    793: <dd><dl>
1.82      rillig    794: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    795: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    796: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    797: <dd><dl>
                    798: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    799: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    800: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    801: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    802: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    803: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    804: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig    805: </dl></dd>
                    806: </dl></dd>
                    807: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    808: <dd><dl>
                    809: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    810: <dd><dl>
                    811: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    812: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    813: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    814: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    815: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    816: <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>
                    817: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    818: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    819: </dl></dd>
                    820: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    821: <dd><dl>
                    822: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    823: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    824: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    825: </dl></dd>
                    826: </dl></dd>
                    827: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    828: <dd><dl>
                    829: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    830: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    831: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       832: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       833: <dd><dl>
1.103     wiz       834: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.116     rillig    835: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
                    836: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88      wiz       837: </dl></dd>
1.103     wiz       838: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    839: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    840: </dl></dd>
                    841: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    842: <dd><dl>
                    843: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    844: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    845: </dl></dd>
                    846: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    847: builds)</a></span></dt>
1.75      rillig    848: <dd><dl>
1.106     rillig    849: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    850: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    851: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    852: <dd><dl>
                    853: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    854: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    855: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    856: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    857: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    858: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    859: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    860: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    861: </dl></dd>
                    862: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig    863: <dd><dl>
                    864: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    865: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    866: </dl></dd>
1.106     rillig    867: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    868: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    869: </dl></dd>
                    870: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    871: <dd><dl>
1.116     rillig    872: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
                    873: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.106     rillig    874: </dl></dd>
                    875: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    876: <dd><dl>
                    877: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    878: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    879: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    880: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    881: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    882: <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>
                    883: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.116     rillig    884: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.106     rillig    885: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.116     rillig    886: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
                    887: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
                    888: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.106     rillig    889: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    890: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    891: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.116     rillig    892: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106     rillig    893: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.116     rillig    894: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.75      rillig    895: </dl></dd>
                    896: </dl>
                    897: </div>
                    898: <div class="chapter" lang="en">
                    899: <div class="titlepage"><div><div><h2 class="title">
                    900: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    901: <div class="toc">
                    902: <p><b>Table of Contents</b></p>
                    903: <dl>
                    904: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    905: <dd><dl>
                    906: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    907: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    908: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    909: </dl></dd>
                    910: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    911: <dd><dl>
                    912: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    913: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    914: </dl></dd>
                    915: </dl>
                    916: </div>
1.91      rillig    917: <p>Before you download and extract the files, you need to decide
                    918: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    919: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    920: free to install the sources and binary packages wherever you want in
                    921: your filesystem, provided that the pathname does not contain white-space
                    922: or other characters that are interpreted specially by the shell and some
                    923: other programs. A safe bet is to use only letters, digits, underscores
                    924: and dashes.</p>
1.75      rillig    925: <div class="sect1" lang="en">
                    926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    927: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    928: <p>Before you download any pkgsrc files, you should decide
                    929:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    930:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    931:        quarterly basis from the current branch and only gets modified
                    932:        for security updates. The names of the stable branches are built
                    933:        from the year and the quarter, for example
1.112     weinem    934:        <code class="literal">2007Q4</code>.</p>
1.75      rillig    935: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    936:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    937:        or via CVS. All three ways are described here.</p>
                    938: <div class="sect2" lang="en">
                    939: <div class="titlepage"><div><div><h3 class="title">
                    940: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    941: <p>The primary download location for all pkgsrc files is
1.110     hubertf   942:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.75      rillig    943:        number of subdirectories for different purposes, which are
1.110     hubertf   944:        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.75      rillig    945: <p>The tar file for the current branch is in the directory
1.110     hubertf   946:        <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.75      rillig    947:        It is autogenerated daily.</p>
1.112     weinem    948: <p>The tar file for the stable branch 2007Q4 is in the
                    949:        directory <code class="filename">pkgsrc-2007Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q4/pkgsrc-2007Q4.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q4.tar.gz</code></a>.</p>
                    950: <p>To download a pkgsrc stable tarball, run:</p>
                    951: <pre class="screen">
                    952: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-200xQy</code></em>/<em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz</code></strong></pre>
                    953: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the
                    954:        stable branch to be downloaded, for example, 
                    955:        &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;.</p>
                    956: <p>Then, extract it with:</p>
                    957: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz -C /usr</code></strong></pre>
                    958: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    959:        in <code class="filename">/usr/</code> and all the package source will be 
                    960:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    961: <p>To download pkgsrc-current, run:</p>
                    962: <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.75      rillig    963: </div>
                    964: <div class="sect2" lang="en">
                    965: <div class="titlepage"><div><div><h3 class="title">
                    966: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    967: <p>As an alternative to the tar file, you can get pkgsrc via
                    968:        the Software Update Protocol, SUP. To do so, make sure your
                    969:        supfile has a line
1.1       grant     970: 
1.75      rillig    971: </p>
                    972: <pre class="programlisting">
1.100     rillig    973: release=pkgsrc
1.1       grant     974: </pre>
1.75      rillig    975: <p>
1.1       grant     976: 
1.75      rillig    977:        in it, see the examples in
1.76      rillig    978:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    979:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.113     weinem    980:        run:</p>
                    981: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>sup -v <em class="replaceable"><code>/path/to/your/supfile</code></em></code></strong>.</pre>
1.75      rillig    982: </div>
                    983: <div class="sect2" lang="en">
                    984: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig    985: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.112     weinem    986: <p>To do an initial (full) checkout of pkgsrc, you first
1.75      rillig    987:        have to set some environment variables. For the C-Shell,
                    988:        type:</p>
1.113     weinem    989: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    990: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
1.75      rillig    991: </pre>
                    992: <p>Or, the same for the bourne shell:</p>
1.113     weinem    993: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    994: <code class="prompt">$</code> <strong class="userinput"><code>export CVS_RSH="ssh"</code></strong>
1.75      rillig    995: </pre>
1.113     weinem    996: <p>By default, CVS doesn't do things like most people would
1.112     weinem    997:        expect it to do. But there is a
1.113     weinem    998:        way to convince CVS, by creating a file called
1.101     rillig    999:        <code class="filename">.cvsrc</code> in your home directory and saving
                   1000:        the following lines to it. This file will save you lots of
                   1001:        headache and some bug reports, so we strongly recommend it. You
                   1002:        can find an explanation of this file in the CVS
                   1003:        documentation.</p>
                   1004: <pre class="programlisting">
                   1005: # recommended CVS configuration file from the pkgsrc guide
                   1006: checkout -P
1.103     wiz      1007: update -dP
1.101     rillig   1008: release -d
1.103     wiz      1009: diff -upN
1.101     rillig   1010: cvs -q -z3
                   1011: rdiff -u
                   1012: </pre>
1.112     weinem   1013: <p>To fetch a specific pkgsrc stable branch from scratch, run:</p>
                   1014: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113     weinem   1015: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -r <em class="replaceable"><code>pkgsrc-200xQy</code></em> -P pkgsrc</code></strong></pre>
1.112     weinem   1016: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the stable 
                   1017:        branch to be checked out, for example, &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;</p>
                   1018: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1019:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1020:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1021: <p>To fetch the pkgsrc current branch, run:</p>
                   1022: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113     weinem   1023: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -P pkgsrc</code></strong></pre>
1.75      rillig   1024: </div>
                   1025: </div>
                   1026: <div class="sect1" lang="en">
                   1027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1028: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1029: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1030:        (which also works if you have first installed it via a tar
                   1031:        file). It saves bandwidth and hard disk activity, compared to
                   1032:        downloading the tar file again.</p>
                   1033: <div class="sect2" lang="en">
                   1034: <div class="titlepage"><div><div><h3 class="title">
                   1035: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                   1036: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1037: <h3 class="title">Warning</h3>
1.77      rillig   1038: <p>When updating from a tar file, you first need to
                   1039:        completely remove the old pkgsrc directory. Otherwise those
                   1040:        files that have been removed from pkgsrc in the mean time will
                   1041:        not be removed on your local disk, resulting in inconsistencies.
                   1042:        When removing the old files, any changes that you have done to
                   1043:        the pkgsrc files will be lost after updating. Therefore updating
                   1044:        via CVS is strongly recommended.</p>
1.75      rillig   1045: </div>
1.82      rillig   1046: <p>Note that by default the distfiles and the binary packages
                   1047:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1048:        before updating. You can also configure pkgsrc to use other than
                   1049:        the default directories by setting the
                   1050:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1051:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1052: <p>To update pkgsrc from a tar file, download the tar file as
                   1053:        explained above. Then, make sure that you have not made any
                   1054:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1055:        directory and extract the new tar file. Done.</p>
                   1056: </div>
                   1057: <div class="sect2" lang="en">
                   1058: <div class="titlepage"><div><div><h3 class="title">
                   1059: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1060: <p>To update pkgsrc via CVS, make sure the environment
                   1061:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.113     weinem   1062:        change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1063: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   1064: <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.75      rillig   1065: <div class="sect3" lang="en">
                   1066: <div class="titlepage"><div><div><h4 class="title">
                   1067: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1068: <p>When updating pkgsrc, the CVS program keeps track of the
                   1069:        branch you selected. But if you, for whatever reason, want to
                   1070:        switch from the stable branch to the current one, you can do it
                   1071:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1072:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1073:        back to the stable branch, add the
1.113     weinem   1074:        &#8220;<span class="quote">-rpkgsrc-2007Q4</span>&#8221; option.</p>
1.75      rillig   1075: </div>
                   1076: <div class="sect3" lang="en">
                   1077: <div class="titlepage"><div><div><h4 class="title">
                   1078: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1079: <p>When you update pkgsrc, the CVS program will only touch
                   1080:        those files that are registered in the CVS repository. That
                   1081:        means that any packages that you created on your own will stay
                   1082:        unmodified. If you change files that are managed by CVS, later
                   1083:        updates will try to merge your changes with those that have been
                   1084:        done by others. See the CVS manual, chapter
                   1085:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1086: </div>
                   1087: </div>
                   1088: </div>
                   1089: </div>
                   1090: <div class="chapter" lang="en">
                   1091: <div class="titlepage"><div><div><h2 class="title">
                   1092: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1093: <div class="toc">
                   1094: <p><b>Table of Contents</b></p>
                   1095: <dl>
1.82      rillig   1096: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1097: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1098: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1099: <dd><dl>
                   1100: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1101: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1102: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1103: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1104: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1105: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1106: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig   1107: </dl></dd>
                   1108: </dl>
                   1109: </div>
                   1110: <div class="sect1" lang="en">
                   1111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1112: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1113: <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.82      rillig   1114: </div>
                   1115: <div class="sect1" lang="en">
                   1116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1117: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1118: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1119: <pre class="screen">
                   1120: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1121: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1122: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1123:     </pre>
1.110     hubertf  1124: <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.87      wiz      1125:     pkgsrc before bootstrapping. The given
1.110     hubertf  1126:     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87      wiz      1127:     <code class="filename">/usr/pkg</code> for the
                   1128:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1129:     and <code class="filename">/var/db/pkg</code> for the package database
                   1130:     directory where pkgsrc will do its internal bookkeeping.
                   1131:     However, these can also be set using command-line
                   1132:     arguments.</p>
1.75      rillig   1133: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1134: <h3 class="title">Note</h3>
1.110     hubertf  1135: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1136:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1137:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.87      wiz      1138:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
1.75      rillig   1139: </div>
                   1140: </div>
                   1141: <div class="sect1" lang="en">
                   1142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1143: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1144: <p>Here are some platform-specific notes you should be aware of.</p>
                   1145: <div class="sect2" lang="en">
                   1146: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1147: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85      jmmv     1148: <p>Darwin 5.x and up are supported. There are two methods of using
1.110     hubertf  1149:        pkgsrc on Mac OS X, by using a <a class="link" href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
                   1150:          image</a>, or a <a class="link" href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.75      rillig   1151:          partition</a>.</p>
                   1152: <p>Before you start, you will need to download and install the Mac OS X Developer
1.110     hubertf  1153:       Tools from Apple's Developer Connection.  See <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.87      wiz      1154:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
1.110     hubertf  1155:       from <a class="ulink" href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1.87      wiz      1156:       if you intend to build packages that use the X11 Window System.</p>
1.89      rillig   1157: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1158:       that you can format as UFS or HFSX, it is recommended to use that instead of
1.87      wiz      1159:       the disk image. It'll be somewhat faster and will mount automatically
                   1160:       at boot time, where you must manually mount a disk image.</p>
1.75      rillig   1161: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1162: <h3 class="title">Note</h3>
1.85      jmmv     1163: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89      rillig   1164:          requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
1.75      rillig   1165: </div>
                   1166: <div class="sect3" lang="en">
                   1167: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1168: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75      rillig   1169: <p>Create the disk image:</p>
                   1170: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95      tron     1171: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85      jmmv     1172: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75      rillig   1173: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85      jmmv     1174: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1175: <h3 class="title">Note</h3>
1.109     rillig   1176: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid.  In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page.  In the case of HFSX, it will disable journaling.</p>
1.85      jmmv     1177: </div>
1.89      rillig   1178: <p>Allow suid:</p>
                   1179: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.105     weinem   1180: <p>Changing the build directory:</p>
                   1181: <p>After bootstrapping you need to change the default package build directory to somewhere outside the disk image so it doesn't get filled up in the process of building packages. Add something like that to <code class="filename">mk.conf</code>.</p>
                   1182: <pre class="programlisting">
                   1183:          WRKOBJDIR?=           /tmp/pkgsrc         # build here instead of in pkgsrc
                   1184:        </pre>
1.75      rillig   1185: </div>
                   1186: <div class="sect3" lang="en">
                   1187: <div class="titlepage"><div><div><h4 class="title">
1.89      rillig   1188: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76      rillig   1189: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87      wiz      1190:        system, normally HFS+. It is possible to use the default
                   1191:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1192:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89      rillig   1193:        or HFSX file system. Obviously, another symlink is required if you want to
1.87      wiz      1194:        place the package database directory outside the
                   1195:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75      rillig   1196: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1197: <p>If you created your partitions at the time of installing Mac OS X
1.89      rillig   1198:        and formatted the target partition as UFS or HFSX, it should automatically
1.87      wiz      1199:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
1.89      rillig   1200:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87      wiz      1201:        to ensure that the partition map correctly reflects
1.89      rillig   1202:        &#8220;<span class="quote">Apple_UFS</span>&#8221; or &#8220;<span class="quote">Apple_HFSX</span>&#8221; and not &#8220;<span class="quote">Apple_HFS</span>&#8221;.</p>
1.75      rillig   1203: <p>The problem is that none of the disk tools will let you touch a
1.87      wiz      1204:        disk that is booted from. You can unmount the partition, but even if
                   1205:        you newfs it, the partition type will be incorrect and the
                   1206:        automounter won't mount it. It can be mounted manually, but it won't
                   1207:        appear in Finder.</p>
1.75      rillig   1208: <p>You'll need to boot off of the OS X Installation (User) CD.  When
1.87      wiz      1209:        the Installation program starts, go up to the menu and select Disk
                   1210:        Utility.  Now, you will be able to select the partition you want
1.89      rillig   1211:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1212:        installer which will reboot your machine. The new UFS or HFSX file system
1.87      wiz      1213:        will appear in Finder.</p>
1.75      rillig   1214: <p>Be aware that the permissions on the new file system will be writable
1.87      wiz      1215:        by root only.</p>
1.75      rillig   1216: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87      wiz      1217:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75      rillig   1218: </div>
                   1219: </div>
                   1220: <div class="sect2" lang="en">
                   1221: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1222: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87      wiz      1223: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1224:       other versions may work.</p>
1.75      rillig   1225: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1226:       with the FreeBSD userland tools. There are several steps:</p>
1.75      rillig   1227: <div class="orderedlist"><ol type="1">
                   1228: <li><p>FreeBSD stores its ports pkg database in
1.87      wiz      1229:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1230:          recommended that you choose a different location (e.g.
                   1231:          <code class="filename">/usr/pkgdb</code>) by
                   1232:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1233: <li>
                   1234: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1235:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1236: <pre class="screen">
                   1237: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1238: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1239: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1240: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1241: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1242:          </pre>
1.75      rillig   1243: </li>
1.110     hubertf  1244: <li><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1245:          <code class="filename">/etc/mk.conf.example</code> file
                   1246:          when you use the bootstrap script.</p></li>
1.75      rillig   1247: </ol></div>
                   1248: </div>
                   1249: <div class="sect2" lang="en">
                   1250: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1251: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75      rillig   1252: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1253:       providing a Unix-like environment with a tighter kernel integration than
                   1254:       available with Cygwin.  It is part of the Windows Services for Unix
                   1255:       package, available for free for any licensed copy of Windows 2000, XP
1.110     hubertf  1256:       (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.93      rillig   1257: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1258:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1259:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1260: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1261:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
1.95      tron     1262:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75      rillig   1263: <div class="sect3" lang="en">
                   1264: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1265: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1266: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1267:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75      rillig   1268: <div class="itemizedlist"><ul type="disc">
                   1269: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1270: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1271: <li><p>Remote Connectivity</p></li>
                   1272: <li><p>Interix SDK</p></li>
                   1273: </ul></div>
                   1274: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1275:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1276:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1277:        pkgsrc (or from a binary package).</p>
1.75      rillig   1278: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1279:        not need to be installed, but Remote Connectivity itself should be
                   1280:        installed in order to have a working inetd.</p>
1.75      rillig   1281: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1282:        behavior for Interix programs, and whether to make pathnames default to
                   1283:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1284:        enabled.  (Without case-sensitivity, a large number of packages including
                   1285:        perl will not build.)</p>
1.75      rillig   1286: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1287:        works (via the Data Execution Prevention feature).  In order to use
                   1288:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1289:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1290:        must be installed.  Hotfixes are available from Microsoft through a
1.114     jmcneill 1291:        support contract; however, Debian Interix Port has made most Interix
                   1292:        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.93      rillig   1293: <p>In addition to the hotfix noted above, it may be necessary to
                   1294:        disable Data Execution Prevention entirely to make Interix functional.
                   1295:        This may happen only with certain types of CPUs; the cause is not fully
                   1296:        understood at this time.  If gcc or other applications still segfault
                   1297:        repeatedly after installing one of the hotfixes note above, the
                   1298:        following option can be added to the appropriate "boot.ini" line on the
                   1299:        Windows boot drive:  /NoExecute=AlwaysOff
                   1300:        (WARNING, this will disable DEP completely, which may be a security
                   1301:        risk if applications are often run as a user in the Administrators
                   1302:        group!)</p>
1.75      rillig   1303: </div>
                   1304: <div class="sect3" lang="en">
                   1305: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1306: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75      rillig   1307: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1308:        with pkgsrc, note the following things.</p>
1.75      rillig   1309: <div class="itemizedlist"><ul type="disc">
                   1310: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1311:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1312:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.75      rillig   1313: <li>
                   1314: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1315:            change the following registry key:</p>
1.75      rillig   1316: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1317: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1318: </li>
                   1319: <li>
                   1320: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1321:            following registry key:</p>
1.75      rillig   1322: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1323: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1324: </li>
                   1325: </ul></div>
                   1326: </div>
                   1327: <div class="sect3" lang="en">
                   1328: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1329: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1330: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1331:        running "pkg_add") must be a member of the local Administrators
                   1332:        group.  Such a user must also be used to run the bootstrap.  This is
                   1333:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1334: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1335:        automatically complain if this is not the case.  This ensures that
                   1336:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1337: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1338:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1339:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1340:        the same time as the pkgsrc packages, ensure that you use the proper
                   1341:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1342: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1343:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1344:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1345:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1346: <pre class="programlisting">
1.100     rillig   1347: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1348:        </pre>
1.75      rillig   1349: </div>
                   1350: <div class="sect3" lang="en">
                   1351: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1352: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1353: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1354:        for a full Unix-like platform, it has some drawbacks that should
                   1355:        be noted for those desiring to make the most of Interix.</p>
1.75      rillig   1356: <div class="itemizedlist"><ul type="disc">
                   1357: <li>
                   1358: <p><span class="strong"><strong>X11:</strong></span></p>
                   1359: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1360:          and can run X11 based applications, but it does
                   1361:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.110     hubertf  1362:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1363:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87      wiz      1364:          (available in a trimmed version for Interix from Interop Systems as the
1.110     hubertf  1365:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87      wiz      1366:          and the free X11 server included with
1.110     hubertf  1367:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1368: </li>
                   1369: <li>
                   1370: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1371: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1372:          Win32 applications, it does not currently support various X11
                   1373:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1374:          Most interactive applications to a local X server will run
                   1375:          reasonably fast, but full motion video and other graphics
                   1376:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1377: </li>
                   1378: <li>
                   1379: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1380: <p>Interix has no native support for audio output.  For audio
1.110     hubertf  1381:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87      wiz      1382:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1383:          <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.110     hubertf  1384:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87      wiz      1385:          server component.  To output audio via an Interix host, the
1.91      rillig   1386:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.87      wiz      1387:          must also be installed.</p>
1.75      rillig   1388: </li>
                   1389: <li>
                   1390: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1391: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1392:          is not currently possible to access CD/DVD drives, USB devices,
                   1393:          or SCSI devices through non-filesystem means.  Among other things,
                   1394:          this makes it impossible to use Interix directly for CD/DVD
                   1395:          burning.</p>
1.75      rillig   1396: </li>
                   1397: <li>
                   1398: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1399: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1400:          drives are also not directly accessible in Interix.  However,
                   1401:          support is in work to make tape drive access possible by using
                   1402:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1403:          esound server).</p>
1.75      rillig   1404: </li>
                   1405: </ul></div>
                   1406: </div>
                   1407: <div class="sect3" lang="en">
                   1408: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1409: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1410: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1411:        Windows system; any member of the local Administrators group will
                   1412:        suffice.  However, some packages currently assume that the user
                   1413:        named "root" is the privileged user.  To accommodate these, you
                   1414:        may create such a user; make sure it is in the local group
                   1415:        Administrators (or your language equivalent).</p>
1.110     hubertf  1416: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87      wiz      1417:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1418:        time being, install packages as the local Administrator (or
                   1419:        your language equivalent), or run the following command after
                   1420:        installing a package to work around the issue:</p>
1.75      rillig   1421: <pre class="screen">
1.87      wiz      1422: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1423:        </pre>
1.75      rillig   1424: </div>
                   1425: </div>
                   1426: <div class="sect2" lang="en">
                   1427: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1428: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75      rillig   1429: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1430:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1431:       according to your preference.  If you do not have a license for the MIPSpro
1.110     hubertf  1432:       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.75      rillig   1433: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110     hubertf  1434:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87      wiz      1435:       etc.</p>
1.86      schwarz  1436: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1437:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1438:        you start out using "abi=n32", that's what all your packages will be built
                   1439:        with.</p>
                   1440: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1441:       <code class="varname">CFLAGS</code> in your environment or the
1.110     hubertf  1442:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.87      wiz      1443:       try to link n32 object files with lib64 or vice versa.  Check your
                   1444:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1445: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1446:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1447:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1448:       link over a network-mounted file system.</p>
1.75      rillig   1449: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1450:       as imake(1), but you may want to set some options depending on your local
                   1451:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1452:       course, your compiler's man pages for details.</p>
1.75      rillig   1453: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1454: 
1.87      wiz      1455:       </p>
1.75      rillig   1456: <pre class="programlisting">
1.100     rillig   1457: PKGSRC_COMPILER=        mipspro
1.87      wiz      1458:       </pre>
1.75      rillig   1459: <p>
1.1       grant    1460: 
1.110     hubertf  1461:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.87      wiz      1462:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1463:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1464:       default.</p>
1.75      rillig   1465: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1466:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1467:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1468:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1469:       '--preserve-path' flag.</p>
1.75      rillig   1470: </div>
                   1471: <div class="sect2" lang="en">
                   1472: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1473: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87      wiz      1474: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1475:       either libtermcap or libcurses (libncurses).  Installing the
                   1476:       distributions libncurses-dev package (or equivalent) should fix
                   1477:       the problem.</p>
                   1478: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1479:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1480:       i386 have been tested.</p>
1.75      rillig   1481: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1482:       directory:</p>
1.75      rillig   1483: <pre class="programlisting">
1.100     rillig   1484: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1485: ac_cv___attribute__=yes ./bootstrap
1.87      wiz      1486:       </pre>
1.75      rillig   1487: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1488: <h3 class="title">Note</h3>
                   1489: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1490: </div>
                   1491: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87      wiz      1492:       function, which icc does not support. #undef'ing __attribute__ has the
                   1493:       unfortunate side-effect of breaking many of the Linux header files, which
                   1494:       cannot be compiled properly without __attribute__. The test must be
                   1495:       overridden so that __attribute__ is assumed supported by the
                   1496:       compiler.</p>
1.75      rillig   1497: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110     hubertf  1498:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1499: <pre class="programlisting">
1.100     rillig   1500: PKGSRC_COMPILER=        icc
1.87      wiz      1501:       </pre>
1.75      rillig   1502: <p>The default installation directory for icc is
1.87      wiz      1503:       <code class="filename">/opt/intel_cc_80</code>, which
                   1504:       is also the pkgsrc default. If you have installed it into a different
                   1505:       directory, set <code class="varname">ICCBASE</code> in
1.110     hubertf  1506:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1507: <pre class="programlisting">
1.100     rillig   1508: ICCBASE=                /opt/icc
1.87      wiz      1509:       </pre>
1.75      rillig   1510: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1511:       provided by icc, so binaries can be run on other systems which do not
                   1512:       have the shared libraries installed.</p>
                   1513: <p>Libtool, however, extracts a list of libraries from the
1.110     hubertf  1514:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.87      wiz      1515:       records it, throwing away the -Bstatic and -Bdynamic options
                   1516:       interspersed between the libraries.  This means that
                   1517:       libtool-linked C++ shared libraries will have a runtime
                   1518:       dependency on the icc libraries until this is fixed in
                   1519:       libtool.</p>
1.75      rillig   1520: </div>
                   1521: <div class="sect2" lang="en">
                   1522: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1523: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75      rillig   1524: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1525: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1526:       with the OpenBSD userland tools. There are several steps:</p>
1.75      rillig   1527: <div class="orderedlist"><ol type="1">
                   1528: <li><p>OpenBSD stores its ports pkg database in
1.87      wiz      1529:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1530:          recommended that you choose a different location (e.g.
                   1531:          <code class="filename">/usr/pkgdb</code>) by
                   1532:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1533: <li>
                   1534: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1535:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1536: <pre class="screen">
                   1537: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1538: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1539: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1540: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1541: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1542:          </pre>
1.75      rillig   1543: </li>
                   1544: <li>
1.110     hubertf  1545: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1546:          <code class="filename">/etc/mk.conf.example</code> file
                   1547:          when you use the bootstrap script. OpenBSD's make program uses
1.110     hubertf  1548:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87      wiz      1549:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1550:          of the file with:</p>
                   1551: <pre class="programlisting">
1.100     rillig   1552: .ifdef BSD_PKG_MK
                   1553: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1554: .else
                   1555: # OpenBSD stuff
                   1556: .endif
1.87      wiz      1557:          </pre>
1.75      rillig   1558: </li>
                   1559: </ol></div>
                   1560: </div>
                   1561: <div class="sect2" lang="en">
                   1562: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1563: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75      rillig   1564: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87      wiz      1565:       You will need a working C compiler. Both gcc 2.95.3 and
                   1566:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1567: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1568:       process and to build packages.</p>
1.75      rillig   1569: <div class="itemizedlist"><ul type="disc">
                   1570: <li><p>SUNWsprot</p></li>
                   1571: <li><p>SUNWarc</p></li>
                   1572: <li><p>SUNWbtool</p></li>
                   1573: <li><p>SUNWtoo</p></li>
                   1574: <li><p>SUNWlibm</p></li>
                   1575: </ul></div>
1.78      rillig   1576: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1577:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1578: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1579:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1580:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1581:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75      rillig   1582: <div class="sect3" lang="en">
                   1583: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1584: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1585: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1586:        for building all packages.</p>
1.75      rillig   1587: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1588:        then either build gcc from
1.91      rillig   1589:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
1.87      wiz      1590:        package, then remove gcc used during bootstrapping.</p>
1.110     hubertf  1591: <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.75      rillig   1592: </div>
                   1593: <div class="sect3" lang="en">
                   1594: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1595: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1596: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1597:        5.0)</p>
1.75      rillig   1598: <div class="itemizedlist"><ul type="disc">
                   1599: <li><p>SPROcc
1.87      wiz      1600:          - Sun WorkShop Compiler C 5.0</p></li>
1.75      rillig   1601: <li><p>SPROcpl
1.87      wiz      1602:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.75      rillig   1603: <li><p>SPROild
1.87      wiz      1604:          - Sun WorkShop Incremental Linker</p></li>
1.75      rillig   1605: <li><p>SPROlang
1.87      wiz      1606:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1607: </ul></div>
1.96      rillig   1608: <p>You should set the following variables in your
1.110     hubertf  1609:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96      rillig   1610: <pre class="programlisting">
1.100     rillig   1611: CC=     cc
                   1612: CXX=    CC
                   1613: CPP=    cc -E
                   1614: CXXCPP= CC -E
1.96      rillig   1615: </pre>
                   1616: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1617: <h3 class="title">Note</h3>
                   1618: <p>The <code class="varname">CPP</code> setting might break some
                   1619:        packages that use the C preprocessor for processing things other
                   1620:        than C source code.</p>
                   1621: </div>
1.75      rillig   1622: </div>
                   1623: <div class="sect3" lang="en">
                   1624: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   1625: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1626: <p>To build 64-bit packages, you just need to have the
1.110     hubertf  1627:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75      rillig   1628: <pre class="programlisting">
1.100     rillig   1629: PKGSRC_COMPILER=        sunpro
                   1630: ABI=                    64
1.96      rillig   1631: </pre>
                   1632: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1633: <h3 class="title">Note</h3>
                   1634: <p>This setting has been tested for the SPARC
                   1635:        architecture. Intel and AMD machines need some more
                   1636:        work.</p>
                   1637: </div>
1.75      rillig   1638: </div>
                   1639: <div class="sect3" lang="en">
                   1640: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1641: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110     hubertf  1642: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87      wiz      1643:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1644:       The workaround is to use another shell for the configure
1.91      rillig   1645:       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.110     hubertf  1646:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87      wiz      1647: <pre class="programlisting">
1.100     rillig   1648: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1649: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1650:       </pre>
1.91      rillig   1651: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1.75      rillig   1652: </div>
                   1653: </div>
                   1654: </div>
                   1655: </div>
                   1656: <div class="chapter" lang="en">
                   1657: <div class="titlepage"><div><div><h2 class="title">
                   1658: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1659: <div class="toc">
                   1660: <p><b>Table of Contents</b></p>
                   1661: <dl>
                   1662: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1663: <dd><dl>
                   1664: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1665: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1666: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1667: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1668: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1669: <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>
                   1670: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1671: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1672: </dl></dd>
                   1673: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1674: <dd><dl>
                   1675: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1676: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1677: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1678: </dl></dd>
                   1679: </dl>
                   1680: </div>
                   1681: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1682: is to only install the package tools and to use binary packages
                   1683: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1684: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1685: of pkgsrc, too. Then you are able to build your own packages,
                   1686: and you can still use binary packages from someone else.</p>
1.75      rillig   1687: <div class="sect1" lang="en">
                   1688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1689: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1690: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1691:   server and its mirrors, there are collections of binary packages,
                   1692:   ready to be installed. These binary packages have been built using the
                   1693:   default settings for the directories, that is:</p>
                   1694: <div class="itemizedlist"><ul type="disc">
                   1695: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1696: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1697: <li><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
                   1698: </ul></div>
                   1699: <p>If you cannot use these directories for whatever reasons (maybe
                   1700:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1701:   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.75      rillig   1702: <div class="sect2" lang="en">
                   1703: <div class="titlepage"><div><div><h3 class="title">
                   1704: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1705: <p>To install binary packages, you first need to know from where
                   1706:     to get them. The first place where you should look is on the main
1.110     hubertf  1707:     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.105     weinem   1708: <p>This directory contains binary packages for multiple
                   1709:     platforms. First, select your operating system. (Ignore the
                   1710:     directories with version numbers attached to it, they just exist for
                   1711:     legacy reasons.) Then, select your hardware architecture, and in the
1.109     rillig   1712:     third step, the OS version and the &#8220;<span class="quote">version</span>&#8221; of pkgsrc.</p>
                   1713: <p>In this directory, you often find a file called
                   1714:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1715:     management tools. If the file is missing, it is likely that your
                   1716:     operating system already provides those tools. Download the file and
                   1717:     extract it in the <code class="filename">/</code> directory. It will create
                   1718:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1719:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1720:     (the database of installed packages).</p>
1.75      rillig   1721: </div>
                   1722: <div class="sect2" lang="en">
                   1723: <div class="titlepage"><div><div><h3 class="title">
                   1724: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1725: <p>In the directory from the last section, there is a
                   1726:     subdirectory called <code class="filename">All</code>, which contains all the
                   1727:     binary packages that are available for the platform, excluding those
                   1728:     that may not be distributed via FTP or CDROM (depending on which
                   1729:     medium you are using), and the ones that have vulnerabilities and
                   1730:     therefore are considered insecure to install without thinking
                   1731:     before.</p>
                   1732: <p>To install packages directly from an FTP or HTTP server, run
                   1733:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1734:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1735: <pre class="screen">
                   1736: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1737: <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>
                   1738: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1739: </pre>
                   1740: <p>Instead of URLs, you can also use local paths, for example if
                   1741:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1742:     repository. If you want to install packages from multiple sources,
                   1743:     you can separate them by a semicolon in
                   1744:     <code class="varname">PKG_PATH</code>.</p>
                   1745: <p>After these preparations, installing a package is very
                   1746:     easy:</p>
                   1747: <pre class="screen">
                   1748: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1749: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1750: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1751: </pre>
1.75      rillig   1752: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1753:     package in question will be installed, too, assuming they are
                   1754:     present where you install from.</p>
1.109     rillig   1755: <p>As mentioned above, packages for which vulnerabilities get
                   1756:     known are not stored in the <code class="filename">All</code> subdirectory.
                   1757:     They don't get deleted since that could be very frustrating if many
                   1758:     other packages depend on it. Instead, they are moved to the
                   1759:     <code class="filename">vulnerable</code> subdirectory. So you may need to add
                   1760:     this directory to the <code class="varname">PKG_PATH</code> variable. 
1.114     jmcneill 1761:     However, you should run <span class="command"><strong>audit-packages</strong></span>
                   1762:     regularly, especially after installing new packages, and verify
                   1763:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1764: <p>After you've installed packages, be sure to have
1.88      wiz      1765:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1766:     <code class="varname">PATH</code> so you can actually start the just
                   1767:     installed program.</p>
1.75      rillig   1768: </div>
                   1769: <div class="sect2" lang="en">
                   1770: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1771: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1772: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1773:     installed from source code or from a binary package. The
1.110     hubertf  1774:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1775:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1776:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1777:     name can be given with or without version number. Wildcards can
                   1778:     also be used to deinstall a set of packages, for example
                   1779:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1780:     so that the shell does not expand them before
                   1781:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1782: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1783:     removes all the packages that require the package in question
                   1784:     and then removes the package itself. For example:
1.82      rillig   1785: 
1.88      wiz      1786:     </p>
1.82      rillig   1787: <pre class="screen">
1.88      wiz      1788: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1789:     </pre>
1.82      rillig   1790: <p>
                   1791: 
1.88      wiz      1792:     will remove jpeg and all the packages that used it; this allows
                   1793:     upgrading the jpeg package.</p>
1.82      rillig   1794: </div>
                   1795: <div class="sect2" lang="en">
                   1796: <div class="titlepage"><div><div><h3 class="title">
                   1797: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1798: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1799:     installed packages or binary package files.</p>
1.82      rillig   1800: </div>
                   1801: <div class="sect2" lang="en">
                   1802: <div class="titlepage"><div><div><h3 class="title">
                   1803: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1804: <p>
1.88      wiz      1805:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1806:       known security vulnerabilities to packages which are (or have been)
                   1807:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1808:       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.88      wiz      1809:     </p>
1.82      rillig   1810: <p>
1.93      rillig   1811:       Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
1.88      wiz      1812:       this list can be downloaded
                   1813:       automatically, and a security audit of all packages installed on a system
                   1814:       can take place.
                   1815:     </p>
1.82      rillig   1816: <p>
1.93      rillig   1817:       There are two components to
1.91      rillig   1818:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.  The first
1.88      wiz      1819:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   1820:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   1821:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   1822:       installed packages are vulnerable.  If a package is vulnerable, you
                   1823:       will see output similar to the following:
                   1824:     </p>
1.82      rillig   1825: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1826:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1827: <p>
1.91      rillig   1828:       One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.110     hubertf  1829:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.88      wiz      1830:       file daily, and include a package audit in the daily security script.
1.110     hubertf  1831:       Details on this are located in the <a class="ulink" href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.91      rillig   1832:       file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
1.88      wiz      1833:     </p>
1.82      rillig   1834: </div>
                   1835: <div class="sect2" lang="en">
                   1836: <div class="titlepage"><div><div><h3 class="title">
                   1837: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1838: <p>
1.112     weinem   1839:       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.110     hubertf  1840:       <span class="command"><strong>lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
1.88      wiz      1841:       argument to check if your packages are up-to-date, e.g.
                   1842:     </p>
                   1843: <pre class="screen">
                   1844: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1845: ...
1.88      wiz      1846: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1847:     </pre>
1.110     hubertf  1848: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1849:     package on your system and rebuild any dependencies.
                   1850:     </p>
1.82      rillig   1851: </div>
                   1852: <div class="sect2" lang="en">
                   1853: <div class="titlepage"><div><div><h3 class="title">
                   1854: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1855: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1856:     administrative functions on the package system.</p>
1.82      rillig   1857: </div>
                   1858: <div class="sect2" lang="en">
                   1859: <div class="titlepage"><div><div><h3 class="title">
                   1860: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   1861: <p>Please pay very careful attention to the warnings
1.110     hubertf  1862:     expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.88      wiz      1863:     inherent dangers of installing binary packages which you did
                   1864:     not create yourself, and the security holes that can be
                   1865:     introduced onto your system by indiscriminate adding of such
                   1866:     files.</p>
1.75      rillig   1867: <p>The same warning of course applies to every package you
1.88      wiz      1868:     install from source when you haven't completely read and
                   1869:     understood the source code of the package, the compiler that
                   1870:     is used to build the package and all the other tools that are
                   1871:     involved.</p>
1.75      rillig   1872: </div>
                   1873: </div>
                   1874: <div class="sect1" lang="en">
                   1875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1876: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1877: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1878:   directory now contains a set of packages, organized into
                   1879:   categories. You can browse the online index of packages, or run
1.110     hubertf  1880:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1881:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   1882:   all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1883: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1884:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1885:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1886:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1887:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1888:   system (inside a chroot is an exception). </p>
                   1889: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1890:   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.88      wiz      1891:   instructions how to create your own packages.</p>
1.75      rillig   1892: <div class="sect2" lang="en">
                   1893: <div class="titlepage"><div><div><h3 class="title">
                   1894: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1895: <p>To build packages from source, you need a working C
1.88      wiz      1896:     compiler. On NetBSD, you need to install the
                   1897:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   1898:     sets. If you want to build X11-related packages, the
                   1899:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   1900:     sets are required, too.</p>
1.75      rillig   1901: </div>
                   1902: <div class="sect2" lang="en">
                   1903: <div class="titlepage"><div><div><h3 class="title">
                   1904: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1905: <p>The first step for building a package is downloading the
1.88      wiz      1906:     distfiles (i.e. the unmodified source). If they have not yet been
                   1907:     downloaded, pkgsrc will fetch them automatically.</p>
                   1908: <p>If you have all files that you need in the
                   1909:     <code class="filename">distfiles</code> directory,
                   1910:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1911:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1912:     </p>
1.82      rillig   1913: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1914: <p>
1.110     hubertf  1915:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1916: <p>By default a list of distribution sites will be randomly
                   1917:     intermixed to prevent huge load on servers which holding popular
                   1918:     packages (for example, SourceForge.net mirrors). Thus, every
                   1919:     time when you need to fetch yet another distfile all the mirrors
                   1920:     will be tried in new (random) order. You can turn this feature
                   1921:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1922:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1923: <p>You can overwrite some of the major distribution sites to
                   1924:     fit to sites that are close to your own.  By setting one or two
                   1925:     variables you can modify the order in which the master sites are
                   1926:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1927:     delimited list of domain suffixes.
                   1928:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1929:     contains a whitespace delimited list of regular expressions.  It
                   1930:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1931:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1932:     some examples.  This may save some of your bandwidth and
                   1933:     time.</p>
1.75      rillig   1934: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1935:     if you want to keep the settings, by editing the
1.110     hubertf  1936:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1937:     and adding the definitions there.</p>
1.82      rillig   1938: <p>
1.88      wiz      1939:       If a package depends on many other packages (such as
1.93      rillig   1940:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.88      wiz      1941:       alternate between periods of
                   1942:       downloading source, and compiling. To ensure you have all the source
                   1943:       downloaded initially you can run the command:
                   1944:       </p>
1.82      rillig   1945: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1946: <p>
1.88      wiz      1947:       which will output and run a set of shell commands to fetch the
                   1948:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1949:       also choose to download the files manually.
                   1950:     </p>
1.75      rillig   1951: </div>
                   1952: <div class="sect2" lang="en">
                   1953: <div class="titlepage"><div><div><h3 class="title">
                   1954: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1955: <p>
1.88      wiz      1956:       Once the software has downloaded, any patches will be applied, then it
                   1957:       will be compiled for you. This may take some time depending on your
                   1958:       computer, and how many other packages the software depends on and their
                   1959:       compile time.
                   1960:     </p>
1.75      rillig   1961: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1962: <h3 class="title">Note</h3>
                   1963: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1964:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.88      wiz      1965:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
1.75      rillig   1966: </div>
1.87      wiz      1967: <p>For example, type</p>
1.88      wiz      1968: <pre class="screen">
                   1969: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1970: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1971:     </pre>
1.75      rillig   1972: <p>at the shell prompt to build the various components of the
1.88      wiz      1973:     package.</p>
1.82      rillig   1974: <p>The next stage is to actually install the newly compiled
1.88      wiz      1975:     program onto your system. Do this by entering:
1.82      rillig   1976: 
1.88      wiz      1977:     </p>
1.82      rillig   1978: <pre class="screen">
1.88      wiz      1979: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1980:     </pre>
1.82      rillig   1981: <p>
                   1982: 
1.88      wiz      1983:     while you are still in the directory for whatever package you
                   1984:     are installing.</p>
1.82      rillig   1985: <p>Installing the package on your system may require you to
1.88      wiz      1986:     be root.  However, pkgsrc has a
                   1987:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1988:     to only become root for the actual installation step.</p>
1.82      rillig   1989: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1990:     You can now enter:
1.82      rillig   1991: 
1.88      wiz      1992:     </p>
1.82      rillig   1993: <pre class="screen">
1.88      wiz      1994: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1995:     </pre>
1.82      rillig   1996: <p>
                   1997: 
1.88      wiz      1998:     to remove the compiled files in the work directory, as you shouldn't need
                   1999:     them any more. If other packages were also added to your system
                   2000:     (dependencies) to allow your program to compile, you can tidy these up
                   2001:     also with the command:</p>
1.82      rillig   2002: <pre class="screen">
1.88      wiz      2003: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2004:     </pre>
1.75      rillig   2005: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  2006:     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.88      wiz      2007: <p>The program is installed under the default root of the
                   2008:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2009:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2010:     variable in your environment, and it will use that value as the
                   2011:     root of your packages tree. So, to use
                   2012:     <code class="filename">/usr/local</code>, set
                   2013:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2014:     Please note that you should use a directory which is dedicated to
                   2015:     packages and not shared with other programs (i.e., do not try and
                   2016:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2017:     to add any of your own files or directories (such as
                   2018:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2019:     <code class="filename">pkgsrc/</code>) below the
                   2020:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2021:     conflicts between programs and other files installed by the
                   2022:     package system and whatever else may have been installed
                   2023:     there.</p>
1.110     hubertf  2024: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      2025:     alter some configuration options at build time.  Have a look at
                   2026:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2027:     of what will be set there by default.  Environment variables such
                   2028:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  2029:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      2030:     set them each time you want to use pkgsrc.</p>
                   2031: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2032:     covers</span>&#8221; to see what is going on when a package is building
                   2033:     or being installed. This may be for debugging purposes, or out of
                   2034:     simple curiosity. A number of utility values have been added to
                   2035:     help with this.</p>
1.75      rillig   2036: <div class="orderedlist"><ol type="1">
                   2037: <li>
1.110     hubertf  2038: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      2039:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2040:        information will be displayed. For example,</p>
1.75      rillig   2041: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2042: <p>will show all the commands that are invoked, up to and
                   2043:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
1.75      rillig   2044: </li>
                   2045: <li>
1.110     hubertf  2046: <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-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2047:        definition, then the <code class="varname">VARNAME</code> definition
                   2048:        should be used, in conjunction with the show-var
1.110     hubertf  2049:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2050:        variable <code class="varname">LOCALBASE</code>:</p>
                   2051: <pre class="screen">
                   2052: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2053: /usr/pkg
                   2054: <code class="prompt">%</code>
1.88      wiz      2055:        </pre>
1.75      rillig   2056: </li>
                   2057: </ol></div>
                   2058: <p>If you want to install a binary package that you've either
1.88      wiz      2059:     created yourself (see next section), that you put into
                   2060:     pkgsrc/packages manually or that is located on a remote FTP
                   2061:     server, you can use the "bin-install" target. This target will
1.110     hubertf  2062:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
                   2063:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      2064:     sites searched is kept in the variable
                   2065:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.110     hubertf  2066:     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-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      2067:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2068:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2069:     details.</p>
                   2070: <p>A final word of warning: If you set up a system that has a
                   2071:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2072:     set that before any packages are installed, as you cannot use
                   2073:     several directories for the same purpose. Doing so will result in
                   2074:     pkgsrc not being able to properly detect your installed packages,
                   2075:     and fail miserably. Note also that precompiled binary packages are
                   2076:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2077:     <code class="filename">/usr/pkg</code>, and that you should
                   2078:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2079:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2080: </div>
                   2081: </div>
                   2082: </div>
                   2083: <div class="chapter" lang="en">
                   2084: <div class="titlepage"><div><div><h2 class="title">
                   2085: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2086: <div class="toc">
                   2087: <p><b>Table of Contents</b></p>
                   2088: <dl>
                   2089: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2090: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   2091: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      2092: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2093: <dd><dl>
1.103     wiz      2094: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.116     rillig   2095: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
                   2096: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88      wiz      2097: </dl></dd>
1.103     wiz      2098: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2099: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   2100: </dl>
                   2101: </div>
1.104     rillig   2102: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   2103: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2104: that file depends on the installation. On NetBSD, when you use
1.110     hubertf  2105: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   2106: <code class="filename">/etc/</code>. In all other cases the default location is
                   2107: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2108: bootstrap program to install the binary packages.</p>
                   2109: <p>During the bootstrap, an example configuration file is created. To
                   2110: use that, you have to create the directory
                   2111: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2112: there.</p>
                   2113: <p>The format of the configuration file is that of the usual
                   2114: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2115: is done by setting variables in this file. Note that you can define all
                   2116: kinds of variables, and no special error checking (for example for
                   2117: spelling mistakes) takes place, so you have to try it out to see if it
                   2118: works.</p>
1.75      rillig   2119: <div class="sect1" lang="en">
                   2120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2121: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2122: <p>In this section, you can find some variables that apply to all
1.89      rillig   2123:     pkgsrc packages. A complete list of the variables that can be
                   2124:     configured by the user is available in
                   2125:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2126:     comments that describe each variable's intent.</p>
1.75      rillig   2127: <div class="itemizedlist"><ul type="disc">
                   2128: <li><p><code class="varname">LOCALBASE</code>: Where
                   2129:            packages will be installed. The default is
1.76      rillig   2130:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2131:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2132: <li><p><code class="varname">CROSSBASE</code>: Where
                   2133:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2134:            installed. The default is
1.76      rillig   2135:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75      rillig   2136: <li><p><code class="varname">X11BASE</code>: Where
                   2137:            X11 is installed on the system. The default is
1.76      rillig   2138:            <code class="filename">/usr/X11R6</code>.</p></li>
1.75      rillig   2139: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2140:            downloaded copies of the original source distributions used
                   2141:            for building pkgsrc packages. The default is
1.76      rillig   2142:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97      rillig   2143: <li><p><code class="varname">PKG_DBDIR</code>: Where the
                   2144:            database about installed packages is stored.  The default is
                   2145:            <code class="filename">/var/db/pkg</code>.</p></li>
1.75      rillig   2146: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2147:            If set, override the packages'
                   2148:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2149: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2150:            Backup location(s) for distribution files and patch files
                   2151:            if not found locally or in
1.76      rillig   2152:            <code class="filename">${MASTER_SITES}</code> or
                   2153:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2154:            The defaults are
1.76      rillig   2155:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2156:            and
1.76      rillig   2157:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75      rillig   2158: <li><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2159:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2160:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2161:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2162:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
1.82      rillig   2163: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2164:            List of acceptable licenses. Whenever you try to build a package
                   2165:            whose license is not in this list, you will get an error message
                   2166:            that includes instructions on how to change this variable.</p></li>
1.75      rillig   2167: </ul></div>
                   2168: </div>
                   2169: <div class="sect1" lang="en">
                   2170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2171: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2172: <p>XXX
                   2173:       </p>
                   2174: <div class="itemizedlist"><ul type="disc">
                   2175: <li><p><code class="varname">PACKAGES</code>: The top level
                   2176:            directory for the binary packages. The default is
1.76      rillig   2177:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75      rillig   2178: <li><p><code class="varname">WRKOBJDIR</code>:
                   2179:            The top level directory where, if defined, the separate
                   2180:            working directories will get created, and symbolically
1.76      rillig   2181:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2182:            This is useful for building packages on several
1.76      rillig   2183:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2184:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2185:            is local to every architecture. (It should be noted that
                   2186:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.114     jmcneill 2187:            &mdash; it is an internal definition which refers to the
1.75      rillig   2188:            root of the pkgsrc tree. It is possible to have many
                   2189:            pkgsrc tree instances.)</p></li>
                   2190: <li><p><code class="varname">LOCALPATCHES</code>:
                   2191:            Directory for local patches that aren't part of pkgsrc.
1.110     hubertf  2192:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2193:            information.</p></li>
1.75      rillig   2194: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  2195:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   2196:            BSD-style Makefile. If this is not set,
                   2197:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2198:            <code class="filename">/dev/null</code> to avoid picking up
                   2199:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82      rillig   2200: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2201:            By default, dependencies are only installed, and no binary
                   2202:            package is created for them. You can set this variable to
                   2203:            <code class="literal">package</code> to automatically create binary
                   2204:            packages after installing dependencies.</p></li>
1.75      rillig   2205: </ul></div>
                   2206: </div>
                   2207: <div class="sect1" lang="en">
                   2208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   2209: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103     wiz      2210: <p>A growing number of packages support installation into a
                   2211:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2212:     to be built, before the actual filesystem is touched. DESTDIR
                   2213:     support exists in two variations:</p>
                   2214: <div class="itemizedlist"><ul type="disc">
                   2215: <li><p>Basic DESTDIR support means that the package
                   2216:       installation and packaging is still run as
                   2217:       root.</p></li>
                   2218: <li><p>Full DESTDIR support can run the complete build,
                   2219:       installation and packaging as normal user. Root privileges are
                   2220:       only needed to add packages.</p></li>
                   2221: </ul></div>
                   2222: <p>To use the DESTDIR support, set either
                   2223:     <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
                   2224:     packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
                   2225:     get the full support with fallback to basic
                   2226:     support. <code class="varname">USE_DESTDIR=full</code> needs <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> version 20070802 (or
                   2227:     newer). It might become the default DESTDIR support later.</p>
                   2228: <p>DESTDIR support changes the behaviour of various targets
                   2229:     slightly. To install a package after building it, use
                   2230:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2231:     <code class="literal">install</code> don't do that any
                   2232:     longer. <code class="literal">package-install</code> can be used as
                   2233:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2234:     will ask for the root password to install the package and fail,
                   2235:     <code class="literal">package-install</code> will ask again.</p>
                   2236: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2237:     clean</code></strong> needs to be run as root.</p>
1.118     imil     2238: <p>Considering the <code class="filename">foo/bar</code> package,
                   2239:     DESTDIR full support can be tested using the following commands
                   2240: 
                   2241: </p>
                   2242: <pre class="programlisting">
                   2243: <code class="prompt">$</code> id
                   2244: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2245: <code class="prompt">$</code> mkdir $HOME/packages
                   2246: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2247: </pre>
                   2248: <p>
                   2249: 
                   2250:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2251:     should be needed
                   2252: 
                   2253: </p>
                   2254: <pre class="programlisting">
                   2255: <code class="prompt">$</code> make USE_DESTDIR=full install
                   2256: </pre>
                   2257: <p>
                   2258: 
                   2259:     Create a package without root privileges
                   2260: 
                   2261: </p>
                   2262: <pre class="programlisting">
                   2263: <code class="prompt">$</code> make USE_DESTDIR=full PACKAGES=$HOME/packages package
                   2264: </pre>
                   2265: <p>
                   2266: 
                   2267:     For the following command, you must be able to gain root
                   2268:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
                   2269: 
                   2270: </p>
                   2271: <pre class="programlisting">
                   2272: <code class="prompt">$</code> make USE_DESTDIR=full PACKAGES=$HOME/packages package-install
                   2273: </pre>
                   2274: <p>
                   2275: 
                   2276:     Then, as a simple user
                   2277: 
                   2278: </p>
                   2279: <pre class="programlisting">
                   2280: <code class="prompt">$</code> make clean
                   2281: </pre>
                   2282: <p>
                   2283: 
                   2284:     </p>
1.103     wiz      2285: </div>
                   2286: <div class="sect1" lang="en">
                   2287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2288: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78      rillig   2289: <div class="sect2" lang="en">
                   2290: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2291: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   2292: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2293:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2294: <div class="variablelist"><dl>
                   2295: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2296: <dd>
                   2297: <p>This is a list of values specifying the chain of
                   2298:          compilers to invoke when building packages.  Valid values
                   2299:          are:</p>
                   2300: <div class="itemizedlist"><ul type="disc">
                   2301: <li><p><code class="varname">distcc</code>:
                   2302:            distributed C/C++ (chainable)</p></li>
                   2303: <li><p><code class="varname">ccache</code>:
                   2304:            compiler cache (chainable)</p></li>
                   2305: <li><p><code class="varname">gcc</code>:
                   2306:            GNU C/C++ Compiler</p></li>
                   2307: <li><p><code class="varname">mipspro</code>:
                   2308:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2309: <li><p><code class="varname">mipspro</code>:
                   2310:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2311: <li><p><code class="varname">sunpro</code>:
                   2312:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2313: </ul></div>
                   2314: <p>The default is
                   2315:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2316:          <code class="varname">ccache</code> and/or
                   2317:          <code class="varname">distcc</code> with an appropriate
                   2318:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2319:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
1.94      dmcmahil 2320:          variable should always be terminated with a value for
                   2321:          a real compiler.  Note that only one real compiler
                   2322:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2323:          is not allowed).</p>
1.89      rillig   2324: </dd>
                   2325: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2326: <dd><p>This specifies the minimum version of GCC to use
                   2327:          when building packages.  If the system GCC doesn't
                   2328:          satisfy this requirement, then pkgsrc will build and
                   2329:          install one of the GCC packages to use instead.</p></dd>
                   2330: </dl></div>
                   2331: </div>
                   2332: <div class="sect2" lang="en">
                   2333: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2334: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   2335: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2336:        please make sure to use the <code class="literal">+=</code> operator
                   2337:        instead of the <code class="literal">=</code> operator:</p>
                   2338: <pre class="programlisting">
1.100     rillig   2339: CFLAGS+=        -your -flags
1.78      rillig   2340: </pre>
                   2341: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.117     jnemeth  2342:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that
                   2343:        need to add their own flags.  You may want to take a look
                   2344:        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>
                   2345:        package if you're interested in optimization for the current
                   2346:        CPU.  Setting <code class="varname">USE_CPUFLAGS</code> to yes in
                   2347:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use cpuflags.</p>
1.78      rillig   2348: </div>
1.88      wiz      2349: <div class="sect2" lang="en">
                   2350: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2351: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      2352: <p>If you want to pass flags to the linker, both in the configure
                   2353: step and the build step, you can do this in two ways.  Either set
                   2354: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2355: between the two is that <code class="varname">LIBS</code> will be appended to
                   2356: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2357: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2358: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2359: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2360: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2361: settings, use the <code class="literal">+=</code> operator:</p>
                   2362: <pre class="programlisting">
1.100     rillig   2363: LDFLAGS+=        -your -linkerflags
1.88      wiz      2364: </pre>
                   2365: </div>
1.78      rillig   2366: </div>
                   2367: <div class="sect1" lang="en">
                   2368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2369: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2370: <p>XXX
                   2371:       </p>
                   2372: <div class="itemizedlist"><ul type="disc">
                   2373: <li>
                   2374: <p><code class="varname">PKG_DEVELOPER</code>:
                   2375:            Run some sanity checks that package developers want:
                   2376:            </p>
                   2377: <div class="itemizedlist"><ul type="circle">
1.88      wiz      2378: <li><p>make sure patches apply with zero
                   2379:              fuzz</p></li>
                   2380: <li><p>run check-shlibs to see that all
                   2381:              binaries will find their shared libs.</p></li>
1.75      rillig   2382: </ul></div>
                   2383: <p>
1.87      wiz      2384:        </p>
1.75      rillig   2385: </li>
1.88      wiz      2386: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2387:        of debugging output which is displayed whilst making and
                   2388:        installing the package.  The default value for this is 0,
                   2389:        which will not display the commands as they are executed
                   2390:        (normal, default, quiet operation); the value 1 will display
                   2391:        all shell commands before their invocation, and the value 2
                   2392:        will display both the shell commands before their invocation,
1.110     hubertf  2393:        and their actual execution progress with <span class="command"><strong>set
1.88      wiz      2394:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2395: </ul></div>
                   2396: <p>
                   2397:     </p>
                   2398: </div>
                   2399: <div class="sect1" lang="en">
                   2400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2401: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      2402: <p>Some packages have build time options, usually to select
                   2403:     between different dependencies, enable optional support for big
                   2404:     dependencies or enable experimental features.</p>
1.75      rillig   2405: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2406:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2407:     show-options</strong></span>, for example:</p>
1.75      rillig   2408: <pre class="programlisting">
                   2409:     The following options are supported by this package:
                   2410:         ssl      Enable SSL support.
                   2411:     Exactly one of the following gecko options is required:
                   2412:         firefox  Use firefox as gecko rendering engine.
                   2413:         mozilla  Use mozilla as gecko rendering engine.
                   2414:     At most one of the following database options may be selected:
                   2415:         mysql    Enable support for MySQL database.
                   2416:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2417: 
1.75      rillig   2418:     These options are enabled by default: firefox
                   2419:     These options are currently enabled: mozilla ssl
1.1       grant    2420: </pre>
1.75      rillig   2421: <p>The following variables can be defined in
1.110     hubertf  2422:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2423:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2424:     which can be used to select or disable options for all packages
                   2425:     that support them, and
                   2426:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2427:     which can be used to select or disable options specifically for
                   2428:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2429:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2430:     are disabled. A few examples:</p>
1.75      rillig   2431: <pre class="screen">
1.110     hubertf  2432: <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.75      rillig   2433: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2434: PKG_OPTIONS.kdebase=    debug -sasl
                   2435: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2436: <p>It is important to note that options that were specifically
                   2437:     suggested by the package maintainer must be explicitely removed if
                   2438:     you do not wish to include the option.  If you are unsure you can view
                   2439:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2440: <p>The following settings are consulted in the order given, and
                   2441:     the last setting that selects or disables an option is
                   2442:     used:</p>
1.75      rillig   2443: <div class="orderedlist"><ol type="1">
                   2444: <li><p>the default options as suggested by the package
1.88      wiz      2445:       maintainer</p></li>
1.75      rillig   2446: <li><p>the options implied by the settings of legacy
1.88      wiz      2447:       variables (see below)</p></li>
1.75      rillig   2448: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2449: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2450: </ol></div>
                   2451: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2452:     selected is used, all others are automatically disabled.  If an
                   2453:     option of the group is explicitly disabled, the previously
                   2454:     selected option, if any, is used.  It is an error if no option
                   2455:     from a required group of options is selected, and building the
                   2456:     package will fail.</p>
                   2457: <p>Before the options framework was introduced, build options
                   2458:     were selected by setting a variable (often named
                   2459:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2460:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2461:     transition to the options framework for the user, these legacy
                   2462:     variables are converted to the appropriate options setting
                   2463:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2464:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2465:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2466:     directly.  Support for the legacy variables will be removed
                   2467:     eventually.</p>
1.75      rillig   2468: </div>
                   2469: </div>
                   2470: <div class="chapter" lang="en">
                   2471: <div class="titlepage"><div><div><h2 class="title">
                   2472: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2473: <div class="toc">
                   2474: <p><b>Table of Contents</b></p>
                   2475: <dl>
                   2476: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2477: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2478: </dl>
                   2479: </div>
                   2480: <div class="sect1" lang="en">
                   2481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2482: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2483: <p>Once you have built and installed a package, you can create
                   2484:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110     hubertf  2485:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2486:     the same package on a group of hosts and wasting CPU time. It also
                   2487:     provides a simple means for others to install your package, should
                   2488:     you distribute it.</p>
                   2489: <p>To create a binary package, change into the appropriate
1.110     hubertf  2490:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2491:     package</strong></span>:</p>
                   2492: <pre class="screen">
                   2493: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2494: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2495:     </pre>
                   2496: <p>This will build and install your package (if not already done),
                   2497:     and then build a binary package from what was installed. You can
1.110     hubertf  2498:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2499:     it. Binary packages are created by default in
                   2500:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2501:     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.91      rillig   2502:     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.110     hubertf  2503: <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.87      wiz      2504:     such a binary package.</p>
1.75      rillig   2505: </div>
                   2506: <div class="sect1" lang="en">
                   2507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2508: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2509: <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.106     rillig   2510: </div>
                   2511: </div>
                   2512: <div class="chapter" lang="en">
                   2513: <div class="titlepage"><div><div><h2 class="title">
                   2514: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2515: builds)</h2></div></div></div>
                   2516: <div class="toc">
                   2517: <p><b>Table of Contents</b></p>
                   2518: <dl>
                   2519: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2520: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2521: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2522: <dd><dl>
                   2523: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2524: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2525: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2526: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2527: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2528: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2529: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2530: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2531: </dl></dd>
                   2532: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig   2533: <dd><dl>
                   2534: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                   2535: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                   2536: </dl></dd>
1.106     rillig   2537: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2538: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2539: </dl>
                   2540: </div>
                   2541: <p>When you have multiple machines that should run the same packages,
                   2542: it is wasted time if they all build their packages themselves from
                   2543: source. There are two ways of getting a set of binary packages: The old
                   2544: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2545: system. This chapter describes how to set them up so that the packages
                   2546: are most likely to be usable later.</p>
                   2547: <div class="sect1" lang="en">
                   2548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2549: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2550: <p>Since a bulk build takes several days or even weeks to finish, you
                   2551: should think about the setup before you start everything. Pay attention
                   2552: to at least the following points:</p>
                   2553: <div class="itemizedlist"><ul type="disc">
                   2554: <li>
                   2555: <p>If you want to upload the binary packages to
                   2556: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2557: packages:</p>
                   2558: <div class="itemizedlist"><ul type="circle">
                   2559: <li><p>To end up on ftp.NetBSD.org, the packages must be built
                   2560: by a NetBSD developer on a trusted machine (that is, where you and only
                   2561: you have root access).</p></li>
                   2562: <li><p>Packages on ftp.NetBSD.org should only be created from
                   2563: the stable branches (like 2007Q1), so that users browsing the available
                   2564: collections can see at a glance how old the packages
                   2565: are.</p></li>
                   2566: <li><p>The packages must be built as root, since some packages
                   2567: require set-uid binaries at runtime, and creating those packages as
                   2568: unprivileged user doesn't work well at the moment.</p></li>
                   2569: </ul></div>
                   2570: </li>
                   2571: <li><p>Make sure that the bulk build cannot break anything in
                   2572: your system. Most bulk builds run as root, so they should be run at least
                   2573: in a chroot environment or something even more restrictive, depending on
                   2574: what the operating system provides. There have been numerous cases where
                   2575: certain packages tried to install files outside the
                   2576: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2577: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2578: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2579: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2580: that you don't need any package during the build.</p></li>
                   2581: </ul></div>
                   2582: </div>
                   2583: <div class="sect1" lang="en">
                   2584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2585: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2586: <p>A complete bulk build requires lots of disk space. Some of the
                   2587: disk space can be read-only, some other must be writable. Some can be on
                   2588: remote filesystems (such as NFS) and some should be local. Some can be
                   2589: temporary filesystems, others must survive a sudden reboot.</p>
                   2590: <div class="itemizedlist"><ul type="disc">
                   2591: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2592: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2593: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2594: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2595: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2596: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2597: </ul></div>
1.75      rillig   2598: </div>
                   2599: <div class="sect1" lang="en">
                   2600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2601: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.116     rillig   2602: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2603: <h3 class="title">Note</h3>
                   2604: <p>There are two ways of doing a bulk build. The old-style
                   2605: one and the new-style &#8220;<span class="quote">pbulk</span>&#8221;. The latter is the recommended
                   2606: way.</p>
1.106     rillig   2607: </div>
1.75      rillig   2608: <div class="sect2" lang="en">
                   2609: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2610: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.75      rillig   2611: <div class="sect3" lang="en">
                   2612: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2613: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93      rillig   2614: </h4></div></div></div>
1.76      rillig   2615: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2616:        configuration file for bulk builds. You can configure how your
                   2617:        copy of pkgsrc is kept up to date, how the distfiles are
                   2618:        downloaded, how the packages are built and how the report is
                   2619:        generated. You can find an annotated example file in
                   2620:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2621:        it, copy <code class="filename">build.conf-example</code> to
                   2622:        <code class="filename">build.conf</code> and edit it, following the
                   2623:        comments in that file.</p>
1.75      rillig   2624: </div>
                   2625: <div class="sect3" lang="en">
                   2626: <div class="titlepage"><div><div><h4 class="title">
1.110     hubertf  2627: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.104     rillig   2628: </h4></div></div></div>
1.110     hubertf  2629: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87      wiz      2630:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2631:        details of the default settings. You will want to ensure that
                   2632:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2633:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.104     rillig   2634:        completely bypasses the license check.</p>
1.87      wiz      2635: <pre class="programlisting">
1.100     rillig   2636: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2637: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2638: BSDSRCDIR=      /usr/src
                   2639: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2640: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2641: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2642: PKG_DEVELOPER?= yes
                   2643: _ACCEPTABLE=    yes
                   2644: </pre>
1.75      rillig   2645: <p>Some options that are especially useful for bulk builds
                   2646:        can be found at the top lines of the file
1.76      rillig   2647:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2648:        options of these are briefly described here.</p>
                   2649: <div class="itemizedlist"><ul type="disc">
                   2650: <li><p>If you are on a slow machine, you may want to
1.87      wiz      2651:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2652:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
1.75      rillig   2653: <li><p>If you are doing bulk builds from a read-only
1.87      wiz      2654:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2655:          to the directory where all log files are created. Otherwise the
                   2656:          log files are created in the pkgsrc directory.</p></li>
1.75      rillig   2657: <li><p>Another important variable is
1.87      wiz      2658:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2659:          should be always available while building other
                   2660:          packages.</p></li>
1.75      rillig   2661: </ul></div>
                   2662: <p>Some other options are scattered in the pkgsrc
                   2663:        infrastructure:</p>
                   2664: <div class="itemizedlist"><ul type="disc">
                   2665: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87      wiz      2666:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2667:          builds is creating binary packages, no matter if they are
                   2668:          vulnerable or not. When uploading the packages to a public
                   2669:          server, the vulnerable packages will be put into a directory of
                   2670:          their own. Leaving this variable unset would prevent the bulk
                   2671:          build system from even trying to build them, so possible
                   2672:          building errors would not show up.</p></li>
1.75      rillig   2673: <li><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2674:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87      wiz      2675:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2676:          matches the <code class="filename">PLIST</code>.</p></li>
1.75      rillig   2677: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2678:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87      wiz      2679:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2680:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2681:          interpreter.</p></li>
1.91      rillig   2682: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2683:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2684:          package's self-test before installing it. Note that some
                   2685:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2686:          numbers, so you need to assure that the machine on which you
                   2687:          are doing the bulk builds is not completely idle. Otherwise
                   2688:          some test programs will seem to hang, while they are just
                   2689:          waiting for new random data to be
                   2690:          available.</p></li>
1.75      rillig   2691: </ul></div>
                   2692: </div>
                   2693: <div class="sect3" lang="en">
                   2694: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2695: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93      rillig   2696: </h4></div></div></div>
1.75      rillig   2697: <p>It is possible to configure the bulk build to perform
1.87      wiz      2698:        certain site-specific tasks at the end of the pre-build
                   2699:        stage.  If the file
                   2700:        <code class="filename">pre-build.local</code> exists in
                   2701:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110     hubertf  2702:        (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.87      wiz      2703:        stage.  An example use of
                   2704:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2705: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2706:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2707: <p>to prevent the system from trying to build a particular package
1.87      wiz      2708:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2709: </div>
                   2710: </div>
                   2711: <div class="sect2" lang="en">
                   2712: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2713: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2714: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2715:       deleted at the start of bulk builds, make sure your login
                   2716:       shell is placed somewhere else. Either drop it into
                   2717:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2718:       shell in the passwd file), or (re-)install it via
1.110     hubertf  2719:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.87      wiz      2720:       you can login after a reboot (remember that your current
                   2721:       process won't die if the package is removed, you just can't
                   2722:       start any new instances of the shell any more).  Also, if you
                   2723:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2724:       version of ssh for some reason, be sure to install ssh before
                   2725:       starting it from <code class="filename">rc.local</code>:</p>
                   2726: <pre class="programlisting">
1.100     rillig   2727: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2728: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2729:   /usr/pkg/etc/rc.d/sshd
                   2730: fi
                   2731: </pre>
1.75      rillig   2732: <p>Not doing so will result in you being not able to log in
1.87      wiz      2733:       via ssh after the bulk build is finished or if the machine
                   2734:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2735: </div>
                   2736: <div class="sect2" lang="en">
                   2737: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2738: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75      rillig   2739: <p>Make sure you don't need any of the packages still
1.87      wiz      2740:       installed.</p>
1.75      rillig   2741: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2742: <h3 class="title">Warning</h3>
1.99      rillig   2743: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2744:        configuration files and some more files from
                   2745:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2746:        possibly other locations will be removed! So don't run a bulk
                   2747:        build with privileges that might harm your
                   2748:        system.</em></span></p>
1.75      rillig   2749: </div>
                   2750: <p>Be sure to remove all other things that might
1.87      wiz      2751:       interfere with builds, like some libs installed in
                   2752:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2753: <pre class="screen">
                   2754: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2755: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2756:       </pre>
1.75      rillig   2757: <p>If for some reason your last build didn't complete (power
1.87      wiz      2758:       failure, system panic, ...), you can continue it by
                   2759:       running:</p>
1.75      rillig   2760: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2761: <p>At the end of the bulk build, you will get a summary via mail,
                   2762:       and find build logs in the directory specified by
                   2763:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2764:       file.</p>
1.75      rillig   2765: </div>
                   2766: <div class="sect2" lang="en">
                   2767: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2768: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75      rillig   2769: <p>The bulk builds consist of three steps:</p>
                   2770: <div class="variablelist"><dl>
                   2771: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2772: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2773:            cleans out any broken distfiles, and removes all
                   2774:            packages installed.</p></dd>
1.75      rillig   2775: <dt><span class="term">2. the bulk build</span></dt>
1.87      wiz      2776: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2777:            an optimised order in which packages will be
                   2778:            built. Packages that don't require other packages will
                   2779:            be built first, and packages with many dependencies will
                   2780:            be built later.</p></dd>
1.75      rillig   2781: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2782: <dd><p>Generates a report that's placed in the directory
                   2783:            specified in the <code class="filename">build.conf</code> file
                   2784:            named <code class="filename">broken.html</code>, a short version
                   2785:            of that report will also be mailed to the build's
                   2786:            admin.</p></dd>
1.75      rillig   2787: </dl></div>
1.87      wiz      2788: <p>During the build, a list of broken packages will be compiled
                   2789:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2790:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2791:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2792:       of broken builds can be found in the package's
                   2793:       directory. These files are used by the bulk-targets to mark
                   2794:       broken builds to not waste time trying to rebuild them, and
                   2795:       they can be used to debug these broken package builds
                   2796:       later.</p>
1.75      rillig   2797: </div>
                   2798: <div class="sect2" lang="en">
                   2799: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2800: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75      rillig   2801: <p>Currently, roughly the following requirements are valid for
1.87      wiz      2802:       NetBSD 2.0/i386:</p>
1.75      rillig   2803: <div class="itemizedlist"><ul type="disc">
1.87      wiz      2804: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2805: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2806: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2807: </ul></div>
                   2808: <p>Note that all pkgs will be de-installed as soon as they are
                   2809:       turned into a binary package, and that sources are removed,
                   2810:       so there is no excessively huge demand to disk
                   2811:       space. Afterwards, if the package is needed again, it will
1.110     hubertf  2812:       be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.87      wiz      2813:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2814: </div>
                   2815: <div class="sect2" lang="en">
                   2816: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2817: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2818: <p>If you don't want all the packages nuked from a machine
                   2819:       (rendering it useless for anything but pkg compiling), there
                   2820:       is the possibility of doing the package bulk build inside a
                   2821:       chroot environment.</p>
                   2822: <p>The first step is to set up a chroot sandbox,
                   2823:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2824:       using null mounts, or manually.</p>
                   2825: <p>There is a shell script called
                   2826:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2827:       up the sandbox environment using null mounts. It will also
                   2828:       create a script called <code class="filename">sandbox</code> in the
                   2829:       root of the sandbox environment, which will allow the null
1.110     hubertf  2830:       mounts to be activated using the <span class="command"><strong>sandbox
1.87      wiz      2831:       mount</strong></span> command and deactivated using the
1.110     hubertf  2832:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87      wiz      2833: <p>To set up a sandbox environment by hand, after extracting all
1.110     hubertf  2834:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87      wiz      2835:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2836:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2837:       are present and properly configured:</p>
1.75      rillig   2838: <div class="procedure"><ol type="1">
                   2839: <li>
                   2840: <p>Kernel</p>
                   2841: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2842: </li>
                   2843: <li>
1.76      rillig   2844: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2845: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2846: </li>
                   2847: <li>
1.91      rillig   2848: <p><code class="filename">/etc/resolv.conf</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a> and mail):</p>
1.75      rillig   2849: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2850: </li>
                   2851: <li>
                   2852: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2853: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2854: </li>
                   2855: <li>
1.91      rillig   2856: <p><code class="filename">/etc/localtime</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a>):</p>
1.75      rillig   2857: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2858: </li>
                   2859: <li>
1.76      rillig   2860: <p><code class="filename">/usr/src</code> (system sources,
1.114     jmcneill 2861:          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.75      rillig   2862: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2863:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2864: </li>
                   2865: <li>
1.76      rillig   2866: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2867: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2868: </li>
                   2869: <li>
1.76      rillig   2870: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2871: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2872: </li>
                   2873: <li>
                   2874: <p>Checkout pkgsrc via cvs into
1.87      wiz      2875:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2876: <pre class="screen">
                   2877: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2878: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2879:          </pre>
1.75      rillig   2880: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2881:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2882: </li>
                   2883: <li><p>Make
1.87      wiz      2884:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2885:          <code class="filename">.../distfiles</code> point somewhere
                   2886:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.116     rillig   2887: <li><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. ???">Section 7.3.1.2, &#8220;???&#8221;</a>.</p></li>
1.76      rillig   2888: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2889: </ol></div>
                   2890: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2891:       the build with the following steps:</p>
                   2892: <pre class="screen">
                   2893: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2894: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2895:       </pre>
                   2896: <p>This will just jump inside the sandbox and start building.  At
                   2897:        the end of the build, mail will be sent with the results of
                   2898:        the build. Created binary pkgs will be in
                   2899:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2900:       (wherever that points/mounts to/from).</p>
1.75      rillig   2901: </div>
                   2902: <div class="sect2" lang="en">
                   2903: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2904: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2905: <p>In addition to building a complete set of all packages in
                   2906:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2907:       may be used to build a subset of the packages contained in
                   2908:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.110     hubertf  2909:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75      rillig   2910: <div class="itemizedlist"><ul type="disc">
                   2911: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2912: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2913: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2914: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2915: </ul></div>
1.87      wiz      2916: <p>will define the set of packages which should be built.
                   2917:       The bulk build code will also include any packages which are
                   2918:       needed as dependencies for the explicitly listed packages.</p>
                   2919: <p>One use of this is to do a bulk build with
                   2920:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2921:       periodically to have a complete set of the binary packages
                   2922:       needed for your site available without the overhead of
                   2923:       building extra packages that are not needed.</p>
1.75      rillig   2924: </div>
                   2925: <div class="sect2" lang="en">
                   2926: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2927: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      2928: <p>This section describes how pkgsrc developers can upload binary
                   2929:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2930: <p>If you would like to automatically create checksum files for the
                   2931:       binary packages you intend to upload, remember to set
                   2932:       <code class="varname">MKSUMS=yes</code> in your
                   2933:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2934: <p>If you would like to PGP sign the checksum files (highly
                   2935:       recommended!), remember to set
                   2936:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2937:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2938:       your GPG password to sign the files before uploading everything.</p>
                   2939: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2940:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2941:       file, i.e. adjust it to something like one of the following:</p>
1.93      rillig   2942: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2943: <p>Please use appropriate values for "packages-200xQy",
1.87      wiz      2944:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2945:       is different from your local login, write your login directly
                   2946:       into the variable, e.g. my local account is "feyrer", but for my
                   2947:       login "hubertf", I use:</p>
1.93      rillig   2948: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87      wiz      2949: <p>A separate <code class="filename">upload</code> directory is used
                   2950:       here to allow "closing" the directory during upload. To do
                   2951:       so, run the following command on ftp.NetBSD.org next:</p>
1.93      rillig   2952: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
1.87      wiz      2953: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   2954:       only appropriate for packages for the NetBSD operating
                   2955:       system. Binary packages for other operating systems should go
                   2956:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   2957: <p>Before uploading the binary pkgs, ssh authentication needs
                   2958:       to be set up. This example shows how to set up temporary keys
                   2959:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2960:       (assuming that no keys should be present there usually):</p>
                   2961: <pre class="screen">
                   2962: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   2963: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   2964: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87      wiz      2965: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   2966:       </pre>
                   2967: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   2968:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   2969:       file on ftp.NetBSD.org. You can remove the key after the
                   2970:       upload is done!</p>
                   2971: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   2972: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      2973: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2974: <p>Now after all this works, you can exit the sandbox and start
                   2975:       the upload:</p>
                   2976: <pre class="screen">
                   2977: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   2978: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      2979: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2980:       </pre>
1.110     hubertf  2981: <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-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
                   2982:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.87      wiz      2983:       upload. The upload script will take care of not uploading
                   2984:       restricted packages and putting vulnerable packages into the
                   2985:       <code class="filename">vulnerable</code> subdirectory.</p>
                   2986: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   2987: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      2988:       Gdd:x! </pre>
                   2989: <p>Use whatever is needed to remove the key you've entered
                   2990:       before! Last, move the uploaded packages out of the
                   2991:       <code class="filename">upload</code> directory to have them accessible
                   2992:       to everyone:</p>
                   2993: <pre class="screen">
1.93      rillig   2994: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75      rillig   2995: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2996: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87      wiz      2997: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   2998:       </pre>
1.75      rillig   2999: </div>
                   3000: </div>
                   3001: <div class="sect1" lang="en">
                   3002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3003: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   3004: <p>Running a pbulk-style bulk build works roughly as follows:</p>
                   3005: <div class="itemizedlist"><ul type="disc">
                   3006: <li><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   3007: <li><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
                   3008: </ul></div>
                   3009: <div class="sect2" lang="en">
                   3010: <div class="titlepage"><div><div><h3 class="title">
                   3011: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117     jnemeth  3012: <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>
1.116     rillig   3013: <pre class="screen">
                   3014: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3015: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
                   3016: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
                   3017: </pre>
                   3018: <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>
                   3019: <div class="itemizedlist"><ul type="disc">
                   3020: <li><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
                   3021: <li><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>
                   3022: <li><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>
                   3023: <li><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>
                   3024: <li><p><code class="literal"><code class="varname">_ACCEPTABLE</code>=yes</code>, to accept all licenses, no matter how restrictive they are.</p></li>
                   3025: </ul></div>
                   3026: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
                   3027: <pre class="screen">
                   3028: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
                   3029: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
                   3030: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
                   3031: </pre>
                   3032: <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>
                   3033: </div>
1.106     rillig   3034: <div class="sect2" lang="en">
                   3035: <div class="titlepage"><div><div><h3 class="title">
1.116     rillig   3036: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114     jmcneill 3037: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116     rillig   3038: <p>TODO: continue writing</p>
1.106     rillig   3039: </div>
                   3040: </div>
                   3041: <div class="sect1" lang="en">
                   3042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3043: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      3044: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3045:     create a CD-ROM set of the resulting binary packages to assist
                   3046:     in installing packages on other machines.  The
1.91      rillig   3047:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      3048:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  3049:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      3050:     way that keeps all the dependencies for a given package on the same
                   3051:     CD as that package.</p>
1.75      rillig   3052: <div class="sect2" lang="en">
                   3053: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3054: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      3055: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3056:       man page. The following short example assumes that the binary
                   3057:       packages are left in
                   3058:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3059:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3060:       hold the ISO 9660 images.</p>
                   3061: <pre class="screen">
                   3062: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   3063: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      3064: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3065:       </pre>
                   3066: <p>If you wish to include a common set of files
                   3067:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3068:       etc.) on each CD in the collection, then you need to create a
                   3069:       directory which contains these files. e.g.</p>
                   3070: <pre class="screen">
                   3071: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   3072: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3073: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3074: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3075: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3076: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      3077: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3078:       </pre>
1.75      rillig   3079: <p>Now create the images:</p>
                   3080: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76      rillig   3081: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      3082:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3083:       in their root directories.</p>
1.75      rillig   3084: </div>
                   3085: </div>
                   3086: </div>
                   3087: <div class="chapter" lang="en">
                   3088: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3089: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   3090: <div class="toc">
                   3091: <p><b>Table of Contents</b></p>
                   3092: <dl>
1.116     rillig   3093: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
                   3094: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.90      rillig   3095: </dl>
                   3096: </div>
                   3097: <p>The files that are installed by pkgsrc are organized in a way that
                   3098: is similar to what you find in the <code class="filename">/usr</code> directory
                   3099: of the base system. But some details are different. This is because
                   3100: pkgsrc initially came from FreeBSD and had adopted its file system
                   3101: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3102: which operating system you are using pkgsrc with, you can expect the
                   3103: same layout for pkgsrc.</p>
1.91      rillig   3104: <p>There are mainly four root directories for pkgsrc, which are all
                   3105: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3106: When pkgsrc has been installed as root, the default locations
                   3107: are:</p>
                   3108: <pre class="programlisting">
1.100     rillig   3109: LOCALBASE=              /usr/pkg
                   3110: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3111: VARBASE=                /var
                   3112: PKG_DBDIR=              /var/db/pkg
1.91      rillig   3113: </pre>
                   3114: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3115: user), the default locations are:</p>
                   3116: <pre class="programlisting">
1.100     rillig   3117: LOCALBASE=              ${HOME}/pkg
                   3118: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3119: VARBASE=                ${HOME}/pkg/var
                   3120: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3121: </pre>
                   3122: <p>What these four directories are for, and what they look like is
                   3123: explained below.</p>
1.90      rillig   3124: <div class="itemizedlist"><ul type="disc">
                   3125: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3126: <code class="filename">/usr</code> directory in the base system. It is the
                   3127: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3128: the well-known subdirectories like <code class="filename">bin</code>,
                   3129: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3130: <code class="filename">share</code> and
                   3131: <code class="filename">sbin</code>.</p></li>
                   3132: <li><p><code class="varname">VARBASE</code> corresponds to
                   3133: <code class="filename">/var</code> in the base system. Some programs (especially
                   3134: games, network daemons) need write access to it during normal
                   3135: operation.</p></li>
                   3136: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3137: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  3138: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90      rillig   3139: itself.</p></li>
                   3140: </ul></div>
                   3141: <div class="sect1" lang="en">
                   3142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3143: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   3144: </h2></div></div></div>
1.90      rillig   3145: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3146: in <code class="filename">${LOCALBASE}</code>.</p>
1.90      rillig   3147: <div class="variablelist"><dl>
                   3148: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3149: <dd><p>Contains executable programs that are intended to be
                   3150: directly used by the end user.</p></dd>
                   3151: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3152: <dd><p>Contains files for the emulation layers of various other
                   3153: operating systems, especially for
                   3154: NetBSD.</p></dd>
                   3155: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3156: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3157: <dd><p>Contains
                   3158: the configuration files.</p></dd>
                   3159: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3160: <dd><p>Contains headers for the C and C++ programming
                   3161: languages.</p></dd>
                   3162: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3163: <dd><p>Contains GNU info files of various
                   3164: packages.</p></dd>
                   3165: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3166: <dd><p>Contains shared and static
                   3167: libraries.</p></dd>
                   3168: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3169: <dd><p>Contains data files that don't change after
                   3170: installation. Other data files belong into
                   3171: <code class="filename">${VARBASE}</code>.</p></dd>
                   3172: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3173: <dd><p>Contains programs that are not intended to be used by
                   3174: end users, such as helper programs or network
                   3175: daemons.</p></dd>
                   3176: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3177: <dd><p>Contains programs that are intended to be executed as
                   3178: CGI scripts by a web server.</p></dd>
                   3179: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3180: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3181: <dd><p>Contains brief
                   3182: documentation in form of manual pages.</p></dd>
                   3183: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3184: <dd><p>Contains programs that are intended to be used only by
                   3185: the super-user.</p></dd>
                   3186: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3187: <dd><p>Contains platform-independent data files that don't
                   3188: change after installation.</p></dd>
                   3189: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3190: <dd><p>Contains documentation files provided by the
                   3191: packages.</p></dd>
                   3192: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3193: <dd><p>Contains example files provided by the packages. Among
                   3194: others, the original configuration files are saved here and copied to
                   3195: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3196: installation.</p></dd>
                   3197: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3198: <dd><p>Contains the original files for rc.d
                   3199: scripts.</p></dd>
                   3200: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3201: <code class="filename">${VARBASE}</code>)</span></dt>
                   3202: <dd><p>Contains files
                   3203: that may be modified after
                   3204: installation.</p></dd>
                   3205: </dl></div>
                   3206: </div>
                   3207: <div class="sect1" lang="en">
                   3208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3209: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   3210: </h2></div></div></div>
1.90      rillig   3211: <div class="variablelist"><dl>
                   3212: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3213: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3214: <dd><p>Contains
                   3215: information about the currently installed
                   3216: packages.</p></dd>
                   3217: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3218: <dd><p>Contains highscore
                   3219: files.</p></dd>
                   3220: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3221: <dd><p>Contains log files.</p></dd>
                   3222: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3223: <dd><p>Contains informational files about daemons that are
                   3224: currently running.</p></dd>
                   3225: </dl></div>
                   3226: </div>
                   3227: </div>
                   3228: <div class="chapter" lang="en">
                   3229: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3230: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3231: <div class="toc">
                   3232: <p><b>Table of Contents</b></p>
                   3233: <dl>
1.106     rillig   3234: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3235: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3236: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3237: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3238: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3239: <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>
                   3240: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.116     rillig   3241: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.106     rillig   3242: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.116     rillig   3243: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
                   3244: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
                   3245: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.106     rillig   3246: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3247: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3248: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.116     rillig   3249: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106     rillig   3250: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.116     rillig   3251: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.75      rillig   3252: </dl>
                   3253: </div>
                   3254: <p>This section contains hints, tips &amp; tricks on special things in
                   3255: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3256: it contains items for both pkgsrc users and developers.</p>
                   3257: <div class="sect1" lang="en">
                   3258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3259: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3260: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3261: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  3262: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   3263:          This is a general purpose list for most issues regarding
                   3264:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3265:          for pkgsrc configuration, unexpected build failures, using
                   3266:          particular packages, upgrading pkgsrc installations,
                   3267:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3268:          proposals for changes that impact the pkgsrc user community,
                   3269:          e.g. major infrastructure changes, new features, package
                   3270:          removals, etc., may also be posted.</p></li>
1.110     hubertf  3271: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   3272:          A list where the results of pkgsrc bulk builds are sent and
                   3273:          discussed.</p></li>
1.110     hubertf  3274: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   3275:          This list is for those who are interested in getting a
                   3276:          commit message for every change committed to pkgsrc. It is
                   3277:          also available in digest form, meaning one daily message
                   3278:          containing all commit messages for changes to the package
                   3279:          source tree in that 24 hour period.</p></li>
                   3280: </ul></div>
                   3281: <p>To subscribe, do:</p>
                   3282: <pre class="programlisting">
1.100     rillig   3283: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   3284: </pre>
                   3285: <p>Archives for all these mailing lists are available from
1.110     hubertf  3286: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   3287: </div>
                   3288: <div class="sect1" lang="en">
                   3289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3290: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3291: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3292: pkgviews User's guide in
1.76      rillig   3293: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3294: </div>
                   3295: <div class="sect1" lang="en">
                   3296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3297: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3298: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3299: a number of useful utilities for both users and developers of pkgsrc.  This
                   3300: section attempts only to make the reader aware of the utilities and when
                   3301: they might be useful, and not to duplicate the documentation that comes
                   3302: with each package.</p>
                   3303: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91      rillig   3304: <div class="itemizedlist"><ul type="disc"><li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   3305:       Symlinks for use by buildlink.</p></li></ul></div>
                   3306: <p>OS tool augmentation (automatically installed when needed):</p>
                   3307: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3308: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75      rillig   3309:       Calculates various kinds of checksums (including SHA1).</p></li>
1.91      rillig   3310: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   3311:       Compatibility library for pkgsrc tools.</p></li>
1.91      rillig   3312: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      3313:       non-BSD systems due to lack of native mtree.</p></li>
1.91      rillig   3314: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   3315:       Up-to-date replacement for
1.76      rillig   3316:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3317:       systems where pkg_install is not present.</p></li>
                   3318: </ul></div>
                   3319: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3320: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3321: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   3322:       Create a binary package from an
1.110     hubertf  3323:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   3324:       save the old package.</p></li>
1.91      rillig   3325: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   3326:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3327:       from multiple locations. It currently supports the following
                   3328:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91      rillig   3329: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
1.75      rillig   3330:       packages someplace else (enabled by default).</p></li>
1.117     jnemeth  3331: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
                   3332:       the best compiler flags to optimise code for your current
                   3333:       CPU and compiler. Setting <code class="varname">USE_CPUFLAGS</code> to
                   3334:       yes in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use
                   3335:       cpuflags. </p></li>
1.75      rillig   3336: </ul></div>
                   3337: <p>Utilities for keeping track of installed packages, being up to date,
                   3338: etc:</p>
                   3339: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3340: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   3341:       packages whose installed versions do not match the latest pkgsrc
                   3342:       entries.</p></li>
1.91      rillig   3343: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   3344:       dependency graphs of packages, to aid in choosing a strategy for
                   3345:       updating.</p></li>
1.91      rillig   3346: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   3347:       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>
                   3348: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   3349:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
                   3350: <li><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.75      rillig   3351:       does various checks on the complete pkgsrc system.</p></li>
1.91      rillig   3352: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   3353:       packages you have installed.</p></li>
                   3354: </ul></div>
                   3355: <p>Utilities for people maintaining or creating individual packages:</p>
                   3356: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3357: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   3358:       making and maintaining patches for a package (includes pkgdiff,
                   3359:       pkgvi, mkpatches, etc.).</p></li>
1.91      rillig   3360: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
                   3361:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   3362:       converting to pkgsrc.</p></li>
1.91      rillig   3363: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
1.75      rillig   3364:       pkgsrc to a Solaris package.</p></li>
                   3365: </ul></div>
                   3366: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3367: utilities)</p>
                   3368: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3369: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   3370:       packages in a chrooted area.</p></li>
1.91      rillig   3371: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   3372:       kernel version for chrooted cross builds.</p></li>
                   3373: </ul></div>
                   3374: </div>
                   3375: <div class="sect1" lang="en">
                   3376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3377: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3378: <p>If you want to use pkgsrc as non-root user, you can set some
                   3379: variables to make pkgsrc work under these conditions.  At the very least,
                   3380: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3381: will turn on unprivileged mode and set multiple related variables to allow
                   3382: installation of packages as non-root.</p>
                   3383: <p>In case the defaults are not enough, you may want to tune some other
                   3384: variables used.  For example, if the automatic user/group detection leads
                   3385: to incorrect values (or not the ones you would like to use), you can change
                   3386: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3387: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3388: <p>As regards bootstrapping, please note that the
1.110     hubertf  3389: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.75      rillig   3390: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
1.76      rillig   3391: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3392: installation targets.  These directories can be overridden by the
1.75      rillig   3393: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3394: that allow finer tuning of the tree layout.</p>
                   3395: </div>
                   3396: <div class="sect1" lang="en">
                   3397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3398: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3399: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3400: enable this feature by adding the option
                   3401: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  3402: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   3403: distfile is found, pkgsrc will try to resume it.</p>
                   3404: <p>You can also
1.110     hubertf  3405: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.117     jnemeth  3406: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3407: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3408: by using the value manual.  A value of custom disables the system defaults
                   3409: and dependency tracking for the fetch program.  In that case you have to
                   3410: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3411: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3412: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   3413: <p>For example, if you want to use
1.117     jnemeth  3414: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   3415: like:</p>
                   3416: <pre class="programlisting">
1.117     jnemeth  3417: FETCH_USING=   wget
1.1       grant    3418: </pre>
1.75      rillig   3419: </div>
                   3420: <div class="sect1" lang="en">
                   3421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3422: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      3423: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3424: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3425: you will have to add the following line into
1.110     hubertf  3426: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3427: <pre class="programlisting">
1.103     wiz      3428: X11_TYPE=modular
1.1       grant    3429: </pre>
1.75      rillig   3430: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3431: <h3 class="title">Note</h3>
1.103     wiz      3432: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3433: </p>
1.75      rillig   3434: </div>
                   3435: </div>
                   3436: <div class="sect1" lang="en">
                   3437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3438: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3439: <p>If you are sitting behind a firewall which does not allow direct
                   3440: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3441: relevant proxy hosts.  This is done using an environment variable in the
                   3442: form of a URL, e.g. in Amdahl, the machine
                   3443: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3444: port 80 as the proxy port number.  So the proxy environment variables
                   3445: are:</p>
                   3446: <pre class="programlisting">
1.100     rillig   3447: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3448: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3449: </pre>
1.75      rillig   3450: </div>
                   3451: <div class="sect1" lang="en">
                   3452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  3453: <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.75      rillig   3454: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3455: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3456: the first available command from the following list:</p>
                   3457: <div class="itemizedlist"><ul type="disc">
1.76      rillig   3458: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3459: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3460: </ul></div>
                   3461: <p>On a default NetBSD installation, this will be
1.76      rillig   3462: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3463: connections first, and falls back to active connections if the server
                   3464: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3465: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3466: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3467: <p>Having that option present will prevent
1.76      rillig   3468: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3469: transfers.</p>
                   3470: </div>
                   3471: <div class="sect1" lang="en">
                   3472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3473: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3474: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3475: from work or university, where you can't run a <span class="command"><strong>make
                   3476: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   3477: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3478: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3479: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3480: resulting list to your machine at work/school and use it there.  If you
1.110     hubertf  3481: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   3482: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3483: URL:</p>
                   3484: <p>At home:</p>
                   3485: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3486: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3487: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3488: <p>At work:</p>
                   3489: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3490: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3491: home.</p>
                   3492: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3493: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3494: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3495: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3496: directly by running:</p>
1.75      rillig   3497: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3498: <p>If you even decide to ignore
                   3499: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3500: by running:</p>
                   3501: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3502: </div>
                   3503: <div class="sect1" lang="en">
                   3504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3505: <a name="tmac.andoc-missing"></a>9.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3506: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
1.91      rillig   3507: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   3508: package, you get the error from make that it doesn't know how to make
1.76      rillig   3509: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75      rillig   3510: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3511: the NetBSD base distribution on your machine.  It is recommended to do
                   3512: that to format man pages.</p>
1.91      rillig   3513: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   3514: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3515: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3516: </div>
                   3517: <div class="sect1" lang="en">
                   3518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3519: <a name="bsd.own.mk-missing"></a>9.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</h2></div></div></div>
1.87      wiz      3520: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3521: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3522: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3523: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3524: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3525: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3526: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3527: -r</strong></span>).</p>
                   3528: </div>
                   3529: <div class="sect1" lang="en">
                   3530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3531: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3532: <p>When installing packages as non-root user and using the just-in-time
1.110     hubertf  3533: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   3534: password for each required package installed.  To avoid this, the sudo
                   3535: package can be used, which does password caching over a limited time.  To
                   3536: use it, install sudo (either as binary package or from
1.98      wiz      3537: <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.110     hubertf  3538: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3539: <span class="emphasis"><em>after</em></span> the definition of the
                   3540: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3541: <pre class="programlisting">
1.100     rillig   3542: .if exists(${LOCALBASE}/bin/sudo)
                   3543: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3544: .endif
1.1       grant    3545: </pre>
1.75      rillig   3546: </div>
                   3547: <div class="sect1" lang="en">
                   3548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3549: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3550: <p>As the system administrator, you can choose where configuration files
                   3551: are installed.  The default settings make all these files go into
1.76      rillig   3552: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3553: be suboptimal depending on your expectations (e.g., a read-only,
                   3554: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3555: configuration of the provided packages).</p>
                   3556: <p>In order to change the defaults, you can modify the
                   3557: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3558: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3559: directory; some common examples include <code class="filename">/etc</code> or
                   3560: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3561: <p>Furthermore, you can change this value on a per-package basis by
                   3562: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3563: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3564: package you would like to modify, that is, the contents of
                   3565: <code class="varname">PKGBASE</code>.</p>
                   3566: <p>Note that after changing these settings, you must rebuild and
                   3567: reinstall any affected packages.</p>
                   3568: </div>
                   3569: <div class="sect1" lang="en">
                   3570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3571: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   3572: <p>Please be aware that there can often be bugs in third-party software,
                   3573: and some of these bugs can leave a machine vulnerable to exploitation by
                   3574: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3575: maintains a database of known-exploits to packages which have at one time
                   3576: been included in pkgsrc.  The database can be downloaded automatically, and
                   3577: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3578: do this, refer to the following two tools (installed as part of the
                   3579: <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.75      rillig   3580: <div class="orderedlist"><ol type="1">
                   3581: <li>
1.110     hubertf  3582: <p><span class="command"><strong>download-vulnerability-list</strong></span>, an easy way to
1.75      rillig   3583:     download a list of the security vulnerabilities information.  This list
                   3584:     is kept up to date by the NetBSD security officer and the NetBSD
                   3585:     packages team, and is distributed from the NetBSD ftp server:</p>
1.110     hubertf  3586: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
1.75      rillig   3587: </li>
1.110     hubertf  3588: <li><p><span class="command"><strong>audit-packages</strong></span>, an easy way to audit the
1.75      rillig   3589:     current machine, checking each vulnerability which is known.  If a
                   3590:     vulnerable package is installed, it will be shown by output to stdout,
                   3591:     including a description of the type of vulnerability, and a URL
                   3592:     containing more information.</p></li>
                   3593: </ol></div>
1.114     jmcneill 3594: <p>Use of these tools is strongly recommended!  After
                   3595: &#8220;<span class="quote">pkg_install</span>&#8221; is installed, please read
1.75      rillig   3596: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114     jmcneill 3597: pkg_install</code></strong>.</p>
1.87      wiz      3598: <p>If this package is installed, pkgsrc builds will use it to
1.110     hubertf  3599: 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.87      wiz      3600: check.</p>
1.75      rillig   3601: </div>
                   3602: <div class="sect1" lang="en">
                   3603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3604: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3605: <p>When you add your own preferences to the
                   3606:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3607:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3608:        environment variables to the <code class="filename">./configure</code>
1.110     hubertf  3609:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3610:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3611:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3612:        package.</p>
                   3613: <p>Currently there is no solution to this problem. If you
                   3614:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3615:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3616:        directory and then inspect any <code class="filename">Makefile</code> and
                   3617:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3618:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3619:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3620:        programmers write so bad code that it only works for the
                   3621:        specific combination of <code class="varname">CFLAGS</code> they have
                   3622:        chosen.</p>
                   3623: </div>
1.80      rillig   3624: <div class="sect1" lang="en">
                   3625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3626: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.80      rillig   3627: <div class="procedure"><ol type="1">
                   3628: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3629:        case that occurs often is that people only update pkgsrc in
                   3630:        parts, because of performance reasons. Since pkgsrc is one large
                   3631:        system, not a collection of many small systems, there are
                   3632:        sometimes changes that only work when the whole pkgsrc tree is
                   3633:        updated.</p></li>
                   3634: <li><p>Make sure that you don't have any CVS conflicts.
                   3635:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3636:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3637:        files.</p></li>
                   3638: <li><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3639:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3640:        verify this.</p></li>
                   3641: <li><p>If the problem still exists, write a mail to the
                   3642:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3643: </ol></div>
                   3644: </div>
1.88      wiz      3645: <div class="sect1" lang="en">
                   3646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3647: <a name="faq.rcs-conflicts"></a>9.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</h2></div></div></div>
1.89      rillig   3648: <p>You have modified a file from pkgsrc, and someone else has
                   3649: modified that same file afterwards in the CVS repository. Both changes
                   3650: are in the same region of the file, so when you updated pkgsrc, the
                   3651: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3652: file. Because of these markers, the file is no longer a valid
                   3653: <code class="filename">Makefile</code>.</p>
                   3654: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3655: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3656: -dP</strong></span> in that directory to download the current version.</p>
                   3657: </div>
1.75      rillig   3658: </div>
                   3659: </div>
                   3660: <div class="part" lang="en">
                   3661: <div class="titlepage"><div><div><h1 class="title">
                   3662: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77      rillig   3663: <div class="partintro" lang="en">
                   3664: <div></div>
                   3665: <p>This part of the book deals with creating and
                   3666:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3667:        guide on creating a new package. The remaining chapters are more
                   3668:        like a reference manual for pkgsrc.</p>
1.75      rillig   3669: <div class="toc">
                   3670: <p><b>Table of Contents</b></p>
                   3671: <dl>
1.106     rillig   3672: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3673: <dd><dl>
1.106     rillig   3674: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3675: <dd><dl>
1.106     rillig   3676: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3677: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil     3678: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3679: </dl></dd>
1.106     rillig   3680: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3681: <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>
                   3682: </dl></dd>
                   3683: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3684: <dd><dl>
1.116     rillig   3685: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
                   3686: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106     rillig   3687: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3688: <dd><dl>
                   3689: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3690: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3691: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3692: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3693: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3694: </dl></dd>
                   3695: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3696: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3697: <dd><dl>
                   3698: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3699: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3700: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3701: </dl></dd>
1.116     rillig   3702: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
                   3703: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106     rillig   3704: </dl></dd>
1.116     rillig   3705: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106     rillig   3706: <dd><dl>
                   3707: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.116     rillig   3708: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106     rillig   3709: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3710: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3711: <dd><dl>
                   3712: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3713: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3714: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3715: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3716: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3717: </dl></dd>
                   3718: </dl></dd>
                   3719: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3720: <dd><dl>
                   3721: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.116     rillig   3722: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
                   3723: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106     rillig   3724: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3725: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.116     rillig   3726: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106     rillig   3727: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3728: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3729: </dl></dd>
                   3730: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3731: <dd><dl>
                   3732: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.116     rillig   3733: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106     rillig   3734: <dd><dl>
                   3735: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.116     rillig   3736: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.106     rillig   3737: </dl></dd>
1.116     rillig   3738: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106     rillig   3739: <dd><dl>
1.116     rillig   3740: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106     rillig   3741: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3742: </dl></dd>
                   3743: </dl></dd>
                   3744: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3745: <dd><dl>
                   3746: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3747: <dd><dl>
                   3748: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3749: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3750: </dl></dd>
                   3751: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3752: <dd><dl>
1.116     rillig   3753: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106     rillig   3754: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3755: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3756: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3757: </dl></dd>
                   3758: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3759: <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>
                   3760: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3761: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3762: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3763: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3764: <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>
                   3765: </dl></dd>
                   3766: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3767: <dd><dl>
                   3768: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.116     rillig   3769: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106     rillig   3770: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   3771: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3772: </dl></dd>
                   3773: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3774: <dd><dl>
                   3775: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3776: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3777: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3778: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.116     rillig   3779: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106     rillig   3780: <dd><dl>
                   3781: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3782: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3783: </dl></dd>
1.116     rillig   3784: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
                   3785: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
                   3786: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
                   3787: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
                   3788: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
                   3789: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
                   3790: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
                   3791: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
                   3792: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
                   3793: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106     rillig   3794: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3795: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3796: </dl></dd>
                   3797: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3798: <dd><dl>
                   3799: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3800: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3801: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3802: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3803: </dl></dd>
                   3804: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3805: <dd><dl>
                   3806: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3807: <dd><dl>
                   3808: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.116     rillig   3809: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106     rillig   3810: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3811: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3812: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3813: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3814: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3815: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3816: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3817: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3818: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3819: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3820: </dl></dd>
1.116     rillig   3821: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106     rillig   3822: <dd><dl>
                   3823: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3824: <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>
                   3825: </dl></dd>
1.116     rillig   3826: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106     rillig   3827: <dd><dl>
                   3828: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3829: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3830: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3831: </dl></dd>
                   3832: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3833: <dd><dl>
                   3834: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3835: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3836: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   3837: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   3838: </dl></dd>
1.116     rillig   3839: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106     rillig   3840: <dd><dl>
                   3841: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3842: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.116     rillig   3843: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106     rillig   3844: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3845: </dl></dd>
1.116     rillig   3846: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106     rillig   3847: <dd><dl>
                   3848: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3849: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3850: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3851: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3852: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3853: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3854: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3855: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   3856: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119   ! mishka   3857: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   3858: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3859: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3860: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3861: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3862: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3863: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3864: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3865: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      3866:     emulation</a></span></dt>
1.106     rillig   3867: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3868: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3869: </dl></dd>
1.106     rillig   3870: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3871: </dl></dd>
1.106     rillig   3872: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3873: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   3874: <dd><dl>
1.106     rillig   3875: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3876: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3877: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3878: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   3879: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   3880: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
                   3881: </dl></dd>
                   3882: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3883: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3884: <dd><dl>
                   3885: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3886: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3887: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3888: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     3889: </dl></dd>
1.75      rillig   3890: </dl>
                   3891: </div>
1.77      rillig   3892: </div>
                   3893: <div class="chapter" lang="en">
                   3894: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3895: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3896: <div class="toc">
                   3897: <p><b>Table of Contents</b></p>
                   3898: <dl>
1.106     rillig   3899: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3900: <dd><dl>
1.106     rillig   3901: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3902: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil     3903: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3904: </dl></dd>
1.106     rillig   3905: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3906: <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.91      rillig   3907: </dl>
                   3908: </div>
1.77      rillig   3909: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3910: most likely have a URL from where you can download the source
                   3911: code. Starting with this URL, creating a package involves only a
                   3912: few steps.</p>
1.77      rillig   3913: <div class="procedure"><ol type="1">
1.91      rillig   3914: <li><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.77      rillig   3915: <li><p>Then, choose one of the top-level directories as the
1.91      rillig   3916: category in which you want to place your package. You can also create a
                   3917: directory of your own (maybe called <code class="filename">local</code>). In that
                   3918: category directory, create another directory for your package and change
                   3919: into it.</p></li>
1.110     hubertf  3920: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3921: you for a URL. Enter the URL of the distribution file (in most cases a
                   3922: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3923: of your package are created automatically. The distribution file is
                   3924: extracted automatically to fill in some details in the
                   3925: <code class="filename">Makefile</code> that would otherwise have to be done
                   3926: manually.</p></li>
                   3927: <li>
                   3928: <p>Examine the extracted files to determine the dependencies of
                   3929: your package. Ideally, this is mentioned in some
                   3930: <code class="filename">README</code> file, but things may differ. For each of
                   3931: these dependencies, look where it exists in pkgsrc, and if there is a
                   3932: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3933: line to your package <code class="filename">Makefile</code> which includes that
                   3934: file just before the last line. If the
                   3935: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3936: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3937: version of the dependency and where it can be found in pkgsrc. This line
                   3938: should be placed in the third paragraph. If the dependency is only
                   3939: needed for building the package, but not when using it, use
                   3940: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3941: Your package may then look like this:</p>
1.77      rillig   3942: <pre class="programlisting">
1.100     rillig   3943: [...]
1.77      rillig   3944: 
1.100     rillig   3945: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3946: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3947: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3948: 
1.100     rillig   3949: [...]
1.77      rillig   3950: 
1.100     rillig   3951: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3952: .include "../../devel/glib2/buildlink3.mk"
                   3953: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3954: </pre>
                   3955: </li>
1.110     hubertf  3956: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.91      rillig   3957: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
1.110     hubertf  3958: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3959: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3960: -e</strong></span>, which outputs additional
                   3961: explanations.</p></li>
                   3962: <li><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3963: 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.91      rillig   3964: over there, you can hopefully continue here.</p></li>
1.110     hubertf  3965: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3966: directory from the extracted files. Besides these files, a lot of cache
                   3967: files and other system information has been saved in the working
                   3968: directory, which may become wrong after you edited the
                   3969: <code class="filename">Makefile</code>.</p></li>
1.110     hubertf  3970: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   3971: 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.91      rillig   3972: <li><p>When the package builds fine, the next step is to install
1.110     hubertf  3973: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3974: everything works.</p></li>
                   3975: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3976: contains a list of the files that are installed by the package, is
1.110     hubertf  3977: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3978: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3979: the file using your preferred text editor to see if the list of
                   3980: files looks plausible.</p></li>
1.110     hubertf  3981: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3982: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.110     hubertf  3983: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3984: has been registered in the database of installed files, but with an
1.110     hubertf  3985: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3986: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3987: registered with the list of files from
                   3988: <code class="filename">PLIST</code>.</p></li>
1.110     hubertf  3989: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3990: package from the set of installed files.</p></li>
1.77      rillig   3991: </ol></div>
1.91      rillig   3992: <div class="sect1" lang="en">
                   3993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3994: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.91      rillig   3995: <div class="sect2" lang="en">
                   3996: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3997: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3998: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3999: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   4000: </div>
                   4001: <div class="sect2" lang="en">
                   4002: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4003: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91      rillig   4004: <p>KDE applications should always include
                   4005: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   4006: settings that are typical of KDE packages.</p>
                   4007: </div>
1.118     imil     4008: <div class="sect2" lang="en">
                   4009: <div class="titlepage"><div><div><h3 class="title">
                   4010: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   4011: <p>Python modules and programs packages are easily created using a
                   4012: set of predefined variables.</p>
                   4013: <p>Most Python packages use either &#8220;<span class="quote">distutils</span>&#8221; or
                   4014: easy-setup (&#8220;<span class="quote">eggs</span>&#8221;).
                   4015: If the software uses &#8220;<span class="quote">distutils</span>&#8221;, set the
                   4016: <code class="varname">PYDISTUTILSPKG</code> variable to &#8220;<span class="quote">yes</span>&#8221; so
                   4017: pkgsrc will make use of this framework.
                   4018: &#8220;<span class="quote">distutils</span>&#8221; uses a script called <code class="filename">setup.py</code>,
                   4019: if the &#8220;<span class="quote">distutils</span>&#8221; driver is not called
                   4020: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   4021: to the name of the script.</p>
                   4022: <p>
                   4023: If the default Python versions are not supported by the software, set the
                   4024: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
                   4025: the software is known to work with, from the most recent to the older
                   4026: one, e.g.
                   4027: </p>
                   4028: <pre class="programlisting">
                   4029: PYTHON_VERSIONS_ACCEPTED=       25 24 23
                   4030: </pre>
                   4031: <p>
                   4032: If the packaged software is a Python module, include
                   4033: &#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;.
                   4034: In this case, the package directory should be called
                   4035: &#8220;<span class="quote">py-software</span>&#8221; and <code class="varname">PKGNAME</code> should be set to
                   4036: &#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;, e.g.
                   4037: </p>
                   4038: <pre class="programlisting">
                   4039: DISTNAME=   foopymodule-1.2.10
                   4040: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   4041: </pre>
                   4042: <p>If it is an application, also include
                   4043: &#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;
                   4044: before &#8220;<span class="quote">extension.mk</span>&#8221;.</p>
                   4045: <p>If the packaged software, either it is an application or a module, is
                   4046: egg-aware, you only need to include
                   4047: &#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;.</p>
                   4048: <p>In order to correctly set the path to the Python interpreter, use the
                   4049: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   4050: that must be corrected. For example :
                   4051: </p>
                   4052: <pre class="programlisting">
                   4053: REPLACE_PYTHON=   ${WRKSRC}/*.py
                   4054: </pre>
                   4055: </div>
1.91      rillig   4056: </div>
                   4057: <div class="sect1" lang="en">
                   4058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4059: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.91      rillig   4060: <div class="sect2" lang="en">
                   4061: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4062: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.91      rillig   4063: <div class="sect3" lang="en">
                   4064: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4065: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   4066: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   4067: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   4068: pkgsrc. As the description says it has to do with the web, the obvious
                   4069: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   4070: <pre class="programlisting">
1.100     rillig   4071: <code class="prompt">$</code> mkdir www/nvu
                   4072: <code class="prompt">$</code> cd www/nvu
1.91      rillig   4073: </pre>
                   4074: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  4075: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   4076: <pre class="programlisting">
1.100     rillig   4077: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   4078: </pre>
                   4079: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4080: below the <code class="varname">DISTNAME</code> line, as the package name should
                   4081: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   4082: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4083: <code class="varname">COMMENT</code> fields. Then the package
                   4084: <code class="filename">Makefile</code> looked like that:</p>
                   4085: <pre class="programlisting">
1.100     rillig   4086: # $NetBSD$
                   4087: #
1.91      rillig   4088: 
1.100     rillig   4089: DISTNAME=       nvu-1.0-sources
                   4090: PKGNAME=        nvu-1.0
                   4091: CATEGORIES=     www
                   4092: MASTER_SITES=   http://cvs.nvu.com/download/
                   4093: EXTRACT_SUFX=   .tar.bz2
                   4094: 
                   4095: MAINTAINER=     rillig@NetBSD.org
                   4096: HOMEPAGE=       http://cvs.nvu.com/
                   4097: COMMENT=        Web Authoring System
1.91      rillig   4098: 
1.100     rillig   4099: # url2pkg-marker (please do not remove this line.)
                   4100: .include "../../mk/bsd.pkg.mk"
1.91      rillig   4101: </pre>
                   4102: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4103: source archive:</p>
                   4104: <pre class="programlisting">
1.100     rillig   4105: url2pkg&gt; Running "make makesum" ...
                   4106: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4107: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4108: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4109: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4110: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4111: url2pkg&gt; Running "make extract" ...
                   4112: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4113: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4114: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4115: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4116: ===&gt; Installing dependencies for nvu-1.0
                   4117: ===&gt; Overriding tools for nvu-1.0
                   4118: ===&gt; Extracting for nvu-1.0
                   4119: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   4120: 
1.100     rillig   4121: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   4122: 
1.100     rillig   4123: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   4124: </pre>
                   4125: </div>
                   4126: <div class="sect3" lang="en">
                   4127: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4128: <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.91      rillig   4129: <p>Now that the package has been extracted, let's see what's inside
                   4130: it. The package has a <code class="filename">README.txt</code>, but that only
                   4131: says something about mozilla, so it's probably useless for seeing what
                   4132: dependencies this package has. But since there is a GNU configure script
                   4133: in the package, let's hope that it will complain about everything it
                   4134: needs.</p>
                   4135: <pre class="programlisting">
1.100     rillig   4136: <code class="prompt">$</code> bmake
                   4137: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4138: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4139: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4140: ===&gt; Patching for nvu-1.0
                   4141: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4142: ===&gt; Configuring for nvu-1.0
                   4143: [...]
                   4144: configure: error: Perl 5.004 or higher is required.
                   4145: [...]
                   4146: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4147: [...]
1.91      rillig   4148: </pre>
                   4149: <p>That worked quite well. So I opened the package Makefile in my
                   4150: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4151: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4152: package have changed now, and since a perl wrapper is automatically
                   4153: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4154: from scratch.</p>
                   4155: <pre class="programlisting">
1.100     rillig   4156: <code class="prompt">$</code> bmake clean
                   4157: ===&gt; Cleaning for nvu-1.0
                   4158: <code class="prompt">$</code> bmake
                   4159: [...]
                   4160: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4161: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4162: [...]
1.91      rillig   4163: </pre>
                   4164: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4165: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4166: <pre class="programlisting">
1.100     rillig   4167: [...]
                   4168: checking for GTK - version &gt;= 1.2.0... no
                   4169: *** Could not run GTK test program, checking why...
                   4170: [...]
1.91      rillig   4171: </pre>
                   4172: <p>Now to the other dependencies. The first question is: Where is the
                   4173: GTK package hidden in pkgsrc?</p>
                   4174: <pre class="programlisting">
1.100     rillig   4175: <code class="prompt">$</code> echo ../../*/gtk*
                   4176: [many packages ...]
                   4177: <code class="prompt">$</code> echo ../../*/gtk
                   4178: ../../x11/gtk
                   4179: <code class="prompt">$</code> echo ../../*/gtk2
                   4180: ../../x11/gtk2
                   4181: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4182: ../../x11/gtk2/buildlink3.mk
1.91      rillig   4183: </pre>
                   4184: <p>The first try was definitely too broad. The second one had exactly
                   4185: one result, which is very good. But there is one pitfall with GNOME
                   4186: packages. Before GNOME 2 had been released, there were already many
                   4187: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4188: packages, the GNOME 2 packages were imported as separate packages, and
                   4189: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4190: whether this was the case here, and indeed it was.</p>
                   4191: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4192: file, adding the dependency is very easy. I just inserted an
                   4193: <code class="literal">.include</code> line before the last line of the package
                   4194: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4195: <pre class="programlisting">
1.100     rillig   4196: [...]
                   4197: .include "../../x11/gtk2/buildlink3.mk"
                   4198: .include "../../mk/bsd.pkg.mk
1.91      rillig   4199: </pre>
1.110     hubertf  4200: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   4201: was:</p>
                   4202: <pre class="programlisting">
1.100     rillig   4203: [...]
                   4204: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4205: checking for GTK - version &gt;= 1.2.0... no
                   4206: *** Could not run GTK test program, checking why...
                   4207: *** The test program failed to compile or link. See the file config.log for the
                   4208: *** exact error that occured. This usually means GTK was incorrectly installed
                   4209: *** or that you have moved GTK since it was installed. In the latter case, you
                   4210: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4211: configure: error: Test for GTK failed.
                   4212: [...]
1.91      rillig   4213: </pre>
                   4214: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4215: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4216: told me that this package really wanted to have the GNOME 1 version of
                   4217: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  4218: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   4219: So I changed the <code class="literal">x11/gtk2</code> to
                   4220: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4221: and tried again.</p>
                   4222: <pre class="programlisting">
1.100     rillig   4223: [...]
                   4224: 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
                   4225: In file included from xpidl.c:42:
                   4226: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4227: In file included from xpidl.c:42:
                   4228: xpidl.h:132: error: parse error before "IDL_ns"
                   4229: [...]
1.91      rillig   4230: </pre>
                   4231: <p>The package still does not find all of its dependencies. Now the
                   4232: question is: Which package provides the
                   4233: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4234: <pre class="programlisting">
1.100     rillig   4235: <code class="prompt">$</code> echo ../../*/*idl*
                   4236: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4237: <code class="prompt">$</code> echo ../../*/*IDL*
                   4238: ../../net/libIDL
1.91      rillig   4239: </pre>
                   4240: <p>Let's take the one from the second try. So I included the
                   4241: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4242: again. But the error didn't change. After digging through some of the
                   4243: code, I concluded that the build process of the package was broken and
                   4244: couldn't have ever worked, but since the Mozilla source tree is quite
                   4245: large, I didn't want to fix it. So I added the following to the package
                   4246: <code class="filename">Makefile</code> and tried again:</p>
                   4247: <pre class="programlisting">
1.100     rillig   4248: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4249: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   4250: </pre>
                   4251: <p>The latter line is needed because the package expects the library
                   4252: <code class="filename">libIDL.so</code>, but only
                   4253: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4254: wrapper to rewrite that on the fly.</p>
                   4255: <p>The next problem was related to a recent change of the FreeType
                   4256: 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>
                   4257: which patch files were relevant for this issue and copied them to the
                   4258: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4259: patches so that they applied cleanly and retried again. This time,
                   4260: everything worked.</p>
                   4261: </div>
                   4262: <div class="sect3" lang="en">
                   4263: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4264: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   4265: <pre class="programlisting">
1.100     rillig   4266: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4267: [...]
                   4268: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4269: <code class="prompt">$</code> bmake deinstall
                   4270: <code class="prompt">$</code> bmake install
1.91      rillig   4271: </pre>
                   4272: </div>
                   4273: </div>
                   4274: </div>
1.77      rillig   4275: </div>
1.75      rillig   4276: <div class="chapter" lang="en">
                   4277: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4278: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4279: <div class="toc">
                   4280: <p><b>Table of Contents</b></p>
                   4281: <dl>
1.116     rillig   4282: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
                   4283: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106     rillig   4284: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4285: <dd><dl>
                   4286: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4287: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4288: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4289: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4290: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4291: </dl></dd>
                   4292: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4293: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4294: <dd><dl>
                   4295: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4296: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4297: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4298: </dl></dd>
1.116     rillig   4299: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
                   4300: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.75      rillig   4301: </dl>
                   4302: </div>
1.87      wiz      4303: <p>Whenever you're preparing a package, there are a number of
                   4304: files involved which are described in the following
                   4305: sections.</p>
1.75      rillig   4306: <div class="sect1" lang="en">
                   4307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4308: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   4309: </h2></div></div></div>
1.75      rillig   4310: <p>Building, installation and creation of a binary package are all
1.87      wiz      4311:   controlled by the package's <code class="filename">Makefile</code>.
                   4312:   The <code class="filename">Makefile</code> describes various things about
                   4313:   a package, for example from where to get it, how to configure,
                   4314:   build, and install it.</p>
1.76      rillig   4315: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4316:   sections that describe the package.</p>
1.75      rillig   4317: <p>In the first section there are the following variables, which
1.87      wiz      4318:   should appear exactly in the order given here.  The order and
                   4319:   grouping of the variables is mostly historical and has no further
                   4320:   meaning.</p>
1.75      rillig   4321: <div class="itemizedlist"><ul type="disc">
                   4322: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4323:     distribution file to be downloaded from the package's
                   4324:     website.</p></li>
1.75      rillig   4325: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4326:     package, as used by pkgsrc. You only need to provide it if
                   4327:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4328:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4329:     directory name together with the version number. It must match the
                   4330:     regular expression
                   4331:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4332:     starts with a letter or digit, and contains only letters, digits,
                   4333:     dashes, underscores, dots and plus signs.</p></li>
                   4334: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4335:     the package file to create if the <code class="varname">PKGNAME</code>
                   4336:     isn't unique on a SVR4 system. The default is
                   4337:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4338:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
1.87      wiz      4339:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4340:     does not produce an unique package name on a SVR4 system.
                   4341:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4342:     characters.</p></li>
1.75      rillig   4343: <li>
                   4344: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4345:     which the package fits in. You can choose any of the top-level
                   4346:     directories of pkgsrc for it.</p>
1.75      rillig   4347: <p>Currently the following values are available for
1.87      wiz      4348:     <code class="varname">CATEGORIES</code>. If more than
                   4349:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4350: <pre class="programlisting">
1.100     rillig   4351: archivers     cross         geography     meta-pkgs     security
                   4352: audio         databases     graphics      misc          shells
                   4353: benchmarks    devel         ham           multimedia    sysutils
                   4354: biology       editors       inputmethod   net           textproc
                   4355: cad           emulators     lang          news          time
                   4356: chat          finance       mail          parallel      wm
                   4357: comms         fonts         math          pkgtools      www
                   4358: converters    games         mbone         print         x11
                   4359: </pre>
1.75      rillig   4360: </li>
1.81      rillig   4361: <li><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4362:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4363:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4364:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.116     rillig   4365:     <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, &#8220;The fetch phase&#8221;</a>.</p></li>
1.75      rillig   4366: </ul></div>
                   4367: <p>The second section contains information about separately
1.87      wiz      4368:   downloaded patches, if any.
                   4369:   </p>
1.75      rillig   4370: <div class="itemizedlist"><ul type="disc">
                   4371: <li><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4372:     Name(s) of additional files that contain distribution patches.
                   4373:     There is no default. pkgsrc will look for them at
                   4374:     <code class="varname">PATCH_SITES</code>.
                   4375:     They will automatically be uncompressed before patching if
                   4376:     the names end with <code class="filename">.gz</code> or
                   4377:     <code class="filename">.Z</code>.</p></li>
1.75      rillig   4378: <li><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4379:     Primary location(s) for distribution patch files (see
                   4380:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4381: </ul></div>
                   4382: <p>The third section contains the following variables.
1.87      wiz      4383:   </p>
1.75      rillig   4384: <div class="itemizedlist"><ul type="disc">
1.114     jmcneill 4385: <li><p><code class="varname">MAINTAINER</code> is the email
                   4386:     address of the person who feels responsible for this package,
                   4387:     and who is most likely to look at problems or questions regarding
                   4388:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
                   4389:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4390:     before making changes to the package, but are not required to
                   4391:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4392:     to yourself. If you really can't maintain the package for future
                   4393:     updates, set it to
1.110     hubertf  4394:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.114     jmcneill 4395: <li><p><code class="varname">OWNER</code> should be used instead
                   4396:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4397:     developers to update or change the package without contacting
                   4398:     you first. A package Makefile should contain one of
                   4399:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4400:     not both.  </p></li>
1.75      rillig   4401: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4402:     find more information about the package.</p></li>
1.75      rillig   4403: <li><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4404:     description of the package (should not include the package
                   4405:     name).</p></li>
1.75      rillig   4406: </ul></div>
                   4407: <p>Other variables that affect the build:
1.87      wiz      4408:   </p>
1.75      rillig   4409: <div class="itemizedlist"><ul type="disc"><li>
                   4410: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4411:       interesting distribution files of the package are found. The
                   4412:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4413:       works for most packages.</p>
1.75      rillig   4414: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4415:       (most GNU software does, for instance), but extracts itself in
                   4416:       the current directory, you should set
                   4417:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4418: <p>If a package doesn't create a subdirectory with the
                   4419:       name of <code class="varname">DISTNAME</code> but some different name,
                   4420:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4421:       <code class="filename">${WRKDIR}</code>, for example
                   4422:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4423:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75      rillig   4424: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4425:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4426:       variable. By default, its value is
                   4427:       <code class="filename">work</code>. If you want to use the same
                   4428:       pkgsrc tree for building different kinds of binary packages,
                   4429:       you can change the variable according to your needs. Two
                   4430:       other variables handle common cases of setting
                   4431:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4432:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  4433:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      4434:       the host's name is attached to the directory name. If
                   4435:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4436:       is attached, which might look like
                   4437:       <code class="filename">work.i386</code> or
                   4438:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4439: </li></ul></div>
                   4440: <p>Please pay attention to the following gotchas:</p>
                   4441: <div class="itemizedlist"><ul type="disc">
1.87      wiz      4442: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4443:       installed in compressed form by the package.  For packages using
                   4444:       BSD-style makefiles which honor MANZ, there is
                   4445:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76      rillig   4446: <li><p>Replace <code class="filename">/usr/local</code> with
1.88      wiz      4447:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4448:       below).</p></li>
1.110     hubertf  4449: <li><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.75      rillig   4450: </ul></div>
                   4451: </div>
                   4452: <div class="sect1" lang="en">
                   4453: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4454: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   4455: </h2></div></div></div>
1.76      rillig   4456: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4457:   digest, or checksum, of each distfile needed for the package. This
                   4458:   ensures that the distfiles retrieved from the Internet have not been
                   4459:   corrupted during transfer or altered by a malign force to introduce
                   4460:   a security hole. Due to recent rumor about weaknesses of digest
                   4461:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4462:   message digests, as well as the file size.</p>
1.76      rillig   4463: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4464:   checksums for all the patches found in the
1.110     hubertf  4465:   <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.76      rillig   4466: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110     hubertf  4467:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87      wiz      4468:   command.</p>
1.75      rillig   4469: <p>Some packages have different sets of distfiles depending on
1.91      rillig   4470:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
1.87      wiz      4471:   <code class="filename">distinfo</code> file and care should be taken when
                   4472:   upgrading such a package to ensure distfile information is not
                   4473:   lost.</p>
1.75      rillig   4474: </div>
                   4475: <div class="sect1" lang="en">
                   4476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4477: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93      rillig   4478: <p>Many packages still don't work out-of-the box on the various
                   4479:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4480:   patch files are needed to make the package work. These patch files are
                   4481:   found in the <code class="filename">patches/</code> directory.</p>
                   4482: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4483:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.110     hubertf  4484:   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.93      rillig   4485:   order</a>, so <code class="filename">patch-aa</code> is applied before
1.87      wiz      4486:   <code class="filename">patch-ab</code>, etc.</p>
1.93      rillig   4487: <div class="sect2" lang="en">
                   4488: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4489: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4490: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  4491:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4492:   problems. (To force patches to apply with fuzz you can set
                   4493:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4494:   should contain only changes for a single file, and no file should be
1.93      rillig   4495:   patched by more than one patch file. This helps to keep future
                   4496:   modifications simple.</p>
                   4497: <p>Each patch file is structured as follows: In the first line,
                   4498:   there is the RCS Id of the patch itself. The second line should be
                   4499:   empty for aesthetic reasons. After that, there should be a comment for
                   4500:   each change that the patch does. There are a number of standard
                   4501:   cases:</p>
                   4502: <div class="itemizedlist"><ul type="disc">
                   4503: <li><p>Patches that replace the <code class="literal">==</code>
1.110     hubertf  4504:   operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.111     rillig   4505:   are so common that they don't need a comment at all.</p></li>
1.93      rillig   4506: <li><p>Patches for commonly known vulnerabilities should
                   4507:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4508: <li><p>Patches that change source code should mention the
                   4509:   platform and other environment (for example, the compiler) that the
                   4510:   patch is needed for.</p></li>
                   4511: </ul></div>
                   4512: <p>In all other cases, the patch should be commented so that any
                   4513:   developer who knows the code of the application can make some use of
                   4514:   the patch. Special care should be taken for the upstream developers,
                   4515:   since we generally want that they accept our patches, so we have less
                   4516:   work in the future.</p>
                   4517: </div>
                   4518: <div class="sect2" lang="en">
                   4519: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4520: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   4521: <p>One important thing to mention is to pay attention that no RCS
                   4522:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4523:   later checked into the NetBSD CVS tree. Use the
1.110     hubertf  4524:   <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.93      rillig   4525:   problems.</p>
1.87      wiz      4526: <p>For even more automation, we recommend using
1.110     hubertf  4527:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      4528:   whole set of patches. You just have to backup files before you
                   4529:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  4530:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4531:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      4532:   you upgrade a package this way, you can easily compare the new
                   4533:   set of patches with the previously existing one with
1.110     hubertf  4534:   <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87      wiz      4535:   or update from the <code class="filename">work/.newpatches</code>
                   4536:   directory to <code class="filename">patches/</code>.</p>
                   4537: <p>When you have finished a package, remember to generate
1.110     hubertf  4538:   the checksums for the patch files by using the <span class="command"><strong>make
1.116     rillig   4539:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, &#8220;distinfo&#8221;</a>.</p>
1.87      wiz      4540: <p>When adding a patch that corrects a problem in the
                   4541:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4542:   man pages should go), send the patch as a bug report to the
                   4543:   maintainer.  This benefits non-pkgsrc users of the package,
                   4544:   and usually makes it possible to remove the patch in future
                   4545:   version.</p>
1.101     rillig   4546: <p>The file names of the patch files are usually of the form
                   4547:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93      rillig   4548: </div>
                   4549: <div class="sect2" lang="en">
                   4550: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4551: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4552: <p>If you want to share patches between multiple packages
                   4553:   in pkgsrc, e.g. because they use the same distfiles, set
                   4554:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4555:   can be found, e.g.:</p>
                   4556: <pre class="programlisting">
1.100     rillig   4557: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4558: </pre>
1.75      rillig   4559: <p>Patch files that are distributed by the author or other
1.87      wiz      4560:     maintainers can be listed in
                   4561:     <code class="varname">PATCHFILES</code>.</p>
                   4562: <p>If it is desired to store any patches that should not be
                   4563:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4564:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4565:     directory tree there is expected to have the same
                   4566:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4567:     patches are expected to be stored inside these dirs (also
                   4568:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4569:     example, if you want to keep a private patch for
                   4570:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4571:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4572:     files in the named directory are expected to be patch files,
                   4573:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4574:     applied</em></span>.</p>
1.93      rillig   4575: </div>
1.85      jmmv     4576: <div class="sect2" lang="en">
                   4577: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4578: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4579: <p>When fixing a portability issue in the code do not use
                   4580:       preprocessor magic to check for the current operating system nor
                   4581:       platform.  Doing so hurts portability to other platforms because
                   4582:       the OS-specific details are not abstracted appropriately.</p>
                   4583: <p>The general rule to follow is: instead of checking for the
                   4584:       operating system the application is being built on, check for the
                   4585:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4586:       instead of assuming that kqueue is available under NetBSD and
                   4587:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.114     jmcneill 4588:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     4589:       yes, this generally involves patching the
1.110     hubertf  4590:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     4591:       that prevents some OSes from adopting interfaces from other OSes
                   4592:       (e.g. Linux implementing kqueue), something that the above checks
                   4593:       cannot take into account.</p>
                   4594: <p>Of course, checking for features generally involves more
                   4595:       work on the developer's side, but the resulting changes are
1.87      wiz      4596:       cleaner and there are chances they will work on many other
1.85      jmmv     4597:       platforms.  Not to mention that there are higher chances of being
                   4598:       later integrated into the mainstream sources.  Remember:
                   4599:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4600: <p>Some typical examples:</p>
                   4601: <div class="table">
1.106     rillig   4602: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91      rillig   4603: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4604: <colgroup>
                   4605: <col>
                   4606: <col>
                   4607: <col>
                   4608: </colgroup>
                   4609: <thead><tr>
                   4610: <th>Where</th>
                   4611: <th>Incorrect</th>
                   4612: <th>Correct</th>
                   4613: </tr></thead>
                   4614: <tbody>
                   4615: <tr>
                   4616: <td>configure script</td>
                   4617: <td>
1.100     rillig   4618: <pre class="programlisting">
                   4619: case ${target_os} in
                   4620: netbsd*) have_kvm=yes ;;
                   4621: *)       have_kvm=no  ;;
                   4622: esac
                   4623: </pre>
1.85      jmmv     4624:              </td>
                   4625: <td>
1.100     rillig   4626: <pre class="programlisting">
                   4627: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4628: </pre>
1.85      jmmv     4629:              </td>
                   4630: </tr>
                   4631: <tr>
                   4632: <td>C source file</td>
                   4633: <td>
1.100     rillig   4634: <pre class="programlisting">
                   4635: #if defined(__NetBSD__)
                   4636: #  include &lt;sys/event.h&gt;
                   4637: #endif
                   4638: </pre>
1.85      jmmv     4639:              </td>
                   4640: <td>
1.100     rillig   4641: <pre class="programlisting">
                   4642: #if defined(HAVE_SYS_EVENT_H)
                   4643: #  include &lt;sys/event.h&gt;
                   4644: #endif
                   4645: </pre>
1.85      jmmv     4646:              </td>
                   4647: </tr>
                   4648: <tr>
                   4649: <td>C source file</td>
                   4650: <td>
1.100     rillig   4651: <pre class="programlisting">
                   4652: int
                   4653: monitor_file(...)
                   4654: {
                   4655: #if defined(__NetBSD__)
                   4656:         int fd = kqueue();
                   4657:         ...
                   4658: #else
                   4659:         ...
                   4660: #endif
                   4661: }
                   4662: </pre>
1.85      jmmv     4663:              </td>
                   4664: <td>
1.100     rillig   4665: <pre class="programlisting">
                   4666: int
                   4667: monitor_file(...)
                   4668: {
                   4669: #if defined(HAVE_KQUEUE)
                   4670:         int fd = kqueue();
                   4671:         ...
                   4672: #else
                   4673:        ...
                   4674: #endif
                   4675: }
                   4676: </pre>
1.85      jmmv     4677:              </td>
                   4678: </tr>
                   4679: </tbody>
1.91      rillig   4680: </table></div>
1.85      jmmv     4681: </div>
1.91      rillig   4682: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  4683:       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
                   4684:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     4685:       2</a>).  It summarizes multiple details on how to make
                   4686:       software easier to package; all the suggestions in it were
                   4687:       collected from our experience in pkgsrc work, so they are possibly
                   4688:       helpful when creating patches too.</p>
                   4689: </div>
                   4690: <div class="sect2" lang="en">
                   4691: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4692: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4693: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4694:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4695:       improvements you do to a package to the mainstream developers.
                   4696:       This is the only way to get their attention on portability issues
                   4697:       and to ensure that future versions can be built out-of-the box on
                   4698:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4699:       the fixes straight from the packaged code.</p>
1.93      rillig   4700: <p>This generally involves cleaning up the patches
                   4701:       (because sometimes the patches that are
1.85      jmmv     4702:       added to pkgsrc are quick hacks), filling bug reports in the
                   4703:       appropriate trackers for the projects and working with the
                   4704:       mainstream authors to accept your changes.  It is
                   4705:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4706:       the packages in pkgsrc are kept simple and thus further changes
                   4707:       can be done without much hassle.</p>
                   4708: <p>Support the idea of free software!</p>
                   4709: </div>
1.75      rillig   4710: </div>
                   4711: <div class="sect1" lang="en">
                   4712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4713: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75      rillig   4714: <div class="variablelist"><dl>
1.76      rillig   4715: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4716: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4717:          any credits where they are due.  Please bear in mind that others do not
                   4718:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4719:          will read everything that you write here.</p></dd>
1.76      rillig   4720: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4721: <dd><p>This file governs the files that are installed on your
                   4722:          system: all the binaries, manual pages, etc. There are other
                   4723:          directives which may be entered in this file, to control the
                   4724:          creation and deletion of directories, and the location of
1.110     hubertf  4725:          inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87      wiz      4726:          information.</p></dd>
1.75      rillig   4727: </dl></div>
                   4728: </div>
                   4729: <div class="sect1" lang="en">
                   4730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4731: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.78      rillig   4732: <div class="sect2" lang="en">
                   4733: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4734: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75      rillig   4735: <div class="variablelist"><dl>
1.76      rillig   4736: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110     hubertf  4737: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      4738:            First time after package extraction and before files are
                   4739:            moved in place, the second time after the files to install
                   4740:            are moved in place. This can be used to do any custom
                   4741:            procedures not possible with @exec commands in
1.110     hubertf  4742:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4743:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a 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>.</p></dd>
1.76      rillig   4744: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4745: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4746:            this script's responsibility to clean up any additional messy details
                   4747:            around the package's installation, since all pkg_delete knows is how to
                   4748:            delete the files created in the original distribution.
1.110     hubertf  4749:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4750:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.76      rillig   4751: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4752: <dd>
                   4753: <p>This file is displayed after installation of the package.
1.87      wiz      4754:            Useful for things like legal notices on almost-free
                   4755:            software and hints for updating config files after
                   4756:            installing modules for apache, PHP etc.
                   4757:            Please note that you can modify variables in it easily by using
                   4758:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4759:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4760: <pre class="programlisting">
1.100     rillig   4761: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4762: </pre>
1.75      rillig   4763: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
1.87      wiz      4764:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4765:            performed for <code class="varname">PKGNAME</code>,
                   4766:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4767:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4768:            <code class="varname">X11BASE</code>,
                   4769:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4770:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  4771:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      4772: <p>You can display a different or additional files by
                   4773:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4774:            default is <code class="filename">MESSAGE</code>, if the file
                   4775:            exists.</p>
1.75      rillig   4776: </dd>
1.78      rillig   4777: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4778: <dd><p>FIXME: There is no documentation on the
                   4779:        alternatives framework.</p></dd>
                   4780: </dl></div>
                   4781: </div>
                   4782: <div class="sect2" lang="en">
                   4783: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4784: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78      rillig   4785: <div class="variablelist"><dl>
                   4786: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4787: <dd><p>This file contains arbitrary things that could
                   4788:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4789:        to be used by more than one package. This file should only be
                   4790:        used when the packages that will use the file are known in
                   4791:        advance. For other purposes it is often better to write a
                   4792:        <code class="filename">*.mk</code> file and give it a good name that
                   4793:        describes what it does.</p></dd>
                   4794: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4795: <dd><p>This file contains the dependency information
1.110     hubertf  4796:        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.78      rillig   4797: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4798: <dd><p>This file contains workarounds for compiler bugs
                   4799:        and similar things. It is included automatically by the pkgsrc
                   4800:        infrastructure, so you don't need an extra
                   4801:        <code class="literal">.include</code> line for
                   4802:        it.</p></dd>
                   4803: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4804: <dd><p>This file contains the code for the
1.110     hubertf  4805:        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.78      rillig   4806:        selected by the user. If a package has only one or two options,
                   4807:        it is equally acceptable to put the code directly into the
                   4808:        <code class="filename">Makefile</code>.</p></dd>
                   4809: </dl></div>
                   4810: </div>
                   4811: <div class="sect2" lang="en">
                   4812: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4813: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78      rillig   4814: <div class="variablelist"><dl>
                   4815: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4816: <dd><p>These files do not take place in the creation of
                   4817:        a package and thus are purely informative to the package
                   4818:        developer.</p></dd>
                   4819: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4820: <dd><p>This file contains things that need to be done
                   4821:        to make the package even
                   4822:        better.</p></dd>
1.75      rillig   4823: </dl></div>
                   4824: </div>
1.78      rillig   4825: </div>
1.75      rillig   4826: <div class="sect1" lang="en">
                   4827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4828: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   4829: </h2></div></div></div>
1.110     hubertf  4830: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4831:     unpacked into the directory denoted by
                   4832:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4833:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4834:     directory is also used to keep various timestamp files.
                   4835:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4836:     The default is <code class="filename">${.CURDIR}/work</code>
                   4837:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4838:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4839: </div>
                   4840: <div class="sect1" lang="en">
                   4841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4842: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   4843: </h2></div></div></div>
1.75      rillig   4844: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4845:     to configuration or building, you could place these files here and use
1.110     hubertf  4846:     a <span class="command"><strong>${CP}</strong></span> command in the
1.87      wiz      4847:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4848:     this. Alternatively, you could simply diff the file against
                   4849:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4850:     the creation of this file.</p>
                   4851: <p>If you want to share files in this way with other
                   4852:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4853:     to the other package's <code class="filename">files</code> directory,
                   4854:     e.g.:</p>
                   4855: <pre class="programlisting">
1.100     rillig   4856: FILESDIR=${.CURDIR}/../xemacs/files
                   4857: </pre>
1.75      rillig   4858: </div>
                   4859: </div>
                   4860: <div class="chapter" lang="en">
                   4861: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4862: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4863: <div class="toc">
                   4864: <p><b>Table of Contents</b></p>
                   4865: <dl>
1.106     rillig   4866: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.116     rillig   4867: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106     rillig   4868: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4869: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4870: <dd><dl>
                   4871: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4872: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4873: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4874: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4875: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.75      rillig   4876: </dl></dd>
                   4877: </dl>
                   4878: </div>
1.76      rillig   4879: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4880:   each of which forms a well-defined part of the pkgsrc system. Using
1.110     hubertf  4881:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4882:   like pkgsrc requires some discipline to keep the code correct and
                   4883:   understandable.</p>
1.76      rillig   4884: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4885:   programming are variables (which are actually macros) and shell
                   4886:   commands. Among these shell commands may even be more complex ones
1.110     hubertf  4887:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4888:   as intended it is necessary to quote all variables correctly when they
                   4889:   are used.</p>
                   4890: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4891:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4892:   with them.</p>
                   4893: <div class="sect1" lang="en">
                   4894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4895: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.97      rillig   4896: <div class="itemizedlist"><ul type="disc"><li>
                   4897: <p>When you are creating a file as a
                   4898:     target of a rule, always write the data to a temporary file first
                   4899:     and finally rename that file. Otherwise there might occur an error
                   4900:     in the middle of generating the file, and when the user runs
1.110     hubertf  4901:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97      rillig   4902:     regenerated properly. Example:</p>
                   4903: <pre class="programlisting">
1.100     rillig   4904: wrong:
                   4905:         @echo "line 1" &gt; ${.TARGET}
                   4906:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4907:         @false
                   4908: 
                   4909: correct:
                   4910:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4911:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4912:         @false
                   4913:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4914: </pre>
1.110     hubertf  4915: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4916:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4917:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4918:     correct</strong></span> gives an error message twice, as expected.</p>
1.110     hubertf  4919: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   4920:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4921:     happens when it is interrupted, for example by pressing
                   4922:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110     hubertf  4923:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   4924: </li></ul></div>
                   4925: </div>
                   4926: <div class="sect1" lang="en">
                   4927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4928: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4929: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4930:     can be processed using the five operators ``='', ``+='', ``?='',
1.110     hubertf  4931:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   4932:     page.</p>
                   4933: <p>When a variable's value is parsed from a
1.76      rillig   4934:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4935:     backslash character ``\'' are handled specially. If a backslash is
                   4936:     followed by a newline, any whitespace immediately in front of the
                   4937:     backslash, the backslash, the newline, and any whitespace
                   4938:     immediately behind the newline are replaced with a single space. A
                   4939:     backslash character and an immediately following hash character are
                   4940:     replaced with a single hash character. Otherwise, the backslash is
                   4941:     passed as is. In a variable assignment, any hash character that is
                   4942:     not preceded by a backslash starts a comment that continues upto the
                   4943:     end of the logical line.</p>
                   4944: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4945:     the only way to create a variable consisting of a single backslash
                   4946:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4947: <p>So far for defining variables. The other thing you can do with
                   4948:     variables is evaluating them. A variable is evaluated when it is
                   4949:     part of the right side of the ``:='' or the ``!='' operator, or
                   4950:     directly before executing a shell command which the variable is part
1.110     hubertf  4951:     of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.75      rillig   4952:     is, variables are not evaluated until there's no other way. The
                   4953:     ``modifiers'' mentioned in the man page also evaluate the
                   4954:     variable.</p>
                   4955: <p>Some of the modifiers split the string into words and then
                   4956:     operate on the words, others operate on the string as a whole. When
                   4957:     a string is split into words, it is split as you would expect
1.110     hubertf  4958:     it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.114     jmcneill 4959: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.75      rillig   4960:     loop does not follow the shell quoting rules but splits at sequences
                   4961:     of whitespace.</p>
                   4962: <p>There are several types of variables that should be handled
                   4963:     differently. Strings and two types of lists.</p>
                   4964: <div class="itemizedlist"><ul type="disc">
                   4965: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4966:       characters. Nevertheless, you should restrict yourself to only
                   4967:       using printable characters. Examples are
                   4968:       <code class="varname">PREFIX</code> and
                   4969:       <code class="varname">COMMENT</code>.</p></li>
                   4970: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4971:       are never exported to any shell command. Their elements are
                   4972:       separated by whitespace. Therefore, the elements themselves cannot
                   4973:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4974:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4975:       Examples are <code class="varname">DEPENDS</code> and
                   4976:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4977: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4978:       may be exported to a shell command. Their elements can contain any
                   4979:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4980:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4981:       <code class="varname">DISTFILES</code> and
                   4982:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4983: </ul></div>
                   4984: <div class="sect2" lang="en">
                   4985: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4986: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.75      rillig   4987: <div class="itemizedlist"><ul type="disc">
                   4988: <li><p>All variable names starting with an underscore
                   4989:        are reserved for use by the pkgsrc infrastructure. They shall
                   4990:        not be used by package
1.76      rillig   4991:        <code class="filename">Makefile</code>s.</p></li>
1.110     hubertf  4992: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4993:        lowercase variable names for the iteration
                   4994:        variables.</p></li>
                   4995: <li><p>All list variables should have a ``plural''
                   4996:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4997:        <code class="varname">DISTFILES</code>.</p></li>
                   4998: </ul></div>
                   4999: </div>
                   5000: </div>
                   5001: <div class="sect1" lang="en">
                   5002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5003: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75      rillig   5004: <p>This section presents you with some code snippets you should
                   5005:     use in your own code. If you don't find anything appropriate here,
                   5006:     you should test your code and add it here.</p>
                   5007: <div class="sect2" lang="en">
                   5008: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5009: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   5010: <pre class="programlisting">
1.100     rillig   5011: STRING=                 foo * bar `date`
                   5012: INT_LIST=               # empty
                   5013: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   5014: EXT_LIST=               # empty
                   5015: ANOTHER_EXT_LIST=       a=b c=d
                   5016: 
                   5017: INT_LIST+=              ${STRING}               # 1
                   5018: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   5019: EXT_LIST+=              ${STRING:Q}             # 3
                   5020: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    5021: </pre>
1.75      rillig   5022: <p>When you add a string to an external list (example 3), it
                   5023:       must be quoted. In all other cases, you must not add a quoting
                   5024:       level. You must not merge internal and external lists, unless you
                   5025:       are sure that all entries are correctly interpreted in both
                   5026:       lists.</p>
                   5027: </div>
                   5028: <div class="sect2" lang="en">
                   5029: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5030: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.75      rillig   5031: <pre class="programlisting">
1.100     rillig   5032: EXT_LIST=       # empty
                   5033: .for i in ${INT_LIST}
                   5034: EXT_LIST+=      ${i:Q}""
                   5035: .endfor
1.1       grant    5036: </pre>
1.75      rillig   5037: <p>This code converts the internal list
                   5038:       <code class="varname">INT_LIST</code> into the external list
                   5039:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   5040:       are unquoted they must be quoted here. The reason for appending
                   5041:       <code class="varname">""</code> is explained below.</p>
                   5042: </div>
                   5043: <div class="sect2" lang="en">
                   5044: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5045: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   5046: <p>Sometimes you may want to print an arbitrary string. There
                   5047:        are many ways to get it wrong and only few that can handle every
                   5048:        nastiness.</p>
1.75      rillig   5049: <pre class="programlisting">
1.100     rillig   5050: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5051: EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    5052: 
1.100     rillig   5053: all:
                   5054:         echo ${STRING}                  # 1
                   5055:         echo "${STRING}"                # 2
                   5056:         echo "${STRING:Q}"              # 3
                   5057:         echo ${STRING:Q}                # 4
                   5058:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5059:         printf "%s\\n" ${STRING:Q}""    # 6
                   5060:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    5061: </pre>
1.75      rillig   5062: <p>Example 1 leads to a syntax error in the shell, as the
                   5063:       characters are just copied.</p>
                   5064: <p>Example 2 leads to a syntax error too, and if you leave out
                   5065:       the last " character from <code class="varname">${STRING}</code>,
1.110     hubertf  5066:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.75      rillig   5067:       variable would be evaluated, too.</p>
                   5068: <p>Example 3 outputs each space character preceded by a
                   5069:       backslash (or not), depending on the implementation of the
1.110     hubertf  5070:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.75      rillig   5071: <p>Example 4 handles correctly every string that does not start
                   5072:       with a dash. In that case, the result depends on the
1.110     hubertf  5073:       implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.75      rillig   5074:       guarantee that your input does not start with a dash, this form is
                   5075:       appropriate.</p>
                   5076: <p>Example 5 handles even the case of a leading dash
                   5077:       correctly.</p>
1.79      rillig   5078: <p>Example 6 also works with every string and is the
                   5079:       light-weight solution, since it does not involve a pipe, which has
                   5080:       its own problems.</p>
1.75      rillig   5081: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5082:       because the quoting has already been done when adding elements to
                   5083:       the list.</p>
                   5084: <p>As internal lists shall not be passed to the shell, there is
                   5085:       no example for it.</p>
                   5086: </div>
                   5087: <div class="sect2" lang="en">
                   5088: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5089: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   5090: <p>There are many possible sources of wrongly quoted variables.
                   5091:       This section lists some of the commonly known ones.</p>
                   5092: <div class="itemizedlist"><ul type="disc">
                   5093: <li>
                   5094: <p>Whenever you use the value of a list, think
                   5095:        about what happens to leading or trailing whitespace. If the
                   5096:        list is a well-formed shell expression, you can apply the
                   5097:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5098:        whitespace from each word. The <code class="varname">:M</code> operator
                   5099:        first splits its argument according to the rules of the shell,
                   5100:        and then creates a new list consisting of all words that match
                   5101:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5102:        One class of situations where this is needed is when adding a
                   5103:        variable like <code class="varname">CPPFLAGS</code> to
                   5104:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5105:        invokes other configure scripts, it strips the leading and
                   5106:        trailing whitespace from the variable and then passes it to the
                   5107:        other configure scripts. But these configure scripts expect the
                   5108:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5109:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5110:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5111:        here is how we do it:</p>
                   5112: <pre class="programlisting">
1.100     rillig   5113: CPPFLAGS=               # empty
                   5114: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5115: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5116: 
                   5117: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5118: 
                   5119: all:
                   5120:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5121:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    5122: </pre>
1.75      rillig   5123: </li>
                   5124: <li><p>The example above contains one bug: The
                   5125:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5126:        expression, but there is the C compiler after it, which also
                   5127:        expects a properly quoted string (this time in C syntax). The
                   5128:        version above is therefore only correct if
                   5129:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5130:        or double quotes. If you want to allow these, you have to add
                   5131:        another layer of quoting to each variable that is used as a C
                   5132:        string literal. You cannot use the <code class="varname">:Q</code>
                   5133:        operator for it, as this operator only works for the
                   5134:        shell.</p></li>
                   5135: <li>
                   5136: <p>Whenever a variable can be empty, the
                   5137:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5138:        are two completely different cases which can be solved with the
                   5139:        same trick.</p>
                   5140: <pre class="programlisting">
1.100     rillig   5141: EMPTY=                  # empty
                   5142: empty_test:
                   5143:         for i in a ${EMPTY:Q} c; do \
                   5144:             echo "$$i"; \
                   5145:         done
                   5146: 
                   5147: for_test:
                   5148: .for i in a:\ a:\test.txt
                   5149:         echo ${i:Q}
                   5150:         echo "foo"
                   5151: .endfor
1.1       grant    5152: </pre>
1.75      rillig   5153: <p>The first example will only print two of the three lines
                   5154:        we might have expected. This is because
                   5155:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5156:        the shell cannot see. The workaround is to write
                   5157:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5158:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5159:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5160: <p>The second example will only print three lines instead of
                   5161:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5162:        This is because the backslash of the value
                   5163:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110     hubertf  5164:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
                   5165:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.75      rillig   5166:        <code class="varname">${i:Q}""</code>.</p>
                   5167: </li>
                   5168: </ul></div>
                   5169: </div>
                   5170: <div class="sect2" lang="en">
                   5171: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5172: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5173: <p>The pkgsrc bmake program does not handle the following
                   5174:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5175:       contains a ``-'' character, one of the closing braces is included
                   5176:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5177: <pre class="programlisting">
1.100     rillig   5178: VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5179: </pre>
1.75      rillig   5180: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5181:       package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
1.75      rillig   5182:       <code class="varname">bug1</code>.</p>
                   5183: </div>
                   5184: </div>
                   5185: </div>
                   5186: <div class="chapter" lang="en">
                   5187: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5188: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   5189: <div class="toc">
                   5190: <p><b>Table of Contents</b></p>
                   5191: <dl>
1.106     rillig   5192: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.116     rillig   5193: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
                   5194: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106     rillig   5195: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5196: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.116     rillig   5197: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106     rillig   5198: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5199: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5200: </dl>
                   5201: </div>
1.87      wiz      5202: <p>The <code class="filename">PLIST</code> file contains a package's
                   5203:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5204:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5205:   directory it's been installed in) plus some additional statements
1.110     hubertf  5206:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      5207:   This chapter addresses some issues that need attention when
                   5208:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5209:   below!).</p>
1.75      rillig   5210: <div class="sect1" lang="en">
                   5211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5212: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      5213: <p>Be sure to add a RCS ID line as the first thing in any
                   5214:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5215: <pre class="programlisting">
1.100     rillig   5216: @comment $NetBSD$
1.87      wiz      5217:     </pre>
1.75      rillig   5218: </div>
                   5219: <div class="sect1" lang="en">
                   5220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5221: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  5222: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      5223:     to output a PLIST that matches any new files since the package
1.110     hubertf  5224:     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.87      wiz      5225:     more information on this target.</p>
1.75      rillig   5226: </div>
                   5227: <div class="sect1" lang="en">
                   5228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  5229: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   5230: </h2></div></div></div>
1.87      wiz      5231: <p>If you have used any of the *-dirs packages, as explained in
1.110     hubertf  5232:     <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
                   5233:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87      wiz      5234:     <code class="varname">@comment</code>s instead of real
                   5235:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5236:     specific directories and files, so that the results of that
                   5237:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5238:     lot</em></span> during the update of packages.</p>
                   5239: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5240:     of AWK patterns and actions that are used to filter the output of
                   5241:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5242:     scripting you like to it, but be careful with quoting.</p>
                   5243: <p>For example, to get all files inside the
                   5244:     <code class="filename">libdata/foo</code> directory removed from the
                   5245:     resulting PLIST:</p>
                   5246: <pre class="programlisting">
1.100     rillig   5247: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      5248:     </pre>
                   5249: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5250:     to a specific (shared) directory converted to
                   5251:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5252: <pre class="programlisting">
1.100     rillig   5253: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87      wiz      5254:     </pre>
1.75      rillig   5255: </div>
                   5256: <div class="sect1" lang="en">
                   5257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5258: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5259: <p>A number of variables are substituted automatically in
                   5260:     PLISTs when a package is installed on a system. This includes the
                   5261:     following variables:</p>
1.75      rillig   5262: <div class="variablelist"><dl>
                   5263: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5264: <dd>
                   5265: <p>Some packages like emacs and perl embed information
1.87      wiz      5266:          about which architecture they were built on into the
                   5267:          pathnames where they install their files. To handle this
                   5268:          case, PLIST will be preprocessed before actually used, and
                   5269:          the symbol
                   5270:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
1.110     hubertf  5271:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      5272:          same is done if the string
                   5273:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5274:          PLIST somewhere - use this on packages that have GNU
                   5275:          autoconf-created configure scripts.</p>
1.75      rillig   5276: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5277: <h3 class="title">Legacy note</h3>
                   5278: <p>There used to be a symbol
1.87      wiz      5279:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
1.110     hubertf  5280:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      5281:            -m</strong></span>, but that's no longer supported and has
                   5282:            been removed.</p>
1.75      rillig   5283: </div>
                   5284: </dd>
                   5285: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5286: <dd>
                   5287: <p>Some packages want to embed the OS name and version
1.87      wiz      5288:          into some paths.  To do this, use these variables in the
                   5289:          <code class="filename">PLIST</code>:
                   5290:          </p>
1.75      rillig   5291: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  5292: <li><p><code class="varname">${OPSYS}</code> - output of &#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</p></li>
1.75      rillig   5293: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
1.110     hubertf  5294: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</p></li>
1.75      rillig   5295: </ul></div>
                   5296: </dd>
                   5297: </dl></div>
1.87      wiz      5298: <p>For a complete list of values which are replaced by
                   5299:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5300:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5301: <p>If you want to change other variables not listed above, you
                   5302:     can add variables and their expansions to this variable in the
1.110     hubertf  5303:     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.75      rillig   5304: <pre class="programlisting">
1.100     rillig   5305: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      5306:     </pre>
1.75      rillig   5307: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
1.87      wiz      5308:     in the <code class="filename">PLIST</code> with
                   5309:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
1.119   ! mishka   5310: <p>The <code class="varname">PLIST_VARS</code> can be used to simplify
        !          5311:     the common case of conditionally including some
        !          5312:     <code class="filename">PLIST</code> entries. It can be done by adding
        !          5313:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
        !          5314:     setting the coresponding <code class="varname">PLIST.foo</code> variable
        !          5315:     to <code class="literal">yes</code>, if the entry should be included.
        !          5316:     This will substitute &#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;
        !          5317:     in the <code class="filename">PLIST</code> with either
        !          5318:     &#8220;<span class="quote"><code class="literal">""</code></span>&#8221; or
        !          5319:     &#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;.
        !          5320:     For example, in <code class="filename">Makefile</code>:</p>
        !          5321: <pre class="programlisting">
        !          5322: PLIST_VARS+=   foo
        !          5323: .if <em class="replaceable"><code>condition</code></em>
        !          5324: PLIST.foo=     yes
        !          5325: .else
        !          5326:     </pre>
        !          5327: <p>And then in <code class="filename">PLIST</code>:</p>
        !          5328: <pre class="programlisting">
        !          5329: @comment $NetBSD$
        !          5330: bin/bar
        !          5331: man/man1/bar.1
        !          5332: ${PLIST.foo}bin/foo
        !          5333: ${PLIST.foo}man/man1/foo.1
        !          5334: ${PLIST.foo}share/bar/foo.data
        !          5335: ${PLIST.foo}@dirrm share/bar
        !          5336:     </pre>
1.75      rillig   5337: </div>
                   5338: <div class="sect1" lang="en">
                   5339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5340: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   5341: <p>Man pages should be installed in compressed form if
1.87      wiz      5342:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5343:     and uncompressed otherwise. To handle this in the
                   5344:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5345:     appended/removed automatically for man pages according to
                   5346:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5347:     or not, see above for details. This modification of the
                   5348:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5349:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5350: </div>
                   5351: <div class="sect1" lang="en">
                   5352: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5353: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   5354: </h2></div></div></div>
1.76      rillig   5355: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5356:     in generating the binary package, set the variable
                   5357:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110     hubertf  5358:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      5359:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5360:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5361: </div>
                   5362: <div class="sect1" lang="en">
                   5363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5364: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5365: <p>Some packages decide to install a different set of files based on
1.87      wiz      5366:     the operating system being used. These differences can be
                   5367:     automatically handled by using the following files:</p>
1.75      rillig   5368: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5369: <li><p><code class="filename">PLIST.common</code></p></li>
                   5370: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5371: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5372: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5373: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5374: </ul></div>
                   5375: </div>
                   5376: <div class="sect1" lang="en">
                   5377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5378: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.87      wiz      5379: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5380:     multiple (and unrelated) packages install files.  These
                   5381:     directories are problematic because you have to add special tricks
                   5382:     in the PLIST to conditionally remove them, or have some
                   5383:     centralized package handle them.</p>
                   5384: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5385:     is shared by a few unrelated packages, it's often not worth to add
                   5386:     an extra package to remove it.  Therefore, one simply does:</p>
                   5387: <pre class="programlisting">
1.100     rillig   5388: @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
1.87      wiz      5389:     </pre>
                   5390: <p>in the PLISTs of all affected packages, instead of the
                   5391:     regular "@dirrm" line.</p>
                   5392: <p>However, if the directory is shared across many packages, two
                   5393:     different solutions are available:</p>
1.75      rillig   5394: <div class="orderedlist"><ol type="1">
1.87      wiz      5395: <li><p>If the packages have a common dependency, the directory
                   5396:        can be removed in that.  For example, see
1.91      rillig   5397:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
1.87      wiz      5398:        removes the shared directory
                   5399:        <code class="filename">share/omf</code>.</p></li>
                   5400: <li><p>If the packages using the directory are not related at
                   5401:        all (they have no common dependencies), a *-dirs package is
                   5402:        used.</p></li>
1.75      rillig   5403: </ol></div>
1.87      wiz      5404: <p>From now on, we'll discuss the second solution.  To get an
                   5405:     idea of the *-dirs packages available, issue:</p>
1.75      rillig   5406: <pre class="programlisting">
1.100     rillig   5407: <code class="prompt">%</code> cd .../pkgsrc
                   5408: <code class="prompt">%</code> ls -d */*-dirs
1.87      wiz      5409:     </pre>
                   5410: <p>Their use from other packages is very simple.  The
                   5411:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5412:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5413:     version number (always pick the latest one when writing new
                   5414:     packages).</p>
                   5415: <p>For example, if a package installs files under
                   5416:     <code class="filename">share/applications</code>, it should have the
                   5417:     following line in it:</p>
                   5418: <pre class="programlisting">
1.100     rillig   5419: USE_DIRS+=      xdg-1.1
1.87      wiz      5420:     </pre>
1.110     hubertf  5421: <p>After regenerating the PLIST using <span class="command"><strong>make
1.87      wiz      5422:     print-PLIST</strong></span>, you should get the right (commented out)
                   5423:     lines.</p>
                   5424: <p>Note that even if your package is using
                   5425:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5426:     *-x11-dirs packages.  Just specify the name without that part and
                   5427:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5428:     care of it.</p>
1.75      rillig   5429: </div>
                   5430: </div>
                   5431: <div class="chapter" lang="en">
                   5432: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5433: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   5434: <div class="toc">
                   5435: <p><b>Table of Contents</b></p>
                   5436: <dl>
1.106     rillig   5437: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.116     rillig   5438: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.75      rillig   5439: <dd><dl>
1.106     rillig   5440: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.116     rillig   5441: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.75      rillig   5442: </dl></dd>
1.116     rillig   5443: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.75      rillig   5444: <dd><dl>
1.116     rillig   5445: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.106     rillig   5446: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   5447: </dl></dd>
                   5448: </dl>
                   5449: </div>
                   5450: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5451:   are seen by a package's configure and build processes.  This is implemented
                   5452:   in a two step process:</p>
1.75      rillig   5453: <div class="orderedlist"><ol type="1">
                   5454: <li><p>Symlink headers and libraries for dependencies into
1.87      wiz      5455:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5456:       of <code class="varname">WRKDIR</code>.</p></li>
1.75      rillig   5457: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5458:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5459:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5460:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5461:       native compiler on some operating systems look like GCC, so that
                   5462:       packages that expect GCC won't require modifications to build with
                   5463:       those native compilers.</p></li>
1.75      rillig   5464: </ol></div>
                   5465: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5466:   package may be built consistently despite what other software may be
                   5467:   installed. Please note that the normal system header and library paths,
                   5468:   e.g. <code class="filename">/usr/include</code>,
                   5469:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5470:   designed to insulate the package build from non-system-supplied
                   5471:   software.</p>
1.75      rillig   5472: <div class="sect1" lang="en">
                   5473: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5474: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5475: <p>The process of converting packages to use the buildlink3
1.87      wiz      5476:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5477:     The things to keep in mind are:</p>
1.75      rillig   5478: <div class="orderedlist"><ol type="1">
1.87      wiz      5479: <li><p>Ensure that the build always calls the wrapper scripts
                   5480:        instead of the actual toolchain.  Some packages are tricky,
                   5481:        and the only way to know for sure is the check
                   5482:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5483:        wrappers are being invoked.</p></li>
                   5484: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5485:        the package Makefile, e.g. Java VMs, standalone shells,
                   5486:        etc., because the code to symlink files into
                   5487:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5488:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5489:        </p></li>
                   5490: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5491:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5492:        package's Makefile are added as dependencies for that package.
                   5493:        </p></li>
1.75      rillig   5494: </ol></div>
1.87      wiz      5495: <p>If a dependency on a particular package is required for its libraries and
                   5496:     headers, then we replace:</p>
1.75      rillig   5497: <pre class="programlisting">
1.100     rillig   5498: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5499: </pre>
1.75      rillig   5500: <p>with</p>
                   5501: <pre class="programlisting">
1.100     rillig   5502: .include "../../category/foo/buildlink3.mk"
                   5503: </pre>
1.75      rillig   5504: <p>The buildlink3.mk files usually define the required dependencies.
                   5505:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5506:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5507: <pre class="programlisting">
1.100     rillig   5508: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5509: .include "../../category/foo/buildlink3.mk"
                   5510: </pre>
1.76      rillig   5511: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5512:     files in <code class="filename">pkgsrc/mk</code>
                   5513:     that handle special package issues:</p>
1.75      rillig   5514: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5515: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5516:        the native or a pkgsrc Berkeley DB implementation based on
                   5517:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5518:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76      rillig   5519: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5520:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5521:        to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.76      rillig   5522: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5523:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5524:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5525:        require a Kerberos 5 implementation.</p></li>
1.88      wiz      5526: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5527:        system-provided Motif installation or adds a dependency on
1.91      rillig   5528:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/openmotif/README.html" target="_top"><code class="filename">x11/openmotif</code></a>.  The user can set
1.88      wiz      5529:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5530:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5531:        which Motif version will be used.</p></li>
1.76      rillig   5532: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5533:        variables that may be used by packages that use the
                   5534:        Open Sound System (OSS) API.</p></li>
1.76      rillig   5535: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93      rillig   5536:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87      wiz      5537:        the file for more information.</p></li>
1.76      rillig   5538: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5539:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5540:        a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.76      rillig   5541: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5542:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5543:        library.</p></li>
1.75      rillig   5544: </ul></div>
1.76      rillig   5545: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5546:     files provide a more complete
                   5547:     description of how to use them properly.</p>
1.75      rillig   5548: </div>
                   5549: <div class="sect1" lang="en">
                   5550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5551: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   5552: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      5553:     included by Makefiles to indicate the need to compile and link
                   5554:     against header files and libraries provided by the package.  A
                   5555:     <code class="filename">buildlink3.mk</code> file should always provide
                   5556:     enough information to add the correct type of dependency
                   5557:     relationship and include any other
                   5558:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5559:     headers and libraries that it needs in turn.</p>
                   5560: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5561:     file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87      wiz      5562:     package is highly recommended.  For most packages, the following
                   5563:     command will generate a good starting point for
                   5564:     <code class="filename">buildlink3.mk</code> files:</p>
                   5565: <pre class="screen">
                   5566: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5567: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5568:     </pre>
1.75      rillig   5569: <div class="sect2" lang="en">
                   5570: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5571: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5572: <p>The following real-life example
1.87      wiz      5573:       <code class="filename">buildlink3.mk</code> is taken
                   5574:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5575: <pre class="programlisting">
1.100     rillig   5576: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
1.1       grant    5577: 
1.100     rillig   5578: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
                   5579: TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
1.1       grant    5580: 
1.100     rillig   5581: .if ${BUILDLINK_DEPTH} == "+"
                   5582: BUILDLINK_DEPENDS+=     tiff
                   5583: .endif
1.87      wiz      5584: 
1.100     rillig   5585: BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
                   5586: BUILDLINK_PACKAGES+=    tiff
1.87      wiz      5587: 
1.100     rillig   5588: .if ${TIFF_BUILDLINK3_MK} == "+"
                   5589: BUILDLINK_API_DEPENDS.tiff+=        tiff&gt;=3.6.1
                   5590: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   5591: .endif  # TIFF_BUILDLINK3_MK
1.87      wiz      5592: 
1.100     rillig   5593: .include "../../devel/zlib/buildlink3.mk"
                   5594: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      5595: 
1.100     rillig   5596: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
                   5597: </pre>
1.87      wiz      5598: <p>The header and footer manipulate
                   5599:       <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
                   5600:       <code class="filename">buildlink3.mk</code> files and is used to track
                   5601:       at what depth we are including
                   5602:       <code class="filename">buildlink3.mk</code> files.</p>
                   5603: <p>The first section controls if the dependency on
                   5604:       <em class="replaceable"><code>pkg</code></em> is added.
                   5605:       <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
                   5606:       packages for which dependencies are added by
                   5607:       buildlink3.</p>
                   5608: <p>The second section advises pkgsrc that the
                   5609:       <code class="filename">buildlink3.mk</code> file for
                   5610:       <em class="replaceable"><code>pkg</code></em> has been included at some point.
                   5611:       <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
                   5612:       packages for which <code class="filename">buildlink3.mk</code> files
                   5613:       have been included.  It must <span class="emphasis"><em>always</em></span> be
                   5614:       appended to within a <code class="filename">buildlink3.mk</code>
                   5615:       file.</p>
                   5616: <p>The third section is protected from multiple inclusion
                   5617:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5618:       added.  Several important variables are set in the section:</p>
                   5619: <div class="itemizedlist"><ul type="disc">
                   5620: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5621:          is the actual dependency recorded in the installed
                   5622:          package; this should always be set using
1.110     hubertf  5623:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      5624:          we're appending to any pre-existing list of values.  This
                   5625:          variable should be set to the first version of the
                   5626:          package that had an API change.
                   5627:          </p></li>
                   5628: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5629:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5630:          pkgsrc directory.</p></li>
                   5631: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5632:          (not shown above) controls whether we use
                   5633:          <code class="varname">BUILD_DEPENDS</code> or
                   5634:          <code class="varname">DEPENDS</code> to add the dependency on
                   5635:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5636:          selected by setting
                   5637:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5638:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5639:          used.</p></li>
                   5640: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5641:            and
                   5642:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5643:            (not shown above) are lists of subdirectories of
1.76      rillig   5644:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5645:            to add to the header and library search paths.  These
                   5646:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
1.87      wiz      5647:          respectively.</p></li>
                   5648: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5649:            (not shown above) is the list of preprocessor flags to add
                   5650:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5651:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5652:            should be avoided and instead be handled using
                   5653:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5654:          above.</p></li>
1.75      rillig   5655: </ul></div>
1.87      wiz      5656: <p>The following variables are all optionally defined within
                   5657:       this second section (protected against multiple inclusion) and
                   5658:       control which package files are symlinked into
                   5659:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5660:       transformed during the symlinking:</p>
1.75      rillig   5661: <div class="itemizedlist"><ul type="disc">
1.87      wiz      5662: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5663:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5664:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5665:            to be symlinked into
1.76      rillig   5666:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5667:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5668: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5669:            (not shown above) is a shell pipeline that
                   5670:            outputs to stdout a list of files relative to
                   5671:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5672:            The resulting files are to be symlinked
                   5673:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5674:            this takes the <code class="filename">+CONTENTS</code> of a
                   5675:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5676:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5677: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5678:            (not shown above) is a filter command that filters
1.76      rillig   5679:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5680:            relative to
1.76      rillig   5681:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5682:            on stdout.  By default for overwrite packages,
                   5683:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5684:            outputs the contents of the <code class="filename">include</code>
                   5685:            and <code class="filename">lib</code> directories in the package
                   5686:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5687:            it outputs any libtool archives in
1.87      wiz      5688:            <code class="filename">lib</code> directories.</p></li>
1.95      tron     5689: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5690:            (not shown above) is a list of sed arguments used to
                   5691:            transform the name of the source filename into a
1.110     hubertf  5692:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      5693:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5694: </ul></div>
1.87      wiz      5695: <p>The last section includes any
                   5696:       <code class="filename">buildlink3.mk</code> needed for
                   5697:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5698:       Including these <code class="filename">buildlink3.mk</code> files
                   5699:       means that the headers and libraries for these
                   5700:       dependencies are also symlinked into
                   5701:       <code class="filename">${BUILDLINK_DIR}</code>
                   5702:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5703:       <code class="filename">buildlink3.mk</code>
                   5704:       file is included.</p>
1.75      rillig   5705: </div>
                   5706: <div class="sect2" lang="en">
                   5707: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5708: <a name="updating-buildlink-depends"></a>14.2.2. Updating <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code> in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.87      wiz      5709: <p>The situation that requires increasing the dependency listed in
1.75      rillig   5710:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5711:        after a package update is when the API or interface to the
1.87      wiz      5712:       header files change.</p>
                   5713: <p>In this case,
                   5714:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5715:       should be adjusted to require at least the new package
                   5716:       version.  In some cases, the packages that depend on this new
                   5717:       version may need their <code class="varname">PKGREVISION</code>s
                   5718:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5719:       files, their
                   5720:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5721:       adjusted, too.  This is needed so pkgsrc will require the
                   5722:       correct package dependency and not settle for an older one
                   5723:       when building the source.</p>
                   5724: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5725:        should be increased when the binary interface or sonames
                   5726:        (major number of the library version) of any installed
                   5727:        shared libraries change.  This is needed so that binary
                   5728:        packages made using it will require the correct package
                   5729:        dependency and not settle for an older one which will not
1.87      wiz      5730:       contain the necessary shared libraries.</p>
1.110     hubertf  5731: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
1.75      rillig   5732:        more information about dependencies on other packages,
                   5733:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5734:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5735: <p>Please take careful consideration before adjusting
                   5736:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5737:       or
                   5738:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5739:       as we don't want to cause unneeded package deletions and
                   5740:       rebuilds.  In many cases, new versions of packages work just
                   5741:       fine with older dependencies.</p>
                   5742: <p>Also it is not needed to set
1.75      rillig   5743:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5744:        when it is identical to
1.87      wiz      5745:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5746: </div>
                   5747: </div>
                   5748: <div class="sect1" lang="en">
                   5749: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5750: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5751: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5752:       coincide with headers and libraries present in the base system.
1.76      rillig   5753:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5754:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5755:       file that includes the necessary checks to decide whether using
                   5756:       the built-in software or the pkgsrc software is
1.87      wiz      5757:     appropriate.</p>
                   5758: <p>The only requirements of a builtin.mk file for
                   5759:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.75      rillig   5760: <div class="orderedlist"><ol type="1">
1.87      wiz      5761: <li><p>It should set
                   5762:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5763:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5764:        after it is included.</p></li>
                   5765: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5766:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5767:        which is already set before the
                   5768:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5769: <li><p>It should be written to allow multiple inclusion.  This
                   5770:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5771:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5772: </ol></div>
                   5773: <div class="sect2" lang="en">
                   5774: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5775: <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.75      rillig   5776: <p>The following is the recommended template for builtin.mk
1.87      wiz      5777:       files:</p>
1.75      rillig   5778: <pre class="programlisting">
1.100     rillig   5779: .if !defined(IS_BUILTIN.foo)
                   5780: #
                   5781: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5782: # genuinely exists in the system or not.
                   5783: #
                   5784: IS_BUILTIN.foo?=        no
                   5785: 
                   5786: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5787: # version can be determined.
                   5788: #
                   5789: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5790: BUILTIN_PKG.foo?=       foo-1.0
                   5791: .  endif
                   5792: .endif  # IS_BUILTIN.foo
                   5793: 
                   5794: .if !defined(USE_BUILTIN.foo)
                   5795: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5796: .  if defined(BUILTIN_PKG.foo)
                   5797: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5798: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5799: USE_BUILTIN.foo!=                                                       \
                   5800:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5801:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5802: .      endif
                   5803: .    endfor
                   5804: .  endif
                   5805: .endif  # USE_BUILTIN.foo
                   5806: 
                   5807: CHECK_BUILTIN.foo?=     no
                   5808: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5809: #
                   5810: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5811: # "yes" or "no".
                   5812: #
                   5813: .endif  # CHECK_BUILTIN.foo
                   5814: </pre>
1.87      wiz      5815: <p>The first section sets
                   5816:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5817:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5818:       in the base system.  This should not be a base system software
                   5819:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5820:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5821:       included as part of the base system.  This variable is only
                   5822:       used internally within the <code class="filename">builtin.mk</code>
                   5823:       file.</p>
                   5824: <p>The second section sets
                   5825:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5826:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5827:       system if it exists (if
                   5828:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5829:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5830:       within the <code class="filename">builtin.mk</code> file.</p>
                   5831: <p>The third section sets
                   5832:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5833:       and is <span class="emphasis"><em>required</em></span> in all
                   5834:       <code class="filename">builtin.mk</code> files.  The code in this
                   5835:       section must make the determination whether the built-in
                   5836:       software is adequate to satisfy the dependencies listed in
                   5837:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5838:       This is typically done by comparing
                   5839:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5840:       against each of the dependencies in
                   5841:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5842:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5843:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5844:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5845:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5846:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5847:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5848:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5849:       that the built-in version of the software is similar enough to
                   5850:       be used as a replacement.</p>
                   5851: <p>The last section is guarded by
                   5852:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5853:       and includes code that uses the value of
                   5854:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5855:       set in the previous section.  This typically includes, e.g.,
                   5856:       adding additional dependency restrictions and listing additional
                   5857:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5858:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5859: </div>
                   5860: <div class="sect2" lang="en">
                   5861: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5862: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5863: <p>When building packages, it's possible to choose whether to set
                   5864:        a global preference for using either the built-in (native)
                   5865:        version or the pkgsrc version of software to satisfy a
                   5866:        dependency.  This is controlled by setting
                   5867:        <code class="varname">PREFER_PKGSRC</code> and
                   5868:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5869:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5870:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5871:        use the pkgsrc versions of software, while
                   5872:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5873:        built-in versions.  Preferences are determined by the most
                   5874:        specific instance of the package in either
                   5875:        <code class="varname">PREFER_PKGSRC</code> or
                   5876:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5877:        in neither or in both variables, then
                   5878:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5879:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5880:        using pkgsrc versions of software for all but the most basic
                   5881:       bits on a NetBSD system, you can set:</p>
                   5882: <pre class="programlisting">
1.100     rillig   5883: PREFER_PKGSRC=  yes
                   5884: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5885: </pre>
1.87      wiz      5886: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5887:       <code class="filename">builtin.mk</code>
                   5888:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5889:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5890: </div>
                   5891: </div>
                   5892: </div>
                   5893: <div class="chapter" lang="en">
                   5894: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5895: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   5896: <div class="toc">
                   5897: <p><b>Table of Contents</b></p>
                   5898: <dl>
1.106     rillig   5899: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5900: <dd><dl>
1.106     rillig   5901: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5902: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   5903: </dl></dd>
1.106     rillig   5904: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   5905: <dd><dl>
1.116     rillig   5906: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106     rillig   5907: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5908: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5909: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5910: </dl></dd>
                   5911: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5912: <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>
                   5913: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5914: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5915: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5916: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5917: <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.75      rillig   5918: </dl>
                   5919: </div>
                   5920: <p>This chapter describes the framework known as
                   5921: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5922: <div class="itemizedlist"><ul type="disc">
                   5923: <li><p>Generic installation and manipulation of directories and files
                   5924:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5925: <li><p>Automatic handling of configuration files during installation,
                   5926:     provided that packages are correctly designed.</p></li>
                   5927: <li><p>Generation and installation of system startup scripts.</p></li>
                   5928: <li><p>Registration of system users and groups.</p></li>
                   5929: <li><p>Registration of system shells.</p></li>
                   5930: <li><p>Automatic updating of fonts databases.</p></li>
                   5931: </ul></div>
                   5932: <p>The following sections inspect each of the above points in detail.</p>
                   5933: <p>You may be thinking that many of the things described here could be
                   5934: easily done with simple code in the package's post-installation target
                   5935: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5936: as the code in them is only executed when building from source.  Machines
                   5937: using binary packages could not benefit from it at all (as the code itself
                   5938: could be unavailable).  Therefore, the only way to achieve any of the items
                   5939: described above is by means of the installation scripts, which are
                   5940: automatically generated by pkginstall.</p>
                   5941: <div class="sect1" lang="en">
                   5942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5943: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5944: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5945: of files and directories that belong to a package.  The names used in it
1.76      rillig   5946: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5947: which means that it cannot register files outside this directory (absolute
                   5948: path names are not allowed).  Despite this restriction, some packages need
                   5949: to install files outside this location; e.g., under
1.76      rillig   5950: <code class="filename">${VARBASE}</code> or
1.87      wiz      5951: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5952: is to create such files during installation time by using
                   5953: installation scripts.</p>
                   5954: <p>The generic installation scripts are shell scripts that can
                   5955: contain arbitrary code.  The list of scripts to execute is taken from
                   5956: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5957: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5958: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5959: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5960: commands, so they have the potential to create and manage files
                   5961: anywhere in the file system.</p>
                   5962: <p>Using these general installation files is not recommended, but
                   5963: may be needed in some special cases.  One reason for avoiding them is
                   5964: that the user has to trust the packager that there is no unwanted or
                   5965: simply erroneous code included in the installation script. Also,
                   5966: previously there were many similar scripts for the same functionality,
                   5967: and fixing a common error involved finding and changing all of
                   5968: them.</p>
                   5969: <p>The pkginstall framework offers another, standardized way.  It
                   5970: provides generic scripts to abstract the manipulation of such files
                   5971: and directories based on variables set in the package's
                   5972: <code class="filename">Makefile</code>.  The rest of this section describes
                   5973: these variables.</p>
1.75      rillig   5974: <div class="sect2" lang="en">
                   5975: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5976: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5977: <p>The following variables can be set to request the creation of
                   5978: directories anywhere in the file system:</p>
                   5979: <div class="itemizedlist"><ul type="disc">
                   5980: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5981:     contain a list of directories that should be created and should attempt
                   5982:     to be destroyed by the installation scripts.  The difference between
                   5983:     the two is that the latter prompts the administrator to remove any
                   5984:     directories that may be left after deinstallation (because they were
                   5985:     not empty), while the former does not.</p></li>
                   5986: <li>
                   5987: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5988:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5989:     which directories should be created and should attempt to be destroyed
                   5990:     by the installation scripts.  Each tuple holds the following values,
                   5991:     separated by spaces: the directory name, its owner, its group and its
                   5992:     numerical mode.  For example:</p>
                   5993: <pre class="programlisting">
1.100     rillig   5994: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5995: </pre>
1.75      rillig   5996: <p>The difference between the two is exactly the same as their
                   5997:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5998: </li>
                   5999: </ul></div>
                   6000: </div>
                   6001: <div class="sect2" lang="en">
                   6002: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6003: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   6004: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   6005: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   6006: To overcome this problem, the only solution is to extract the file in the
                   6007: known place (i.e., inside the installation prefix) and copy it to the
                   6008: appropriate location during installation (done by the installation scripts
                   6009: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6010: file</em></span> in the following paragraphs, which describe the variables
                   6011: that can be used to automatically and consistently handle files outside the
                   6012: installation prefix:</p>
                   6013: <div class="itemizedlist"><ul type="disc">
                   6014: <li>
                   6015: <p><code class="varname">CONF_FILES</code> and
                   6016:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   6017:     During installation time, the master file is copied to the target one
                   6018:     if and only if the latter does not exist.  Upon deinstallation, the
                   6019:     target file is removed provided that it was not modified by the
                   6020:     installation.</p>
                   6021: <p>The difference between the two is that the latter prompts the
                   6022:     administrator to remove any files that may be left after
                   6023:     deinstallation (because they were not empty), while the former does
                   6024:     not.</p>
                   6025: </li>
                   6026: <li>
                   6027: <p><code class="varname">CONF_FILES_PERMS</code> and
                   6028:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   6029:     files as well as their target locations.  For each of them, it also
                   6030:     specifies their owner, their group and their numeric permissions, in
                   6031:     this order.  For example:</p>
                   6032: <pre class="programlisting">
1.100     rillig   6033: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    6034: </pre>
1.75      rillig   6035: <p>The difference between the two is exactly the same as their
                   6036:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6037: </li>
                   6038: </ul></div>
                   6039: </div>
                   6040: </div>
                   6041: <div class="sect1" lang="en">
                   6042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6043: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   6044: <p>Configuration files are special in the sense that they are installed
                   6045: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6046: need special treatment during installation (most of which is automated by
                   6047: pkginstall).  The main concept you must bear in mind is that files marked
                   6048: as configuration files are automatically copied to the right place (somewhere
                   6049: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6050: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6051: be removed if they have local modifications.  This ensures that
                   6052: administrators never lose any custom changes they may have made.</p>
                   6053: <div class="sect2" lang="en">
                   6054: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6055: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   6056: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   6057: specifies where configuration files shall be installed.  Its contents are
                   6058: set based upon the following variables:</p>
                   6059: <div class="itemizedlist"><ul type="disc">
                   6060: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   6061:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   6062:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   6063:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   6064:     Packages must not use it directly.</p></li>
                   6065: <li>
                   6066: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   6067:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   6068:     for the package being built shall be installed.  The definition of this
                   6069:     variable only makes sense in the package's
1.76      rillig   6070:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   6071: <p>As an example, consider the Apache package,
1.91      rillig   6072:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache2/README.html" target="_top"><code class="filename">www/apache2</code></a>, which places its
1.75      rillig   6073:     configuration files under the
1.76      rillig   6074:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   6075:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   6076:     Makefile.</p>
                   6077: </li>
                   6078: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   6079:     variable that holds this package's configuration directory (if
                   6080:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   6081:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   6082:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   6083: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   6084:     directory where the configuration files for the package identified by
                   6085:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   6086: </ul></div>
                   6087: <p>Based on the above variables, pkginstall determines the value of
                   6088: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6089: variable that can be used within a package to refer to its configuration
                   6090: directory.  The algorithm used to set its value is basically the
                   6091: following:</p>
                   6092: <div class="orderedlist"><ol type="1">
                   6093: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   6094:     its value is used.</p></li>
                   6095: <li><p>If the previous variable is not defined but
                   6096:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   6097:     <code class="filename">Makefile</code>, the resulting value is
                   6098:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75      rillig   6099: <li><p>Otherwise, it is set to
1.76      rillig   6100:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   6101: </ol></div>
1.76      rillig   6102: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117     jnemeth  6103: 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
                   6104: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6105: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   6106: </div>
                   6107: <div class="sect2" lang="en">
                   6108: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6109: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   6110: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6111: known place, you need to teach each package where it shall install its
                   6112: files.  In some cases you will have to patch the package Makefiles to
                   6113: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6114: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6115: generated files:</p>
                   6116: <pre class="programlisting">
1.100     rillig   6117: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    6118: </pre>
1.75      rillig   6119: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6120: for</em></span> its configuration files, not where they will be originally
                   6121: installed (although the difference is never explicit,
                   6122: unfortunately).</p>
                   6123: </div>
                   6124: <div class="sect2" lang="en">
                   6125: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6126: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   6127: <p>As said before, pkginstall automatically handles configuration files.
                   6128: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   6129: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   6130: directly</strong></span>.  Bad news is that many software installation scripts
                   6131: will, out of the box, mess with the contents of that directory.  So what is
                   6132: the correct procedure to fix this issue?</p>
                   6133: <p>You must teach the package (usually by manually patching it) to
                   6134: install any configuration files under the examples hierarchy,
1.76      rillig   6135: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6136: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   6137: has the original copies available.</p>
                   6138: <p>Once the required configuration files are in place (i.e., under the
                   6139: examples hierarchy), the pkginstall framework can use them as master copies
                   6140: during the package installation to update what is in
1.76      rillig   6141: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   6142: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  6143: 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.75      rillig   6144: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   6145: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75      rillig   6146: <pre class="programlisting">
1.100     rillig   6147: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6148: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    6149: </pre>
1.75      rillig   6150: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6151: package and has no meaning outside it.</p>
                   6152: </div>
                   6153: <div class="sect2" lang="en">
                   6154: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6155: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   6156: <p>The automatic copying of config files can be toggled by setting the
                   6157: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6158: installation.</p>
                   6159: </div>
                   6160: </div>
                   6161: <div class="sect1" lang="en">
                   6162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6163: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   6164: <p>System startup scripts are special files because they must be
                   6165: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  6166: 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.75      rillig   6167: can be used.  However, pkginstall provides a special mechanism to handle
                   6168: these files.</p>
                   6169: <p>In order to provide system startup scripts, the package has
                   6170: to:</p>
                   6171: <div class="orderedlist"><ol type="1">
1.76      rillig   6172: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   6173:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   6174:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76      rillig   6175:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75      rillig   6176: <li>
                   6177: <p>Tell pkginstall to handle it, appending the name of the script,
                   6178:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6179:     Continuing the previous example:</p>
                   6180: <pre class="programlisting">
1.100     rillig   6181: RCD_SCRIPTS+=   cupsd
1.1       grant    6182: </pre>
1.75      rillig   6183: </li>
                   6184: </ol></div>
                   6185: <p>Once this is done, pkginstall will do the following steps for each
                   6186: script in an automated fashion:</p>
                   6187: <div class="orderedlist"><ol type="1">
                   6188: <li><p>Process the file found in the files directory applying all the
1.76      rillig   6189:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6190:     variable.</p></li>
                   6191: <li><p>Copy the script from the files directory to the examples
1.76      rillig   6192:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6193:     that this master file must be explicitly registered in the
1.76      rillig   6194:     <code class="filename">PLIST</code>.</p></li>
1.75      rillig   6195: <li><p>Add code to the installation scripts to copy the startup script
                   6196:     from the examples hierarchy into the system-wide startup scripts
                   6197:     directory.</p></li>
                   6198: </ol></div>
                   6199: <div class="sect2" lang="en">
                   6200: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6201: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6202: <p>The automatic copying of config files can be toggled by setting the
                   6203: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6204: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6205: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6206: matter what the value of this variable is.</p>
                   6207: </div>
                   6208: </div>
                   6209: <div class="sect1" lang="en">
                   6210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6211: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   6212: <p>If a package needs to create special users and/or groups during
                   6213: installation, it can do so by using the pkginstall framework.</p>
                   6214: <p>Users can be created by adding entries to the
                   6215: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6216: syntax:</p>
                   6217: <pre class="programlisting">
1.100     rillig   6218: user:group
1.1       grant    6219: </pre>
1.87      wiz      6220: <p>Further specification of user details may be done by setting
                   6221: per-user variables.
                   6222: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6223: numeric UID for the user.
                   6224: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6225: user's description or comment.
                   6226: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6227: user's home directory, and defaults to
                   6228: <code class="filename">/nonexistent</code> if not specified.
                   6229: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6230: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6231: not specified.</p>
1.75      rillig   6232: <p>Similarly, groups can be created by adding entries to the
                   6233: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6234: <pre class="programlisting">
1.100     rillig   6235: group
1.1       grant    6236: </pre>
1.93      rillig   6237: <p>The numeric GID of the group may be set by defining
1.75      rillig   6238: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6239: <p>If a package needs to create the users and groups at an earlier
                   6240: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6241: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6242: indicate the phase before which the users and groups are created.  In
                   6243: this case, the numeric UIDs and GIDs of the created users and groups
                   6244: are automatically hardcoded into the final installation scripts.</p>
                   6245: </div>
                   6246: <div class="sect1" lang="en">
                   6247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6248: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   6249: <p>Packages that install system shells should register them in the shell
1.76      rillig   6250: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6251: administrator.  This must be done from the installation scripts to keep
                   6252: binary packages working on any system.  pkginstall provides an easy way to
                   6253: accomplish this task.</p>
                   6254: <p>When a package provides a shell interpreter, it has to set the
                   6255: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6256: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6257: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75      rillig   6258: <pre class="programlisting">
1.100     rillig   6259: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6260: </pre>
1.75      rillig   6261: <div class="sect2" lang="en">
                   6262: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6263: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6264: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6265: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6266: environment variable to <code class="literal">NO</code>.</p>
                   6267: </div>
                   6268: </div>
                   6269: <div class="sect1" lang="en">
                   6270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6271: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   6272: <p>Packages that install X11 fonts should update the database files
                   6273: that index the fonts within each fonts directory.  This can easily be
                   6274: accomplished within the pkginstall framework.</p>
                   6275: <p>When a package installs X11 fonts, it must list the directories in
                   6276: which fonts are installed in the
                   6277: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6278: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6279: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6280: installation scripts to run the appropriate commands to update the fonts
                   6281: database files within each of those directories.  For convenience, if the
                   6282: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6283: installation prefix.  Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   6284: <pre class="programlisting">
1.100     rillig   6285: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6286: </pre>
1.75      rillig   6287: <div class="sect2" lang="en">
                   6288: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6289: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6290: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6291: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6292: environment variable to <code class="literal">NO</code>.</p>
                   6293: </div>
                   6294: </div>
                   6295: </div>
                   6296: <div class="chapter" lang="en">
                   6297: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6298: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   6299: <div class="toc">
                   6300: <p><b>Table of Contents</b></p>
                   6301: <dl>
1.106     rillig   6302: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.116     rillig   6303: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106     rillig   6304: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   6305: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   6306: </dl>
                   6307: </div>
                   6308: <p>Many packages have the ability to be built to support different
1.76      rillig   6309: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6310: in pkgsrc that provides generic handling of those options that
                   6311: determine different ways in which the packages can be built.  It's
                   6312: possible for the user to specify exactly which sets of options will be
                   6313: built into a package or to allow a set of global default options
                   6314: apply.</p>
1.107     rillig   6315: <p>There are two broad classes of behaviors that one might want to
                   6316: control via options.  One is whether some particular feature is
                   6317: enabled in a program that will be built anyway, often by including or
                   6318: not including a dependency on some other package.  The other is
                   6319: whether or not an additional program will be built as part of the
                   6320: package.  Generally, it is better to make a split package for such
                   6321: additional programs instead of using options, because it enables
                   6322: binary packages to be built which can then be added separately.  For
                   6323: example, the foo package might have minimal dependencies (those
                   6324: packages without which foo doesn't make sense), and then the foo-gfoo
                   6325: package might include the GTK frontend program gfoo.  This is better
                   6326: than including a gtk option to foo that adds gfoo, because either that
                   6327: option is default, in which case binary users can't get foo without
                   6328: gfoo, or not default, in which case they can't get gfoo.  With split
                   6329: packages, they can install foo without having GTK, and later decide to
                   6330: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6331: source users too, avoiding the need for rebuilds.</p>
                   6332: <p>Plugins with widely varying dependencies should usually be split
                   6333: instead of options.</p>
                   6334: <p>It is often more work to maintain split packages, especially if
                   6335: the upstream package does not support this.  The decision of split
                   6336: vs. option should be made based on the likelihood that users will want
                   6337: or object to the various pieces, the size of the dependencies that are
                   6338: included, and the amount of work.</p>
                   6339: <p>A further consideration is licensing.  Non-free parts, or parts
                   6340: that depend on non-free dependencies (especially plugins) should
                   6341: almost always be split if feasible.</p>
1.75      rillig   6342: <div class="sect1" lang="en">
                   6343: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6344: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   6345: <p>Global default options are listed in
                   6346: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6347: that should be built into every package if that option is supported.
1.110     hubertf  6348: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   6349: </div>
                   6350: <div class="sect1" lang="en">
                   6351: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6352: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   6353: </h2></div></div></div>
1.75      rillig   6354: <p>The following example shows how
1.76      rillig   6355: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6356: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6357: <code class="filename">Makefile</code>, or in a file,
                   6358: e.g. <code class="filename">options.mk</code>, that is included by the
                   6359: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6360: <pre class="programlisting">
1.100     rillig   6361: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6362: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6363: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6364: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6365: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6366: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6367: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6368: 
                   6369: .include "../../mk/bsd.prefs.mk"
                   6370: 
                   6371: # this package was previously named wibble2
                   6372: .if defined(PKG_OPTIONS.wibble2)
                   6373: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6374: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6375:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6376: .endif
                   6377: 
                   6378: .include "../../mk/bsd.options.mk"
                   6379: 
                   6380: # Package-specific option-handling
                   6381: 
                   6382: ###
                   6383: ### FOO support
                   6384: ###
                   6385: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6386: CONFIGURE_ARGS+=    --enable-foo
                   6387: .endif
                   6388: 
                   6389: ###
                   6390: ### LDAP support
                   6391: ###
                   6392: .if !empty(PKG_OPTIONS:Mldap)
                   6393: .  include "../../databases/openldap-client/buildlink3.mk"
                   6394: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6395: .endif
                   6396: 
                   6397: ###
                   6398: ### database support
                   6399: ###
                   6400: .if !empty(PKG_OPTIONS:Mmysql)
                   6401: .  include "../../mk/mysql.buildlink3.mk"
                   6402: .endif
                   6403: .if !empty(PKG_OPTIONS:Mpgsql)
                   6404: .  include "../../mk/pgsql.buildlink3.mk"
                   6405: .endif
1.75      rillig   6406: </pre>
                   6407: <p>The first section contains the information about which build
                   6408: options are supported by the package, and any default options settings
                   6409: if needed.</p>
                   6410: <div class="orderedlist"><ol type="1">
                   6411: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110     hubertf  6412: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   6413: options.  It should be set to
1.78      rillig   6414: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6415: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6416: at the point where the options are processed.</p></li>
1.75      rillig   6417: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6418: build options supported by the package.</p></li>
                   6419: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6420: list of names of groups of mutually exclusive options.  The options in
                   6421: each group are listed in
                   6422: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6423: The most specific setting of any option from the group takes
                   6424: precedence over all other options in the group.  Options from the
                   6425: groups will be automatically added to
                   6426: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6427: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6428: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6429: packages will fail if no option from the group is
                   6430: selected.</p></li>
                   6431: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6432: of names of sets of options.  At least one option from each set must
                   6433: be selected.  The options in each set are listed in
                   6434: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6435: Options from the sets will be automatically added to
                   6436: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6437: fail if no option from the set is selected.</p></li>
                   6438: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6439: build options which are enabled by default.</p></li>
                   6440: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6441: of
                   6442: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.110     hubertf  6443: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   6444: their option counterparts.  Pairs should be added with
                   6445: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6446: warning will be issued if the user uses a legacy
                   6447: variable.</p></li>
                   6448: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6449: of
                   6450: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6451: pairs that map options that have been renamed to their new
                   6452: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6453: the listing of global legacy options.  A warning will be issued if
                   6454: the user uses a legacy option.</p></li>
                   6455: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6456: options implied by deprecated variables used.  This can be used for
                   6457: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6458: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6459: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6460: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6461: a list of warnings about deprecated variables or options used, and
                   6462: what to use instead.</p></li>
                   6463: </ol></div>
                   6464: <p>A package should never modify
                   6465: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6466: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6467: To suggest a default set of options, use
                   6468: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6469: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6470: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6471: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6472: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6473: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6474: happen with platform-specific options if none of them is supported on
                   6475: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6476: empty list and the package is otherwise treated as not using the
                   6477: options framework.</p>
1.76      rillig   6478: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6479: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6480: build options, properly filtered to remove unsupported and duplicate
                   6481: options.</p>
                   6482: <p>The remaining sections contain the logic that is specific to
                   6483: each option.  The correct way to check for an option is to check
                   6484: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6485: <pre class="programlisting">
1.100     rillig   6486: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6487: </pre>
                   6488: </div>
                   6489: <div class="sect1" lang="en">
                   6490: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6491: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   6492: <p>Options that enable similar features in different packages (like
                   6493: optional support for a library) should use a common name in all
                   6494: packages that support it (like the name of the library).  If another
                   6495: package already has an option with the same meaning, use the same
                   6496: name.</p>
                   6497: <p>Options that enable features specific to one package, where it's
                   6498: unlikely that another (unrelated) package has the same (or a similar)
                   6499: optional feature, should use a name prefixed with
                   6500: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6501: <p>If a group of related packages share an optional feature
                   6502: specific to that group, prefix it with the name of the
                   6503: &#8220;<span class="quote">main</span>&#8221; package
                   6504: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6505: <p>For new options, add a line to
1.76      rillig   6506: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6507: fields, separated by tab.  The first field is the option name, the
                   6508: second its description.  The description should be a whole sentence
                   6509: (starting with an uppercase letter and ending with a period) that
                   6510: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6511: support.</span>&#8221; The file is sorted by option names.</p>
                   6512: </div>
1.107     rillig   6513: <div class="sect1" lang="en">
                   6514: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6515: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  6516: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107     rillig   6517: different dependencies based on the options with which the package was
                   6518: built. For querying these options, the file
                   6519: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6520: typical example looks like this:</p>
                   6521: <pre class="programlisting">
                   6522: pkgbase := libpurple
                   6523: .include "../../mk/pkg-build-options.mk"
                   6524: 
                   6525: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6526: ...
                   6527: .endif
                   6528: </pre>
                   6529: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6530: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6531: options of the libpurple package, which can then be queried like
                   6532: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6533: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6534: details.</p>
                   6535: </div>
1.75      rillig   6536: </div>
                   6537: <div class="chapter" lang="en">
                   6538: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6539: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   6540: <div class="toc">
                   6541: <p><b>Table of Contents</b></p>
                   6542: <dl>
1.106     rillig   6543: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6544: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6545: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6546: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.116     rillig   6547: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106     rillig   6548: <dd><dl>
                   6549: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6550: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6551: </dl></dd>
1.116     rillig   6552: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
                   6553: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
                   6554: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
                   6555: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
                   6556: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
                   6557: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
                   6558: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
                   6559: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
                   6560: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
                   6561: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106     rillig   6562: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6563: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   6564: </dl>
                   6565: </div>
                   6566: <div class="sect1" lang="en">
                   6567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6568: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   6569: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6570:     built. Building a package is separated into different
                   6571:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6572:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   6573:     described in the following sections. Each phase is splitted into
                   6574:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6575:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6576:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6577:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6578:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6579: <p>Never override the regular targets (like
                   6580:     <code class="varname">fetch</code>), if you have to, override the
                   6581:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6582: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6583:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6584:     the local system and then extracted. After any pkgsrc-specific patches
                   6585:     to compile properly are applied, the software can be configured, then
                   6586:     built (usually by compiling), and finally the generated binaries, etc.
                   6587:     can be put into place on the system.</p>
1.97      rillig   6588: <p>To get more details about what is happening at each step,
                   6589:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6590:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6591:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6592: </div>
                   6593: <div class="sect1" lang="en">
                   6594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6595: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   6596: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6597:     the next section, here's a brief discussion on where programs are
                   6598:     installed, and which variables influence this.</p>
1.75      rillig   6599: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6600:     where all files of the final program shall be installed. It is
                   6601:     usually set to <code class="varname">LOCALBASE</code>
                   6602:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6603:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6604:     <code class="varname">PREFIX</code> needs to be put
                   6605:     into the various places in the program's source where paths to
1.110     hubertf  6606:     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.75      rillig   6607: <p>When choosing which of these variables to use,
1.87      wiz      6608:     follow the following rules:</p>
1.75      rillig   6609: <div class="itemizedlist"><ul type="disc">
1.88      wiz      6610: <li><p><code class="varname">PREFIX</code> always points to the location
                   6611:        where the current pkg will be installed.  When referring to a
                   6612:        pkg's own installation path, use
                   6613:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6614: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6615:        are installed.  If you need to construct a -I or -L argument
                   6616:        to the compiler to find includes and libraries installed by
                   6617:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
1.87      wiz      6618:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6619:        installed all packages in <code class="filename">/usr/local</code>. As
                   6620:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6621:        administrator, this variable is a misnomer.</p></li>
1.88      wiz      6622: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6623:        distribution (from xsrc, etc.) is installed. When looking for
                   6624:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6625:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6626: <li>
                   6627: <p>X11-based packages are special in that they may be
                   6628:        installed in either <code class="varname">X11BASE</code> or
                   6629:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6630: <p>Usually, X11 packages should be installed under
1.88      wiz      6631:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6632:        will need to include
                   6633:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6634:        request the presence of X11 and to get the right compilation
                   6635:        flags.</p>
1.75      rillig   6636: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6637:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6638:        files. These packages are special and they must be placed under
                   6639:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6640:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6641:        your package.</p>
1.75      rillig   6642: <p>Some notes: If you need
1.87      wiz      6643:        to find includes or libraries installed by a pkg that has
                   6644:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6645:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6646:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6647:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6648:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6649:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
1.87      wiz      6650:        is enabled by default.</p>
1.75      rillig   6651: </li>
1.88      wiz      6652: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6653:        the installed location of an X11
                   6654:        package. <code class="varname">X11PREFIX</code> will be set to
                   6655:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6656:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6657:        installed.</p></li>
                   6658: <li>
                   6659: <p>If xpkgwedge is installed, it is possible to have some
                   6660:        packages installed in <code class="varname">X11BASE</code> and some in
                   6661:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6662:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6663:        definition can be used. It takes pairs in the format
1.110     hubertf  6664:        &#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      6665:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6666:        of the installed package &lt;package&gt;, or
                   6667:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6668:        installed.</p>
1.75      rillig   6669: <p>This is best illustrated by example.</p>
                   6670: <p>The following lines are taken from
1.87      wiz      6671:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6672: <pre class="programlisting">
1.100     rillig   6673: EVAL_PREFIX+=           GTKDIR=gtk+
                   6674: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6675: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6676: CONFIGURE_ARGS+=        --enable-multibyte
                   6677: </pre>
1.88      wiz      6678: <p>Specific defaults can be defined for the packages
                   6679:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6680:        definition of the form:</p>
1.75      rillig   6681: <pre class="programlisting">
1.100     rillig   6682: GTKDIR_DEFAULT= ${LOCALBASE}
                   6683: </pre>
1.75      rillig   6684: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6685:        to the first definition in
                   6686:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6687: </li>
1.76      rillig   6688: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110     hubertf  6689:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      6690:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6691:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6692: </ul></div>
                   6693: </div>
                   6694: <div class="sect1" lang="en">
                   6695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6696: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 6697: <p>When building a package, various directories are used to store
1.87      wiz      6698:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6699:     directories are explained here.</p>
1.75      rillig   6700: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6701:     are two common base directories for these relative directories:
                   6702:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6703:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6704:     inside the package itself.</p>
1.75      rillig   6705: <div class="variablelist"><dl>
                   6706: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6707: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6708:       root directory. Generally, you don't need
                   6709:       it.</p></dd>
1.97      rillig   6710: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6711: <dd><p>This is an absolute pathname that points to the
                   6712:       current package.</p></dd>
1.75      rillig   6713: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6714: <dd><p>This is a pathname relative to
1.87      wiz      6715:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6716:       package.</p></dd>
1.75      rillig   6717: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6718: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6719:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6720:       directory. It also contains temporary directories and log files used by
                   6721:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6722:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6723: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6724: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6725:       where the distfiles are extracted. It is usually a direct subdirectory
                   6726:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6727:       that isn't hidden. This variable may be changed by a package
                   6728:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6729: </dl></div>
1.114     jmcneill 6730: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6731:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   6732:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 6733:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6734:     If users would like to have their pkgsrc trees behave in a
                   6735:     read-only manner, then the value of
                   6736:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6737:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   6738: </div>
                   6739: <div class="sect1" lang="en">
                   6740: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6741: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  6742: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      6743:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6744:     phase. This will automatically run all phases that are required for this
                   6745:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  6746:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      6747:     the package will be built, but not installed.</p>
1.75      rillig   6748: </div>
                   6749: <div class="sect1" lang="en">
                   6750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6751: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6752: <p>The first step in building a package is to fetch the
1.88      wiz      6753:     distribution files (distfiles) from the sites that are providing
                   6754:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6755:     phase.</p>
1.81      rillig   6756: <div class="sect2" lang="en">
                   6757: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6758: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      6759: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6760:       defines all URLs from where the distfile, whose name is
                   6761:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6762:       fetched. The more complicated cases are described
                   6763:       below.</p>
                   6764: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6765:       the list of distfiles that have to be fetched. Its value
                   6766:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6767:       so that most packages don't need to define it at all.
                   6768:       <code class="varname">EXTRACT_SUFX</code> is
                   6769:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6770:       freely. Note that if your package requires additional
                   6771:       distfiles to the default one, you cannot just append the
                   6772:       additional filenames using the <code class="literal">+=</code>
                   6773:       operator, but you have write for example:</p>
1.81      rillig   6774: <pre class="programlisting">
1.100     rillig   6775: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6776: </pre>
1.88      wiz      6777: <p>Each distfile is fetched from a list of sites, usually
                   6778:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6779:       <code class="varname">DISTFILES</code> or multiple
                   6780:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6781:       set
                   6782:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6783:       to the list of URLs where the file
                   6784:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6785:       (including the suffix) can be found.</p>
                   6786: <pre class="programlisting">
1.100     rillig   6787: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6788: DISTFILES+=     foo-file.tar.gz
                   6789: SITES.foo-file.tar.gz= \
                   6790: http://www.somewhere.com/somehow/ \
                   6791: http://www.somewhereelse.com/mirror/somehow/
                   6792: </pre>
1.81      rillig   6793: <p>When actually fetching the distfiles, each item from
1.88      wiz      6794:       <code class="varname">MASTER_SITES</code> or
                   6795:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6796:       appended to it, without an intermediate slash. Therefore,
                   6797:       all site values have to end with a slash or other separator
                   6798:       character. This allows for example to set
                   6799:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6800:       that gets the name of the distfile as a parameter. In this
                   6801:       case, the definition would look like:</p>
1.81      rillig   6802: <pre class="programlisting">
1.100     rillig   6803: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6804: </pre>
1.81      rillig   6805: <p>There are some predefined values for
1.88      wiz      6806:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6807:       packages.  The names of the variables should speak for
                   6808:       themselves.</p>
                   6809: <pre class="programlisting">
1.100     rillig   6810: ${MASTER_SITE_APACHE}
                   6811: ${MASTER_SITE_BACKUP}
                   6812: ${MASTER_SITE_CYGWIN}
                   6813: ${MASTER_SITE_DEBIAN}
                   6814: ${MASTER_SITE_FREEBSD}
                   6815: ${MASTER_SITE_FREEBSD_LOCAL}
                   6816: ${MASTER_SITE_GENTOO}
                   6817: ${MASTER_SITE_GNOME}
                   6818: ${MASTER_SITE_GNU}
                   6819: ${MASTER_SITE_GNUSTEP}
                   6820: ${MASTER_SITE_IFARCHIVE}
                   6821: ${MASTER_SITE_KDE}
                   6822: ${MASTER_SITE_MOZILLA}
                   6823: ${MASTER_SITE_MYSQL}
                   6824: ${MASTER_SITE_OPENOFFICE}
                   6825: ${MASTER_SITE_PERL_CPAN}
                   6826: ${MASTER_SITE_PGSQL}
                   6827: ${MASTER_SITE_R_CRAN}
                   6828: ${MASTER_SITE_SOURCEFORGE}
                   6829: ${MASTER_SITE_SOURCEFORGE_JP}
                   6830: ${MASTER_SITE_SUNSITE}
                   6831: ${MASTER_SITE_SUSE}
                   6832: ${MASTER_SITE_TEX_CTAN}
                   6833: ${MASTER_SITE_XCONTRIB}
                   6834: ${MASTER_SITE_XEMACS}
                   6835: </pre>
1.88      wiz      6836: <p>Some explanations for the less self-explaining ones:
                   6837:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110     hubertf  6838:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
                   6839:       package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/LOCAL_PORTS/</a>.</p>
1.88      wiz      6840: <p>If you choose one of these predefined sites, you may
                   6841:       want to specify a subdirectory of that site. Since these
                   6842:       macros may expand to more than one actual site, you
                   6843:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6844:       specify a subdirectory:</p>
1.81      rillig   6845: <pre class="programlisting">
1.100     rillig   6846: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6847: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6848: </pre>
1.81      rillig   6849: <p>Note the trailing slash after the subdirectory
1.88      wiz      6850:       name.</p>
1.81      rillig   6851: </div>
                   6852: <div class="sect2" lang="en">
                   6853: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6854: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6855: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6856:       all the distfiles exist in a local directory
1.93      rillig   6857:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6858:       user). If the files do not exist, they are fetched using
                   6859:       commands of the form</p>
1.75      rillig   6860: <pre class="programlisting">
1.100     rillig   6861: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6862: </pre>
1.88      wiz      6863: <p>where <code class="literal">${site}</code> varies through
                   6864:       several possibilities in turn: first,
                   6865:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6866:       sites specified in either <code class="varname">SITES.file</code> if
                   6867:       defined, else <code class="varname">MASTER_SITES</code> or
                   6868:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6869:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6870:       all except the first and the last can be optionally sorted
                   6871:       by the user, via setting either
                   6872:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6873:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6874:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  6875: <p> The specific command and arguments used depend on the
                   6876:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6877:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   6878: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6879:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6880:       distfiles, if they are freely distributable.  Packages setting
                   6881:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   6882:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
                   6883:       mirrored.</p>
1.81      rillig   6884: </div>
1.75      rillig   6885: </div>
                   6886: <div class="sect1" lang="en">
                   6887: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6888: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6889: <p>After the distfile(s) are fetched, their checksum is
                   6890:     generated and compared with the checksums stored in the
                   6891:     distinfo file. If the checksums don't match, the build is
                   6892:     aborted. This is to ensure the same distfile is used for
                   6893:     building, and that the distfile wasn't changed, e.g. by some
                   6894:     malign force, deliberately changed distfiles on the master
                   6895:     distribution site or network lossage.</p>
1.75      rillig   6896: </div>
                   6897: <div class="sect1" lang="en">
                   6898: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6899: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6900: <p>When the distfiles are present on the local system, they
1.88      wiz      6901:     need to be extracted, as they usually come in the form of some
                   6902:     compressed archive format.</p>
1.75      rillig   6903: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6904:     extracted. If you only need some of them, you can set the
                   6905:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6906:     files.</p>
                   6907: <p>Extracting the files is usually done by a little
1.93      rillig   6908:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6909:     already knows how to extract various archive formats, so most
                   6910:     likely you will not need to change anything here. But if you
                   6911:     need, the following variables may help you:</p>
1.75      rillig   6912: <div class="variablelist"><dl>
                   6913: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6914: <dd><p>Use these variables to override the default
1.88      wiz      6915:       options for an extract command, which are defined in
1.93      rillig   6916:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6917: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6918: <dd><p>This variable can be set to
1.114     jmcneill 6919:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6920:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      6921:       absolute pathname pointing to the command with which tar
1.114     jmcneill 6922:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6923:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   6924: </dl></div>
1.88      wiz      6925: <p>If the <code class="filename">extract</code> program doesn't
                   6926:     serve your needs, you can also override the
                   6927:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6928:     command used for extracting the files. This command is
                   6929:     executed in the <code class="filename">${WRKSRC}</code>
                   6930:     directory. During execution of this command, the shell
                   6931:     variable <code class="varname">extract_file</code> holds the absolute
                   6932:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6933: <p>And if that still does not suffice, you can override the
1.88      wiz      6934:     <code class="varname">do-extract</code> target in the package
                   6935:     Makefile.</p>
1.75      rillig   6936: </div>
                   6937: <div class="sect1" lang="en">
                   6938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6939: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6940: <p>After extraction, all the patches named by the
1.88      wiz      6941:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6942:     subdirectory of the package as well as in
                   6943:     $LOCALPATCHES/$PKGPATH (e.g.
                   6944:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6945:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6946:     <code class="filename">.gz</code> are uncompressed before they are
                   6947:     applied, files ending in <code class="filename">.orig</code> or
                   6948:     <code class="filename">.rej</code> are ignored. Any special options to
1.110     hubertf  6949:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
                   6950:     <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>
                   6951: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      6952:     it fail if the patches apply with some lines of fuzz. Please
                   6953:     fix (regen) the patches so that they apply cleanly. The
                   6954:     rationale behind this is that patches that don't apply cleanly
                   6955:     may end up being applied in the wrong place, and cause severe
                   6956:     harm there.</p>
1.75      rillig   6957: </div>
                   6958: <div class="sect1" lang="en">
                   6959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6960: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  6961: <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.88      wiz      6962:     </p>
1.75      rillig   6963: </div>
                   6964: <div class="sect1" lang="en">
                   6965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6966: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6967: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6968:     linkers. The following variables can be used to tweak the
                   6969:     wrappers.</p>
1.75      rillig   6970: <div class="variablelist"><dl>
                   6971: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6972: <dd><p>The command used to print progress
1.88      wiz      6973:       messages. Does nothing by default. Set to
                   6974:       <code class="literal">${ECHO}</code> to see the progress
                   6975:       messages.</p></dd>
1.75      rillig   6976: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6977: <dd><p>This variable can be set to
1.88      wiz      6978:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6979:       depending on whether you want additional information in the
                   6980:       wrapper log file.</p></dd>
1.75      rillig   6981: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6982: <dd><p>This variable can be set to
1.88      wiz      6983:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6984:       on whether the wrapper should use its cache, which will
                   6985:       improve the speed. The default value is
                   6986:       <code class="literal">yes</code>, but is forced to
                   6987:       <code class="literal">no</code> if the platform does not support
                   6988:       it.</p></dd>
1.75      rillig   6989: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6990: <dd><p>A list of reordering commands. A reordering
                   6991:       command has the form
                   6992:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6993:       It ensures that that
                   6994:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6995:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6996:       </p></dd>
1.75      rillig   6997: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6998: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6999:       investigate further]</p></dd>
1.75      rillig   7000: </dl></div>
                   7001: </div>
                   7002: <div class="sect1" lang="en">
                   7003: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7004: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      7005: <p>Most pieces of software need information on the header
                   7006:     files, system calls, and library routines which are available
                   7007:     on the platform they run on. The process of determining this
                   7008:     information is known as configuration, and is usually
                   7009:     automated. In most cases, a script is supplied with the
                   7010:     distfiles, and its invocation results in generation of header
                   7011:     files, Makefiles, etc.</p>
                   7012: <p>If the package contains a configure script, this can be
                   7013:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   7014:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   7015:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   7016:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   7017:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   7018: <pre class="programlisting">
1.100     rillig   7019: .for d in ${CONFIGURE_DIRS}
                   7020:         cd ${WRKSRC} \
                   7021:         &amp;&amp; cd ${d} \
                   7022:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   7023: .endfor
                   7024: </pre>
1.88      wiz      7025: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   7026:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   7027:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   7028:     configure script is run with the environment
                   7029:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   7030:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   7031:     <code class="varname">CONFIGURE_ENV</code>,
                   7032:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   7033:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   7034:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   7035:     package.</p>
                   7036: <p>If the program uses an <code class="filename">Imakefile</code>
                   7037:     for configuration, the appropriate steps can be invoked by
                   7038:     setting <code class="varname">USE_IMAKE</code> to
                   7039:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   7040:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97      rillig   7041:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   7042:     xmkmf's environment by adding them to the
                   7043:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   7044: <p>If the program uses <code class="filename">cmake</code>
                   7045:     for configuration, the appropriate steps can be invoked by
                   7046:     setting <code class="varname">USE_CMAKE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7047:     You can add variables to cmake's environment by adding them to the
                   7048:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   7049:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   7050:     The top directory argument is given by the
                   7051:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   7052:     &#8220;<span class="quote">.</span>&#8221; (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   7053: <p>If there is no configure step at all, set
                   7054:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   7055: </div>
                   7056: <div class="sect1" lang="en">
                   7057: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7058: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      7059: <p>For building a package, a rough equivalent of the
                   7060:     following code is executed.</p>
1.75      rillig   7061: <pre class="programlisting">
1.100     rillig   7062: .for d in ${BUILD_DIRS}
                   7063:         cd ${WRKSRC} \
                   7064:         &amp;&amp; cd ${d} \
                   7065:         &amp;&amp; env ${MAKE_ENV} \
                   7066:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   7067:                 -f ${MAKE_FILE} \
                   7068:                 ${BUILD_TARGET}
                   7069: .endfor
                   7070: </pre>
1.88      wiz      7071: <p><code class="varname">BUILD_DIRS</code> (default:
                   7072:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   7073:     <code class="varname">WRKSRC</code>. In each of these directories,
                   7074:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   7075:     <code class="varname">MAKE_ENV</code> and arguments
                   7076:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   7077:     <code class="varname">MAKE_ENV</code>,
                   7078:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   7079:     <code class="varname">MAKE_FILE</code> and
                   7080:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   7081:     package.</p>
1.75      rillig   7082: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88      wiz      7083:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   7084:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   7085:     default value of <code class="varname">MAKE_FILE</code> is
                   7086:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   7087:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
1.97      rillig   7088: <p>If there is no build step at all, set
                   7089:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   7090: </div>
                   7091: <div class="sect1" lang="en">
                   7092: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7093: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   7094: <p>[TODO]</p>
                   7095: </div>
                   7096: <div class="sect1" lang="en">
                   7097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7098: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   7099: <p>Once the build stage has completed, the final step is to
1.88      wiz      7100:     install the software in public directories, so users can
                   7101:     access the programs and files.</p>
1.75      rillig   7102: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      7103:     equivalent of the following code is executed. Additionally,
                   7104:     before and after this code, much magic is performed to do
                   7105:     consistency checks, registering the package, and so on.</p>
                   7106: <pre class="programlisting">
1.100     rillig   7107: .for d in ${INSTALL_DIRS}
                   7108:         cd ${WRKSRC} \
                   7109:         &amp;&amp; cd ${d} \
                   7110:         &amp;&amp; env ${MAKE_ENV} \
                   7111:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7112:                 -f ${MAKE_FILE} \
                   7113:                 ${INSTALL_TARGET}
                   7114: .endfor
                   7115: </pre>
1.75      rillig   7116: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      7117:     <span class="emphasis"><em>build</em></span> phase.
                   7118:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7119:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   7120:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   7121:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   7122:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7123:     defined.</p>
1.75      rillig   7124: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      7125:     variables are useful. They are all variations of the
1.110     hubertf  7126:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      7127:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7128:     install command. The specialized variants, together with their
                   7129:     intended use, are:</p>
1.75      rillig   7130: <div class="variablelist"><dl>
                   7131: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      7132: <dd><p>directories that contain
                   7133:       binaries</p></dd>
1.75      rillig   7134: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      7135: <dd><p>directories that contain
                   7136:       scripts</p></dd>
1.75      rillig   7137: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      7138: <dd><p>directories that contain shared and static
                   7139:       libraries</p></dd>
1.75      rillig   7140: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      7141: <dd><p>directories that contain data
                   7142:       files</p></dd>
1.75      rillig   7143: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      7144: <dd><p>directories that contain man
                   7145:       pages</p></dd>
1.75      rillig   7146: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      7147: <dd><p>binaries that can be stripped from debugging
                   7148:       symbols</p></dd>
1.75      rillig   7149: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      7150: <dd><p>binaries that cannot be
                   7151:       stripped</p></dd>
1.75      rillig   7152: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      7153: <dd><p>game
                   7154:       binaries</p></dd>
1.75      rillig   7155: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      7156: <dd><p>shared and static
                   7157:       libraries</p></dd>
1.75      rillig   7158: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7159: <dd><p>data files</p></dd>
                   7160: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      7161: <dd><p>data files for
                   7162:       games</p></dd>
1.75      rillig   7163: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7164: <dd><p>man pages</p></dd>
                   7165: </dl></div>
                   7166: <p>Some other variables are:</p>
                   7167: <div class="variablelist"><dl>
                   7168: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7169: <dd><p>A list of directories relative to
1.88      wiz      7170:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      7171:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7172:       The package is supposed to create all needed directories itself
                   7173:       before installing files to it and list all other directories here.
                   7174:       </p></dd>
1.75      rillig   7175: </dl></div>
1.97      rillig   7176: <p>In the rare cases that a package shouldn't install anything,
                   7177:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
                   7178:     mostly relevant for packages in the <code class="filename">regress</code>
                   7179:     category.</p>
1.75      rillig   7180: </div>
                   7181: <div class="sect1" lang="en">
                   7182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7183: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      7184: <p>Once the install stage has completed, a binary package of
                   7185:     the installed files can be built.  These binary packages can be
                   7186:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  7187:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7188:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      7189: <p>By default, the binary packages are created in
                   7190:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7191:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7192:     one for each category in the <code class="varname">CATEGORIES</code>
                   7193:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7194:     <code class="filename">pkgsrc/packages</code>.</p>
1.97      rillig   7195: <p>If there should be no binary package, set
                   7196:     <code class="varname">NO_PACKAGE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7197:     This should only be used in rare cases, like when a package
                   7198:     definitely is only usable on the machine where it is built and even
                   7199:     then, a binary package can be useful.</p>
1.88      wiz      7200: </div>
                   7201: <div class="sect1" lang="en">
                   7202: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7203: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      7204: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  7205:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      7206:     to clean the work directories of all dependencies too, use
1.110     hubertf  7207:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   7208: </div>
                   7209: <div class="sect1" lang="en">
                   7210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7211: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75      rillig   7212: <div class="variablelist"><dl>
                   7213: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      7214: <dd><p>For any of the main targets described in the
                   7215:          previous section, two auxiliary targets exist with
1.87      wiz      7216:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7217:          prefix for the main target's name.  These targets are
1.88      wiz      7218:          invoked before and after the main target is called,
                   7219:          allowing extra configuration or installation steps be
                   7220:          performed from a package's Makefile, for example, which
                   7221:          a program's configure script or install target
                   7222:          omitted.</p></dd>
1.75      rillig   7223: <dt><span class="term">do-*</span></dt>
1.88      wiz      7224: <dd><p>Should one of the main targets do the wrong thing,
                   7225:          and should there be no variable to fix this, you can
                   7226:          redefine it with the do-* target.  (Note that redefining
                   7227:          the target itself instead of the do-* target is a bad
                   7228:          idea, as the pre-* and post-* targets won't be called
                   7229:          anymore, etc.) You will not usually need to do
                   7230:          this.</p></dd>
1.75      rillig   7231: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7232: <dd>
1.110     hubertf  7233: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      7234:          you noticed some file was not installed properly, you
                   7235:          can repeat the installation with this target, which will
                   7236:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7237: <p>This is the default value of
                   7238:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  7239:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      7240:          package</strong></span>, where the defaults are
                   7241:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7242:          respectively.</p>
                   7243: </dd>
1.75      rillig   7244: <dt><span class="term">deinstall</span></dt>
                   7245: <dd>
1.110     hubertf  7246: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      7247:          current directory, effectively de-installing the
                   7248:          package. The following variables can be used to tune the
                   7249:          behaviour:</p>
1.75      rillig   7250: <div class="variablelist"><dl>
                   7251: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110     hubertf  7252: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   7253: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7254: <dd><p>Remove all packages that require (depend on)
                   7255:                the given package.  This can be used to remove any
                   7256:                packages that may have been pulled in by a given
1.110     hubertf  7257:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      7258:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7259:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7260:                likely to remove whole KDE. Works by adding
1.110     hubertf  7261:                &#8220;<span class="quote">-R</span>&#8221; to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      7262:                command line.</p></dd>
1.75      rillig   7263: </dl></div>
                   7264: </dd>
1.88      wiz      7265: <dt><span class="term">bin-install</span></dt>
                   7266: <dd><p>Install a binary package from local disk and via FTP
                   7267:          from a list of sites (see the
                   7268:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  7269:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      7270:          available anywhere.  The arguments given to
1.110     hubertf  7271:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      7272:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7273:          operation, etc.</p></dd>
1.75      rillig   7274: <dt><span class="term">update</span></dt>
                   7275: <dd>
1.88      wiz      7276: <p>This target causes the current package to be
                   7277:          updated to the latest version.  The package and all
                   7278:          depending packages first get de-installed, then current
                   7279:          versions of the corresponding packages get compiled and
                   7280:          installed.  This is similar to manually noting which
                   7281:          packages are currently installed, then performing a
1.110     hubertf  7282:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7283:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      7284:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7285:          packages.</p>
                   7286: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
1.110     hubertf  7287:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      7288:          update</strong></span> was interrupted for some reason.
                   7289:          However, in this case, make sure you don't call
1.110     hubertf  7290:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      7291:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7292:          Otherwise, you lose the ability to automatically update
                   7293:          the current package along with the dependent packages
                   7294:          you have installed.</p>
1.110     hubertf  7295: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      7296:          update</strong></span> will only work as long as the package
                   7297:          tree remains unchanged.  If the source code for one of
                   7298:          the packages to be updated has been changed, resuming
1.110     hubertf  7299:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      7300:          fail!</p>
                   7301: <p>The following variables can be used either on the
1.110     hubertf  7302:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7303:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      7304:          update</strong></span>:</p>
1.75      rillig   7305: <div class="variablelist"><dl>
                   7306: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7307: <dd><p>Install target to recursively use for the
                   7308:                updated package and the dependent packages.
                   7309:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7310:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
1.110     hubertf  7311:                <span class="command"><strong>make update</strong></span>.  Other good
1.88      wiz      7312:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7313:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7314:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7315:                endless loop!</p></dd>
1.75      rillig   7316: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7317: <dd><p>Don't clean up after updating.  Useful if
                   7318:                you want to leave the work sources of the updated
                   7319:                packages around for inspection or other purposes.
                   7320:                Be sure you eventually clean up the source tree
                   7321:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7322:                or you may run into troubles with old source code
                   7323:                still lying around on your next
1.110     hubertf  7324:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      7325:                update</strong></span>.</p></dd>
1.75      rillig   7326: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7327: <dd><p>Deinstall each package before installing
                   7328:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7329:                may be necessary if the
                   7330:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
1.110     hubertf  7331:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      7332:                update</strong></span>.</p></dd>
1.75      rillig   7333: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7334: <dd><p>Allows you to disable recursion and hardcode
                   7335:                the target for packages.  The default is
                   7336:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7337:                facilitating a recursive update of prerequisite
                   7338:                packages.  Only set
                   7339:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7340:                disable recursive updates. Use
                   7341:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7342:                set a specific target for each package to be
1.110     hubertf  7343:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      7344:                (see above).</p></dd>
1.75      rillig   7345: </dl></div>
                   7346: </dd>
                   7347: <dt><span class="term">clean-update</span></dt>
                   7348: <dd>
1.88      wiz      7349: <p>Clean the source tree for all packages that would
1.110     hubertf  7350:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      7351:          from the current directory.  This target should not be
                   7352:          used if the current package (or any of its depending
                   7353:          packages) have already been de-installed (e.g., after
1.110     hubertf  7354:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      7355:          some packages you intended to update. As a rule of
                   7356:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  7357:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      7358:          and only if you have a dirty package tree (e.g., if you
                   7359:          used <code class="varname">NOCLEAN</code>).</p>
                   7360: <p>If you are unsure about whether your tree is
1.110     hubertf  7361:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      7362:          clean</strong></span> at the top of the tree, or use the
                   7363:          following sequence of commands from the directory of the
                   7364:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  7365:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      7366:          time, otherwise you lose all the packages you wanted to
                   7367:          update!):</p>
1.87      wiz      7368: <pre class="screen">
                   7369: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7370: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7371: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7372:          </pre>
1.88      wiz      7373: <p>The following variables can be used either on the
1.110     hubertf  7374:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7375:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.75      rillig   7376: <div class="variablelist"><dl>
                   7377: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  7378: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      7379:                reconstruct the list of directories to update for
1.110     hubertf  7380:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      7381:                update</strong></span> successfully installed all
                   7382:                packages you wanted to update.  Normally, this is
1.110     hubertf  7383:                done automatically on <span class="command"><strong>make
1.88      wiz      7384:                update</strong></span>, but may have been suppressed by
                   7385:                the <code class="varname">NOCLEAN</code> variable (see
                   7386:                above).</p></dd>
1.75      rillig   7387: </dl></div>
                   7388: </dd>
1.88      wiz      7389: <dt><span class="term">replace</span></dt>
                   7390: <dd>
                   7391: <p>Update the installation of the current package.  This
                   7392:          differs from update in that it does not replace dependent
1.93      rillig   7393:          packages.  You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88      wiz      7394:          target to work.</p>
                   7395: <p><span class="emphasis"><em>Be careful when using this
                   7396:          target!</em></span> There are no guarantees that dependent
                   7397:          packages will still work, in particular they will most
1.110     hubertf  7398:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      7399:          library package whose shared library major version changed
                   7400:          between your installed version and the new one.  For this
                   7401:          reason, this target is not officially supported and only
                   7402:          recommended for advanced users.</p>
                   7403: </dd>
1.75      rillig   7404: <dt><span class="term">info</span></dt>
1.110     hubertf  7405: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      7406:          package. You can use this to check which version of a
                   7407:          package is installed.</p></dd>
                   7408: <dt><span class="term">index</span></dt>
                   7409: <dd>
                   7410: <p>This is a top-level command, i.e. it should be used in
                   7411:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7412:          database of all packages in the local pkgsrc tree, including
                   7413:          dependencies, comment, maintainer, and some other useful
                   7414:          information.  Individual entries are created by running
1.110     hubertf  7415:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      7416:          directories.  This index file is saved as
                   7417:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  7418:          verbose format by running <span class="command"><strong>make
1.88      wiz      7419:          print-index</strong></span>.  You can search in it with
1.110     hubertf  7420:          <span class="command"><strong>make search
1.88      wiz      7421:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7422:          extract a list of all packages that depend on a particular
1.110     hubertf  7423:          one by running <span class="command"><strong>make show-deps
1.88      wiz      7424:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7425: <p>Running this command takes a very long time, some
                   7426:          hours even on fast machines!</p>
                   7427: </dd>
1.75      rillig   7428: <dt><span class="term">readme</span></dt>
1.88      wiz      7429: <dd>
                   7430: <p>This target generates a
                   7431:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7432:          viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.88      wiz      7433:          contain references to any packages which are in the
                   7434:          <code class="varname">PACKAGES</code> directory on the local
                   7435:          host. The generated files can be made to refer to URLs
                   7436:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7437:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7438:          wanted to generate <code class="filename">README.html</code>
                   7439:          files which pointed to binary packages on the local
                   7440:          machine, in the directory
                   7441:          <code class="filename">/usr/packages</code>, set
                   7442:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7443:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7444:          <code class="varname">${PACKAGES}</code> directory and its
                   7445:          subdirectories will be searched for all the binary
                   7446:          packages.</p>
                   7447: <p>The target can be run at the toplevel or in category
                   7448:          directories, in which case it descends recursively.</p>
                   7449: </dd>
1.75      rillig   7450: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7451: <dd><p>This is a top-level command, run it in
                   7452:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7453:          file <code class="filename">README-all.html</code> which contains a
                   7454:          list of all packages currently available in the NetBSD
                   7455:          Packages Collection, together with the category they belong
                   7456:          to and a short description. This file is compiled from the
                   7457:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  7458:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      7459:          readme</strong></span>.</p></dd>
1.75      rillig   7460: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7461: <dd><p>This is very much the same as the
                   7462:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7463:          used when generating a pkgsrc tree to be written to a
                   7464:          CD-ROM.  This target also produces
                   7465:          <code class="filename">README.html</code> files, and can be made
                   7466:          to refer to URLs based on
                   7467:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7468:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7469: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7470: <dd><p>This target shows which distfiles and patchfiles
                   7471:          are needed to build the package
                   7472:          (<code class="varname">ALLFILES</code>, which contains all
                   7473:          <code class="varname">DISTFILES</code> and
1.87      wiz      7474:          <code class="varname">PATCHFILES</code>, but not
                   7475:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7476: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7477: <dd><p>This target shows nothing if the package is not
                   7478:          installed. If a version of this package is installed,
                   7479:          but is not the version provided in this version of
                   7480:          pkgsrc, then a warning message is displayed. This target
                   7481:          can be used to show which of your installed packages are
                   7482:          downlevel, and so the old versions can be deleted, and
                   7483:          the current ones added.</p></dd>
1.75      rillig   7484: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7485: <dd><p>This target shows the directory in the pkgsrc
                   7486:          hierarchy from which the package can be built and
                   7487:          installed. This may not be the same directory as the one
                   7488:          from which the package was installed. This target is
                   7489:          intended to be used by people who may wish to upgrade
                   7490:          many packages on a single host, and can be invoked from
                   7491:          the top-level pkgsrc Makefile by using the
1.87      wiz      7492:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
1.75      rillig   7493: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7494: <dd><p>This target shows which installed packages match
                   7495:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7496:          if out of date dependencies are causing build
                   7497:          problems.</p></dd>
1.75      rillig   7498: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7499: <dd><p>After a package is installed, check all its
                   7500:          binaries and (on ELF platforms) shared libraries to see
                   7501:          if they find the shared libs they need.  Run by default
1.110     hubertf  7502:          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.75      rillig   7503: <dt><span class="term">print-PLIST</span></dt>
                   7504: <dd>
                   7505: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
1.88      wiz      7506:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  7507:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      7508:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7509:          to care for shared libs etc., but it is
1.87      wiz      7510:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7511:          result before putting it into
                   7512:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7513:          diff the output of this command against an already
                   7514:          existing <code class="filename">PLIST</code> file.</p>
1.110     hubertf  7515: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      7516:          other methods that don't update file access times, be
                   7517:          sure to add these files manually to your
1.87      wiz      7518:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7519:          -newer</span>&#8221; command used by this target won't catch
                   7520:          them!</p>
1.116     rillig   7521: <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, &#8220;Tweaking output of make print-PLIST&#8221;</a> for more
1.87      wiz      7522:          information on this target.</p>
1.75      rillig   7523: </dd>
                   7524: <dt><span class="term">bulk-package</span></dt>
                   7525: <dd>
1.88      wiz      7526: <p>Used to do bulk builds. If an appropriate binary
                   7527:          package already exists, no action is taken. If not, this
                   7528:          target will compile, install and package it (and its
                   7529:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110     hubertf  7530:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.88      wiz      7531:          After creating the binary package, the sources, the
                   7532:          just-installed package and its required packages are
                   7533:          removed, preserving free disk space.</p>
                   7534: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7535:          all packages installed on a system!</em></span></p>
1.75      rillig   7536: </dd>
                   7537: <dt><span class="term">bulk-install</span></dt>
                   7538: <dd>
1.88      wiz      7539: <p>Used during bulk-installs to install required
                   7540:          packages. If an up-to-date binary package is available,
1.110     hubertf  7541:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
                   7542:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      7543:          but the installed binary won't be removed.</p>
1.88      wiz      7544: <p>A binary package is considered
                   7545:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
1.110     hubertf  7546:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.88      wiz      7547: <div class="itemizedlist"><ul type="disc">
                   7548: <li><p>None of the package's files
                   7549:              (<code class="filename">Makefile</code>, ...) were modified
                   7550:              since it was built.</p></li>
                   7551: <li><p>None of the package's required (binary)
                   7552:              packages were modified since it was built.</p></li>
1.75      rillig   7553: </ul></div>
1.88      wiz      7554: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7555:          all packages installed on a system!</em></span></p>
1.75      rillig   7556: </dd>
                   7557: </dl></div>
                   7558: </div>
                   7559: </div>
                   7560: <div class="chapter" lang="en">
                   7561: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7562: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7563: <div class="toc">
                   7564: <p><b>Table of Contents</b></p>
                   7565: <dl>
1.106     rillig   7566: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7567: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7568: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7569: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7570: </dl>
                   7571: </div>
1.87      wiz      7572: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7573: by pkgsrc and also for individual packages to define what commands
                   7574: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7575: or for later run-time of an installed packaged (such as
                   7576: <code class="varname">DEPENDS</code>).
                   7577: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7578: package will not be used.</p>
                   7579: <p>When building a package, the replacement tools are
1.75      rillig   7580: made available in a directory (as symlinks or wrapper scripts)
                   7581: that is early in the executable search path. Just like the buildlink
1.87      wiz      7582: system, this helps with consistent builds.</p>
                   7583: <p>A tool may be needed to help build a specific package. For example,
                   7584: perl, GNU make (gmake) or yacc may be needed.</p>
                   7585: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7586: tool may be inefficient for building a package with pkgsrc.
                   7587: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7588: yacc) or a better sed.</p>
                   7589: <p>The tools used by a package can be listed by running
1.110     hubertf  7590: <span class="command"><strong>make show-tools</strong></span>.</p>
1.75      rillig   7591: <div class="sect1" lang="en">
                   7592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7593: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7594: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7595: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  7596: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7597: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   7598: These can be seen by running:
1.110     hubertf  7599: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      7600: <p>If a package needs a specific program to build
1.75      rillig   7601: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7602: to define the tools needed.</p>
1.75      rillig   7603: </div>
                   7604: <div class="sect1" lang="en">
                   7605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7606: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87      wiz      7607: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75      rillig   7608: and not the native version for a build dependency.
                   7609: And the :run means that it is used for a
                   7610: run-time dependencies also (and becomes a DEPENDS).
                   7611: The default is a build dependency which can be set with
                   7612: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7613: and pkg-config:build.)</p>
1.75      rillig   7614: <pre class="programlisting">
                   7615: USE_TOOLS+=     mktemp:pkgsrc
                   7616: USE_TOOLS+=     gmake perl:run pkg-config
                   7617: </pre>
1.87      wiz      7618: <p>When using the tools framework, a
1.75      rillig   7619: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7620: which contains the full path to the appropriate tool. For example,
                   7621: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
1.87      wiz      7622: on Linux systems.</p>
                   7623: <p>If you always need a pkgsrc version of the
1.75      rillig   7624: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7625: </p>
                   7626: </div>
                   7627: <div class="sect1" lang="en">
                   7628: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7629: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7630: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7631: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7632: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7633: the name of the common tools. For example:</p>
                   7634: <pre class="programlisting">
                   7635: .if exists(/usr/bin/bzcat)
                   7636: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7637: .elif exists(/usr/bin/bzip2)
                   7638: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7639: .endif
1.69      rillig   7640: 
1.75      rillig   7641: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7642: </pre>
                   7643: </div>
1.97      rillig   7644: <div class="sect1" lang="en">
                   7645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7646: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.97      rillig   7647: <div class="qandaset">
                   7648: <dl>
1.106     rillig   7649: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97      rillig   7650: </dt>
1.106     rillig   7651: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97      rillig   7652:        tools?</a>
                   7653: </dt>
1.106     rillig   7654: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97      rillig   7655:        package is using while being built? I want to know whether it
                   7656:        uses sed or not.</a>
                   7657: </dt>
                   7658: </dl>
                   7659: <table border="0" summary="Q and A Set">
                   7660: <col align="left" width="1%">
                   7661: <tbody>
                   7662: <tr class="question">
                   7663: <td align="left" valign="top">
1.119   ! mishka   7664: <a name="tools.new"></a><a name="id1168230286379"></a><p><b>18.4.1.</b></p>
1.97      rillig   7665: </td>
                   7666: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7667: </tr>
                   7668: <tr class="answer">
                   7669: <td align="left" valign="top"></td>
                   7670: <td align="left" valign="top"><p>TODO</p></td>
                   7671: </tr>
                   7672: <tr class="question">
                   7673: <td align="left" valign="top">
1.119   ! mishka   7674: <a name="tools.listall"></a><a name="id1168230286388"></a><p><b>18.4.2.</b></p>
1.97      rillig   7675: </td>
                   7676: <td align="left" valign="top"><p>How do I get a list of all available
                   7677:        tools?</p></td>
                   7678: </tr>
                   7679: <tr class="answer">
                   7680: <td align="left" valign="top"></td>
                   7681: <td align="left" valign="top"><p>TODO</p></td>
                   7682: </tr>
                   7683: <tr class="question">
                   7684: <td align="left" valign="top">
1.119   ! mishka   7685: <a name="tools.used"></a><a name="id1168230286396"></a><p><b>18.4.3.</b></p>
1.97      rillig   7686: </td>
                   7687: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7688:        package is using while being built? I want to know whether it
                   7689:        uses sed or not.</p></td>
                   7690: </tr>
                   7691: <tr class="answer">
                   7692: <td align="left" valign="top"></td>
                   7693: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7694:        to do it.)</p></td>
                   7695: </tr>
                   7696: </tbody>
                   7697: </table>
                   7698: </div>
                   7699: </div>
1.75      rillig   7700: </div>
                   7701: <div class="chapter" lang="en">
                   7702: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7703: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   7704: <div class="toc">
                   7705: <p><b>Table of Contents</b></p>
                   7706: <dl>
1.106     rillig   7707: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   7708: <dd><dl>
1.106     rillig   7709: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.116     rillig   7710: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.106     rillig   7711: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7712: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7713: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7714: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7715: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7716: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7717: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7718: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7719: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7720: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7721: </dl></dd>
1.116     rillig   7722: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106     rillig   7723: <dd><dl>
                   7724: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7725: <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>
                   7726: </dl></dd>
1.116     rillig   7727: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106     rillig   7728: <dd><dl>
                   7729: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7730: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7731: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7732: </dl></dd>
                   7733: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7734: <dd><dl>
                   7735: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7736: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7737: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   7738: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   7739: </dl></dd>
1.116     rillig   7740: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106     rillig   7741: <dd><dl>
                   7742: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7743: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.116     rillig   7744: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106     rillig   7745: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7746: </dl></dd>
1.116     rillig   7747: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106     rillig   7748: <dd><dl>
                   7749: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7750: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7751: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7752: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7753: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7754: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7755: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7756: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   7757: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119   ! mishka   7758: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   7759: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7760: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7761: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7762: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7763: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7764: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7765: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7766: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      7767:     emulation</a></span></dt>
1.106     rillig   7768: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7769: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7770: </dl></dd>
1.106     rillig   7771: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7772: </dl>
                   7773: </div>
                   7774: <div class="sect1" lang="en">
                   7775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7776: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.75      rillig   7777: <div class="sect2" lang="en">
                   7778: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7779: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7780: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7781:     different platforms. As a result, it is important to ensure,
                   7782:     where possible, that packages in pkgsrc are portable. This
                   7783:     chapter mentions some particular details you should pay
                   7784:     attention to while working on pkgsrc.</p>
1.78      rillig   7785: </div>
                   7786: <div class="sect2" lang="en">
                   7787: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  7788: <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.93      rillig   7789: </h3></div></div></div>
1.78      rillig   7790: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7791:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7792:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7793:     want to use those variables in the preprocessor directives of
1.110     hubertf  7794:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7795:     <code class="literal">.for</code>), you need to include the file
                   7796:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7797:     loads the user preferences.</p>
1.78      rillig   7798: <p>But note that some variables may not be completely defined
1.87      wiz      7799:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7800:     included, as they may contain references to variables that are
                   7801:     not yet defined. In shell commands this is no problem, since
                   7802:     variables are actually macros, which are only expanded when they
                   7803:     are used. But in the preprocessor directives mentioned above and
                   7804:     in dependency lines (of the form <code class="literal">target:
                   7805:     dependencies</code>) the variables are expanded at load
                   7806:     time.</p>
1.78      rillig   7807: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7808: <h3 class="title">Note</h3>
                   7809: <p>Currently there is no exhaustive list of all
1.87      wiz      7810:     variables that tells you whether they can be used at load time
                   7811:     or only at run time, but it is in preparation.</p>
1.78      rillig   7812: </div>
                   7813: </div>
                   7814: <div class="sect2" lang="en">
                   7815: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7816: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88      wiz      7817: <p>Occasionally, packages require interaction from the user,
                   7818:     and this can be in a number of ways:</p>
1.78      rillig   7819: <div class="itemizedlist"><ul type="disc">
1.79      rillig   7820: <li><p>When fetching the distfiles, some packages require user
1.87      wiz      7821:        interaction such as entering username/password or accepting a
                   7822:        license on a web page.</p></li>
1.88      wiz      7823: <li><p>When extracting the distfiles, some packages may ask for
                   7824:        passwords.</p></li>
1.78      rillig   7825: <li><p>help to configure the package before it is built</p></li>
                   7826: <li><p>help during the build process</p></li>
                   7827: <li><p>help during the installation of a package</p></li>
                   7828: </ul></div>
1.88      wiz      7829: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7830:     provided to notify the pkgsrc mechanism of an interactive stage
                   7831:     which will be needed, and this should be set in the package's
                   7832:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7833: <pre class="programlisting">
1.100     rillig   7834: INTERACTIVE_STAGE=      build
1.87      wiz      7835:     </pre>
1.78      rillig   7836: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7837: <pre class="programlisting">
1.100     rillig   7838: INTERACTIVE_STAGE=      configure install
1.87      wiz      7839:     </pre>
1.88      wiz      7840: <p>The user can then decide to skip this package by setting the
                   7841:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7842: </div>
                   7843: <div class="sect2" lang="en">
                   7844: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7845: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98      wiz      7846: <p>Authors of software can choose the licence under which
                   7847:     software can be copied.  This is due to copyright law, and reasons
                   7848:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7849:     system recognizes that there are a number of licenses which some
                   7850:     users may find objectionable or difficult or impossible to comply
                   7851:     with.  The Free Software Foundation has declared some licenses
                   7852:     "Free", and the Open Source Initiative has a definition of "Open
                   7853:     Source".  The pkgsrc system, as a policy choice, does not label
                   7854:     packages which have licenses that are Free or Open Source.
                   7855:     However, packages without a license meeting either of those tests
                   7856:     are labeled with a license tag denoting the license.  Note that a
                   7857:     package with no license to copy trivially does not meet either the
                   7858:     Free or Open Source test.</p>
                   7859: <p>For packages which are not Free or Open Source, pkgsrc will
                   7860:     not build the package unless the user has indicated to pkgsrc that
                   7861:     packages with that particular license may be built.  Note that
                   7862:     this documentation avoids the term "accepted the license".  The
                   7863:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7864:     accidentally building a package with a non-free license;
1.98      wiz      7865:     judgement and responsibility remain with the user.  (Installation
                   7866:     of binary packages are not currently subject to this mechanism;
                   7867:     this is a bug.)</p>
                   7868: <p>One might want to only install packages with a BSD license,
                   7869:     or the GPL, and not the other.  The pkgsrc license tag mechanism
                   7870:     does not provide a way to do this.  It might be possible to put in
                   7871:     tags for free licenses, and have a default
                   7872:     <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
                   7873:     widely viewed as having a very poor ratio of benefit to
                   7874:     work.</p>
1.78      rillig   7875: <p>The license tag mechanism is intended to address
1.87      wiz      7876:     copyright-related issues surrounding building, installing and
                   7877:     using a package, and not to address redistribution issues (see
                   7878:     <code class="varname">RESTRICTED</code> and
                   7879:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  However, the above
                   7880:     definition of licenses for which tags are not needed implies
                   7881:     that packages with redistribution restrictions should have
1.98      wiz      7882:     tags, because Free or Open Source programs do not have
                   7883:     redistribution restrictions.</p>
                   7884: <p>Denoting that a package may be copied according to a
                   7885:     particular license is done by placing the license in
1.87      wiz      7886:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7887:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   7888:     license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7889: <pre class="programlisting">
1.100     rillig   7890: LICENSE=        xv-license
1.87      wiz      7891:     </pre>
                   7892: <p>When trying to build, the user will get a notice that the
1.98      wiz      7893:     package is covered by a license which has not been placed in the
                   7894:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7895: <pre class="programlisting">
1.100     rillig   7896: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7897: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7898: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7899: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7900: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7901: *** Error code 1
1.87      wiz      7902:     </pre>
1.110     hubertf  7903: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7904:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7905:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7906:     convey to pkgsrc that it should not in the future fail because of
                   7907:     that license:</p>
1.78      rillig   7908: <pre class="programlisting">
1.100     rillig   7909: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      7910:     </pre>
1.98      wiz      7911: <p>When adding a package with a new license, the license text
                   7912:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7913:     displaying.  A list of known licenses can be seen in this
1.91      rillig   7914:     directory.</p>
1.98      wiz      7915: <p>When the license changes (in a way other than formatting),
                   7916:     please make sure that the new license has a different name (e.g.,
                   7917:     append the version number if it exists, or the date).  Just
                   7918:     because a user told pkgsrc to build programs under a previous
                   7919:     version of a license does not mean that pkgsrc should build
1.99      rillig   7920:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7921:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7922:     test is a mechanistic test of whether a particular text has been
                   7923:     approved by either of two bodies.</p>
1.78      rillig   7924: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      7925:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7926:     is deprecated because it does not crisply refer to a particular
                   7927:     license text.  Another problem with such usage is that it does not
                   7928:     enable a user to tell pkgsrc to proceed for a single package
                   7929:     without also telling pkgsrc to proceed for all packages with that
                   7930:     tag.</p>
1.75      rillig   7931: </div>
                   7932: <div class="sect2" lang="en">
                   7933: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7934: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   7935: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      7936:     Because a license tag is required unless the package is Free or
                   7937:     Open Source, all packages with restrictions should have license
                   7938:     tags.  By declaring the restrictions, package tools can
                   7939:     automatically refrain from e.g. placing binary packages on FTP
                   7940:     sites.</p>
                   7941: <p>There are four restrictions that may be encoded, which are
                   7942:     the cross product of sources (distfiles) and binaries not being
                   7943:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7944:     language in any license, and because non-Free licenses tend to be
                   7945:     different from each other, pkgsrc adopts a definition of FTP and
                   7946:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7947:     should not be made available over the Internet at no charge.
                   7948:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7949:     made available on some kind of media, together with other source
                   7950:     and binary packages, and which is sold for a distribution charge.
                   7951:     </p>
                   7952: <p>In order to encode these restrictions, the package system
1.87      wiz      7953:     defines five make variables that can be set to note these
                   7954:     restrictions:</p>
1.75      rillig   7955: <div class="itemizedlist"><ul type="disc">
                   7956: <li>
                   7957: <p><code class="varname">RESTRICTED</code></p>
                   7958: <p>This variable should be set whenever a restriction
1.87      wiz      7959:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7960:        string containing the reason for the restriction.  It should
                   7961:        be understood that those wanting to understand the restriction
                   7962:        will have to read the license, and perhaps seek advice of
                   7963:        counsel.</p>
1.75      rillig   7964: </li>
                   7965: <li>
                   7966: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7967: <p>Binaries may not be placed on CD-ROM containing other
                   7968:        binary packages, for which a distribution charge may be made.
                   7969:        In this case, set this variable to
                   7970:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7971: </li>
                   7972: <li>
                   7973: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7974: <p>Binaries may not made available on the Internet without
                   7975:        charge.  In this case, set this variable to
                   7976:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7977:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7978: </li>
                   7979: <li>
                   7980: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7981: <p>Distfiles may not be placed on CD-ROM, together with
                   7982:        other distfiles, for which a fee may be charged.  In this
                   7983:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7984:        </p>
1.75      rillig   7985: </li>
                   7986: <li>
                   7987: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7988: <p>Distfiles may not made available via FTP at no charge.
                   7989:        In this case, set this variable to
                   7990:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7991:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7992: </li>
                   7993: </ul></div>
                   7994: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
1.87      wiz      7995:     <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
                   7996:     generic make variables to denote restrictions is deprecated,
                   7997:     because they unconditionally prevent users from generating
                   7998:     binary packages!</p>
1.75      rillig   7999: </div>
                   8000: <div class="sect2" lang="en">
                   8001: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8002: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   8003: <p>Your package may depend on some other package being present
1.88      wiz      8004:     - and there are various ways of expressing this dependency.
                   8005:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   8006:     <code class="varname">DEPENDS</code> definitions, the
                   8007:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   8008:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   8009:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  8010:     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   8011: <p>The basic difference between the two variables is as
1.87      wiz      8012:     follows: The <code class="varname">DEPENDS</code> definition registers
                   8013:     that pre-requisite in the binary package so it will be pulled in
                   8014:     when the binary package is later installed, whilst the
                   8015:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   8016:     dependency that is only needed for building the package.</p>
1.75      rillig   8017: <p>This means that if you only need a package present whilst
1.87      wiz      8018:     you are building, it should be noted as a
                   8019:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   8020: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      8021:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   8022: <pre class="programlisting">
1.100     rillig   8023: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      8024:     </pre>
1.75      rillig   8025: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
1.87      wiz      8026:     may include any of the wildcard version numbers recognized by
1.110     hubertf  8027:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.75      rillig   8028: <div class="orderedlist"><ol type="1">
                   8029: <li>
                   8030: <p>If your package needs another package's binaries or
1.87      wiz      8031:        libraries to build or run, and if that package has a
                   8032:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   8033: <pre class="programlisting">
1.100     rillig   8034: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      8035:        </pre>
1.75      rillig   8036: </li>
                   8037: <li>
                   8038: <p>If your package needs to use another package to build
1.87      wiz      8039:        itself and there is no <code class="filename">buildlink3.mk</code>
                   8040:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   8041:        definition:</p>
1.75      rillig   8042: <pre class="programlisting">
1.100     rillig   8043: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87      wiz      8044:        </pre>
1.75      rillig   8045: </li>
                   8046: <li>
                   8047: <p>If your package needs a library with which to link and
1.76      rillig   8048:        again there is no <code class="filename">buildlink3.mk</code> file
1.87      wiz      8049:        available, this is specified using the
                   8050:        <code class="varname">DEPENDS</code> definition. For example:</p>
1.75      rillig   8051: <pre class="programlisting">
1.100     rillig   8052: DEPENDS+=       xpm-3.4j:../../graphics/xpm
1.87      wiz      8053:        </pre>
1.109     rillig   8054: <p>You can also use wildcards in package dependencies:</p>
1.75      rillig   8055: <pre class="programlisting">
1.100     rillig   8056: DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
1.87      wiz      8057:        </pre>
1.75      rillig   8058: <p>Note that such wildcard dependencies are retained when
1.87      wiz      8059:        creating binary packages.  The dependency is checked when
                   8060:        installing the binary package and any package which matches
                   8061:        the pattern will be used.  Wildcard dependencies should be
                   8062:        used with care.</p>
1.75      rillig   8063: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
1.87      wiz      8064:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   8065:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   8066:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
1.75      rillig   8067: <p>Wildcards can also be used to specify that a package
1.87      wiz      8068:        will only build against a certain minimum version of a
                   8069:        pre-requisite:</p>
1.75      rillig   8070: <pre class="programlisting">
1.100     rillig   8071: DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
1.87      wiz      8072:        </pre>
1.75      rillig   8073: <p>This means that the package will build against version
1.87      wiz      8074:        3.5.4 of the tiff library or newer.  Such a dependency may
                   8075:        be warranted if, for example, the API of the library has
                   8076:        changed with version 3.5.4 and a package would not compile
                   8077:        against an earlier version of tiff.</p>
1.75      rillig   8078: <p>Please note that such dependencies should only be
1.87      wiz      8079:        updated if a package requires a newer pre-requisite, but
1.93      rillig   8080:        not to denote recommendations such as
1.87      wiz      8081:        ABI changes that do not prevent a package from building
                   8082:        correctly.  Such recommendations can be expressed using
                   8083:        <code class="varname">ABI_DEPENDS</code>:</p>
1.75      rillig   8084: <pre class="programlisting">
1.100     rillig   8085: ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
1.87      wiz      8086:        </pre>
1.75      rillig   8087: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87      wiz      8088:        line, this denotes that while a package will build against
                   8089:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   8090:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   8091:        dependencies unless explicitly ignored (in which case a
                   8092:        warning will be printed).</p>
1.75      rillig   8093: <p>To ignore these ABI dependency recommendations and just
1.87      wiz      8094:        use the required <code class="varname">DEPENDS</code>, set
                   8095:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   8096:        it easier and faster to update packages built using pkgsrc,
                   8097:        since older compatible dependencies can continue to be
                   8098:        used. This is useful for people who watch their rebuilds
                   8099:        very carefully; it is not very good as a general-purpose
                   8100:        hammer.  If you use it, you need to be mindful of possible
                   8101:        ABI changes, including those from the underlying OS.</p>
1.75      rillig   8102: <p>Packages that are built with recommendations ignored
1.87      wiz      8103:        may not be uploaded to ftp.NetBSD.org by developers and
                   8104:        should not be used across different systems that may have
                   8105:        different versions of binary packages installed.</p>
1.75      rillig   8106: <p>For security fixes, please update the package
1.110     hubertf  8107:        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.87      wiz      8108:        information.</p>
1.75      rillig   8109: </li>
                   8110: <li>
                   8111: <p>If your package needs some executable to be able to run
1.87      wiz      8112:        correctly and if there's no
                   8113:        <code class="filename">buildlink3.mk</code> file, this is specified
                   8114:        using the <code class="varname">DEPENDS</code> variable. The
1.91      rillig   8115:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.87      wiz      8116:        be able to execute the latex binary from the teTeX package
                   8117:        when it runs, and that is specified:</p>
1.75      rillig   8118: <pre class="programlisting">
1.100     rillig   8119: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      8120:        </pre>
1.75      rillig   8121: <p>The comment about wildcard dependencies from previous
1.87      wiz      8122:        paragraph applies here, too.</p>
1.75      rillig   8123: </li>
                   8124: </ol></div>
                   8125: <p>If your package needs files from another package to build,
1.87      wiz      8126:     add the relevant distribution files to
                   8127:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   8128:     automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      8129:     (It relies on the jpeg sources being present in source form
                   8130:     during the build.)</p>
1.75      rillig   8131: </div>
                   8132: <div class="sect2" lang="en">
                   8133: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8134: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   8135: <p>Your package may conflict with other packages a user might
1.87      wiz      8136:     already have installed on his system, e.g. if your package
1.88      wiz      8137:     installs the same set of files as another package in the pkgsrc
                   8138:     tree.</p>
1.75      rillig   8139: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      8140:     space-separated list of packages (including version string) your
                   8141:     package conflicts with.</p>
1.91      rillig   8142: <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>
                   8143:     and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
1.87      wiz      8144:     install the same shared library, thus you set in
                   8145:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8146: <pre class="programlisting">
1.100     rillig   8147: CONFLICTS=      Xaw-Xpm-[0-9]*
1.87      wiz      8148:     </pre>
                   8149: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   8150: <pre class="programlisting">
1.100     rillig   8151: CONFLICTS=      Xaw3d-[0-9]*
1.87      wiz      8152:     </pre>
1.75      rillig   8153: <p>Packages will automatically conflict with other packages
1.87      wiz      8154:     with the name prefix and a different version
                   8155:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   8156:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
1.75      rillig   8157: </div>
                   8158: <div class="sect2" lang="en">
                   8159: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8160: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   8161: <p>There are several reasons why a package might be
1.88      wiz      8162:     instructed to not build under certain circumstances.  If the
1.87      wiz      8163:     package builds and runs on most platforms, the exceptions
                   8164:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8165:     the package builds and runs on a small handful of platforms,
                   8166:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8167:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8168:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8169:     (OS-version-platform) that can use glob-style
                   8170:     wildcards.</p>
1.88      wiz      8171: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   8172:     operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      8173:     backwards compatible with other versions of the OS, and should be
                   8174:     uploaded to a version specific directory on the FTP server.  Mark
                   8175:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   8176:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   8177:     the package system internals, but may be used in the
                   8178:     future.</p>
1.75      rillig   8179: <p>If the package should be skipped (for example, because it
1.87      wiz      8180:     provides functionality already provided by the system), set
1.88      wiz      8181:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8182:     the package should fail because some preconditions are not met,
                   8183:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      8184:     message.</p>
1.75      rillig   8185: </div>
                   8186: <div class="sect2" lang="en">
                   8187: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8188: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8189: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8190:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8191:     be set in the package Makefile. This will be carried into any
                   8192:     binary package that is made from this pkgsrc entry. A
                   8193:     &#8220;<span class="quote">preserved</span>&#8221; package will
1.110     hubertf  8194:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.87      wiz      8195:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
1.75      rillig   8196: </div>
                   8197: <div class="sect2" lang="en">
                   8198: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8199: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8200: <p>When a vulnerability is found, this should be noted in
1.87      wiz      8201:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110     hubertf  8202:     and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87      wiz      8203:     in the same directory to update the file on ftp.NetBSD.org.</p>
1.75      rillig   8204: <p>After fixing the vulnerability by a patch, its
1.87      wiz      8205:     <code class="varname">PKGREVISION</code> should be increased (this
                   8206:     is of course not necessary if the problem is fixed by using
                   8207:     a newer release of the software).</p>
1.75      rillig   8208: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8209:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8210: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8211:     semi-automatically by a weekly cron job.</p>
1.75      rillig   8212: </div>
                   8213: <div class="sect2" lang="en">
                   8214: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8215: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   8216: <p>When making fixes to an existing package it can be useful
1.87      wiz      8217:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8218:     avoid conflicting with future versions by the original author, a
                   8219:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8220:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8221:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8222:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8223: <pre class="programlisting">
1.100     rillig   8224: DISTNAME=       foo-17.42
                   8225: PKGREVISION=    9
1.87      wiz      8226:     </pre>
1.75      rillig   8227: <p>will result in a <code class="varname">PKGNAME</code> of
1.87      wiz      8228:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8229:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8230:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8231:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8232: <p>When a new release of the package is released, the
1.87      wiz      8233:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8234:     minor release of the above package, things should be like:</p>
1.75      rillig   8235: <pre class="programlisting">
1.100     rillig   8236: DISTNAME=       foo-17.43
1.87      wiz      8237:     </pre>
                   8238: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8239:     non-trivial change in the resulting binary package.  Without a
                   8240:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8241:     version installed has no way of knowing that their package is out
                   8242:     of date.  Thus, changes without increasing
                   8243:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8244:     trivial that no reasonable person would want to upgrade", and this
                   8245:     is the rough test for when increasing
                   8246:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8247:     changes that do not merit increasing
                   8248:     <code class="varname">PKGREVISION</code> are:</p>
1.100     rillig   8249: <div class="itemizedlist"><ul type="disc">
1.114     jmcneill 8250: <li><p>Changing <code class="varname">HOMEPAGE</code>,
                   8251:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   8252:       or comments in Makefile.</p></li>
                   8253: <li><p>
                   8254:       Changing build variables if the resulting binary package is the same.</p></li>
                   8255: <li><p>
                   8256:       Changing <code class="filename">DESCR</code>.</p></li>
                   8257: <li><p>
                   8258:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8259: </ul></div>
1.87      wiz      8260: <p>Examples of changes that do merit an increase to
                   8261:     <code class="varname">PKGREVISION</code> include:</p>
1.100     rillig   8262: <div class="itemizedlist"><ul type="disc">
                   8263: <li><p>
                   8264:       Security fixes</p></li>
                   8265: <li><p>
                   8266:       Changes or additions to a patch file</p></li>
                   8267: <li><p>
                   8268:       Changes to the <code class="filename">PLIST</code></p></li>
1.112     weinem   8269: <li><p>A dependency is changed or renamed.</p></li>
1.100     rillig   8270: </ul></div>
1.78      rillig   8271: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8272:     changes.</p>
1.75      rillig   8273: </div>
1.79      rillig   8274: <div class="sect2" lang="en">
                   8275: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8276: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   8277: <p>When you want to replace the same text in multiple files
1.87      wiz      8278:     or when the replacement text varies, patches alone cannot help.
                   8279:     This is where the SUBST framework comes in. It provides an
                   8280:     easy-to-use interface for replacing text in files.
                   8281:     Example:</p>
                   8282: <pre class="programlisting">
1.100     rillig   8283: SUBST_CLASSES+=                 fix-paths
                   8284: SUBST_STAGE.fix-paths=          pre-configure
                   8285: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8286: SUBST_FILES.fix-paths=          src/*.c
                   8287: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8288: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8289: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      8290:     </pre>
1.79      rillig   8291: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8292:     that are used to identify the different SUBST blocks that are
                   8293:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8294:     important to always use the <code class="literal">+=</code> operator with
                   8295:     this variable. Otherwise some substitutions may be
                   8296:     skipped.</p>
1.79      rillig   8297: <p>The remaining variables of each SUBST block are
1.87      wiz      8298:     parameterized with the identifier from the first line
                   8299:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8300:     parameters to a function call.</p>
1.79      rillig   8301: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8302:     which the replacement will take place. All combinations of
                   8303:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8304:     <code class="literal">post-</code> together with a phase name are
                   8305:     possible, though only few are actually used. Most commonly used
                   8306:     are <code class="literal">post-patch</code> and
                   8307:     <code class="literal">pre-configure</code>. Of these two,
                   8308:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  8309:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      8310:     have the state after applying the patches but before making any
                   8311:     other changes. This is especially useful when you are debugging
                   8312:     a package in order to create new patches for it. Similarly,
                   8313:     <code class="literal">post-build</code> is preferred over
                   8314:     <code class="literal">pre-install</code>, because the install phase should
                   8315:     generally be kept as simple as possible. When you use
                   8316:     <code class="literal">post-build</code>, you have the same files in the
                   8317:     working directory that will be installed later, so you can check
                   8318:     if the substitution has succeeded.</p>
1.79      rillig   8319: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8320:     that is printed just before the substitution is done.</p>
1.79      rillig   8321: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8322:     globbing patterns that specifies the files in which the
                   8323:     substitution will take place. The patterns are interpreted
                   8324:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8325: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110     hubertf  8326:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      8327:     command should be prefixed with <code class="literal">-e</code>, so that
                   8328:     all SUBST blocks look uniform.</p>
1.79      rillig   8329: <p>There are some more variables, but they are so seldomly
1.87      wiz      8330:     used that they are only documented in the
                   8331:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8332: </div>
1.75      rillig   8333: </div>
                   8334: <div class="sect1" lang="en">
                   8335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8336: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.75      rillig   8337: <div class="sect2" lang="en">
                   8338: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8339: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   8340: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8341:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8342:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8343:     with the name of each file to download as an argument, expecting
                   8344:     it to output the URL of the directory from which to download
1.91      rillig   8345:     it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      8346:     example of this usage.</p>
1.75      rillig   8347: <p>If the download can't be automated, because the user must
1.87      wiz      8348:     submit personal information to apply for a password, or must pay
                   8349:     for the source, or whatever, you can set
                   8350:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8351:     displayed to the user before aborting the build. Example:</p>
                   8352: <pre class="programlisting">
1.100     rillig   8353: FETCH_MESSAGE=  "Please download the files"
                   8354: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8355: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8356:     </pre>
1.75      rillig   8357: </div>
                   8358: <div class="sect2" lang="en">
                   8359: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8360: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   8361: <p>Sometimes authors of a software package make some
1.87      wiz      8362:     modifications after the software was released, and they put up a
                   8363:     new distfile without changing the package's version number. If a
                   8364:     package is already in pkgsrc at that time, the checksum will
                   8365:     no longer match. The contents of the new distfile should be
                   8366:     compared against the old one before changing anything, to make
                   8367:     sure the distfile was really updated on purpose, and that
                   8368:     no trojan horse or so crept in.
1.97      rillig   8369:     Please mention that the distfiles were compared and what was found
                   8370:     in your commit message.
1.87      wiz      8371:     Then, the correct way to work around this is to
                   8372:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8373:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8374:     <code class="varname">DISTFILES</code> and
1.93      rillig   8375:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8376:     subdirectory of the local distfiles directory.
1.110     hubertf  8377:     (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.97      rillig   8378:     In case this
1.87      wiz      8379:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8380:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8381:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8382:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8383:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8384:     path in the filenames.
1.97      rillig   8385:     Also increase the PKGREVISION if the installed package is different.
1.87      wiz      8386:     Furthermore, a mail to the package's authors seems appropriate
                   8387:     telling them that changing distfiles after releases without
                   8388:     changing the file names is not good practice.</p>
1.75      rillig   8389: </div>
                   8390: </div>
                   8391: <div class="sect1" lang="en">
                   8392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8393: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.75      rillig   8394: <div class="sect2" lang="en">
                   8395: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8396: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8397: <p>pkgsrc supports many different machines, with different
1.87      wiz      8398:     object formats like a.out and ELF, and varying abilities to do
                   8399:     shared library and dynamic loading at all. To accompany this,
                   8400:     varying commands and options have to be passed to the
                   8401:     compiler, linker, etc. to get the Right Thing, which can be
                   8402:     pretty annoying especially if you don't have all the machines
                   8403:     at your hand to test things.  The
1.91      rillig   8404:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.87      wiz      8405:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8406:     both static and dynamic libraries from a set of source files,
                   8407:     thus being platform-independent.</p>
                   8408: <p>Here's how to use libtool in a package in seven simple
                   8409:     steps:</p>
1.75      rillig   8410: <div class="orderedlist"><ol type="1">
                   8411: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8412:        Makefile.</p></li>
1.75      rillig   8413: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
1.87      wiz      8414:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8415:        add it to the definition of <code class="varname">CC</code>, if only
                   8416:        libraries are being built in a given Makefile. This one command
                   8417:        will build both PIC and non-PIC library objects, so you need not
                   8418:        have separate shared and non-shared library rules.</p></li>
1.75      rillig   8419: <li>
                   8420: <p>For the linking of the library, remove any
1.87      wiz      8421:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8422:        -Bshareable</span>&#8221; commands, and instead use:</p>
1.75      rillig   8423: <pre class="programlisting">
1.100     rillig   8424: ${LIBTOOL} --mode=link \
                   8425:     ${CC} -o ${.TARGET:.a=.la} \
                   8426:         ${OBJS:.o=.lo} \
                   8427:         -rpath ${PREFIX}/lib \
                   8428:         -version-info major:minor
1.87      wiz      8429:        </pre>
1.75      rillig   8430: <p>Note that the library is changed to have a
1.87      wiz      8431:        <code class="filename">.la</code> extension, and the objects are
                   8432:        changed to have a <code class="filename">.lo</code>
                   8433:        extension. Change <code class="varname">OBJS</code> as
                   8434:        necessary. This automatically creates all of the
                   8435:        <code class="filename">.a</code>,
                   8436:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8437:        necessary) in the build directory. Be sure to include
                   8438:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8439:        minor are zero, as libtool will otherwise strip off the
                   8440:        shared library version.</p>
1.75      rillig   8441: <p>From the libtool manual:</p>
                   8442: <pre class="programlisting">
1.100     rillig   8443: So, libtool library versions are described by three integers:
1.69      rillig   8444: 
1.100     rillig   8445: CURRENT
                   8446: The most recent interface number that this library implements.
1.69      rillig   8447: 
1.100     rillig   8448: REVISION
                   8449: The implementation number of the CURRENT interface.
1.69      rillig   8450: 
1.100     rillig   8451: AGE
                   8452: The difference between the newest and oldest interfaces that
                   8453: this library implements.  In other words, the library implements
                   8454: all the interface numbers in the range from number `CURRENT -
                   8455: AGE' to `CURRENT'.
1.1       grant    8456: 
1.100     rillig   8457: If two libraries have identical CURRENT and AGE numbers, then the
                   8458: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8459:        </pre>
1.75      rillig   8460: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
1.87      wiz      8461:        different results for a.out and ELF (excluding symlinks)
                   8462:        in only one case. An ELF library of the form
                   8463:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8464:        will have a symlink of
                   8465:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8466:        on an a.out platform. This is handled
                   8467:        automatically.</p>
1.75      rillig   8468: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
1.87      wiz      8469:        directory of the library being built.</p>
1.76      rillig   8470: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8471:        <code class="filename">.la</code> file, the other files will be
                   8472:        added automatically.</p>
1.75      rillig   8473: </li>
                   8474: <li>
1.76      rillig   8475: <p>When linking shared object (<code class="filename">.so</code>)
1.110     hubertf  8476:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.87      wiz      8477:        shared libraries, use &#8220;<span class="quote">-module
                   8478:        -avoid-version</span>&#8221; to prevent them getting version
                   8479:        tacked on.</p>
1.76      rillig   8480: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8481:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8482: </li>
                   8483: <li>
                   8484: <p>When linking programs that depend on these libraries
1.87      wiz      8485:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.110     hubertf  8486:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with &#8220;<span class="quote">${LIBTOOL}
1.87      wiz      8487:        --mode=link</span>&#8221;, and it will find the correct
                   8488:        libraries (static or shared), but please be aware that
                   8489:        libtool will not allow you to specify a relative path in
                   8490:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8491:        expects you to change that argument to be the
                   8492:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8493: <pre class="programlisting">
1.100     rillig   8494: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8495:        </pre>
1.75      rillig   8496: <p>should be changed to:</p>
                   8497: <pre class="programlisting">
1.100     rillig   8498: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8499:        </pre>
1.75      rillig   8500: <p>and it will do the right thing with the libraries.</p>
                   8501: </li>
                   8502: <li>
1.110     hubertf  8503: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8504:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with &#8220;<span class="quote">${LIBTOOL}
1.87      wiz      8505:        --mode=install</span>&#8221;, and change the library name to
                   8506:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8507: <pre class="programlisting">
1.100     rillig   8508: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8509:        </pre>
1.76      rillig   8510: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8511:        shared library, any needed symlinks, and run
1.110     hubertf  8512:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8513: </li>
1.76      rillig   8514: <li><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8515:        the <code class="filename">.la</code>
                   8516:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8517: </ol></div>
                   8518: </div>
                   8519: <div class="sect2" lang="en">
                   8520: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8521: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8522: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8523:     package Makefile. This will override the package's own libtool
                   8524:     in most cases.  For older libtool using packages,  libtool is
                   8525:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8526:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8527:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8528: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8529:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8530:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8531:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8532:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8533: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8534:     libraries built and installed, then use
                   8535:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8536: <p>If your package makes use of the platform-independent library
1.87      wiz      8537:     for loading dynamic shared objects, that comes with libtool
                   8538:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8539: <p>Some packages use libtool incorrectly so that the package
                   8540:     may not work or build in some circumstances. Some of the more
                   8541:     common errors are:</p>
1.75      rillig   8542: <div class="itemizedlist"><ul type="disc">
                   8543: <li>
                   8544: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8545:        executable or library. This in itself isn't a problem if one of two things
                   8546:        has been done:</p>
1.75      rillig   8547: <div class="orderedlist"><ol type="1">
                   8548: <li><p>The shared object is named correctly, i.e.
1.87      wiz      8549:            <code class="filename">libfoo.la</code>, not
                   8550:            <code class="filename">foo.la</code></p></li>
1.75      rillig   8551: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8552: </ol></div>
                   8553: </li>
                   8554: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8555:        The function lt_dlinit() should be called and the macro
                   8556:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8557:        executables.</p></li>
1.75      rillig   8558: </ul></div>
                   8559: </div>
                   8560: <div class="sect2" lang="en">
                   8561: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8562: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8563: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8564:     to regenerate the configure script and Makefile.in makefile
                   8565:     templates, then they should be executed in a pre-configure
                   8566:     target.</p>
1.75      rillig   8567: <p>For packages that need only autoconf:</p>
                   8568: <pre class="programlisting">
1.100     rillig   8569: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8570: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8571: ...
1.1       grant    8572: 
1.100     rillig   8573: pre-configure:
                   8574:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8575: 
1.100     rillig   8576: ...
1.87      wiz      8577:     </pre>
1.75      rillig   8578: <p>and for packages that need automake and autoconf:</p>
                   8579: <pre class="programlisting">
1.100     rillig   8580: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8581: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8582: ...
                   8583: 
                   8584: pre-configure:
                   8585:         set -e; cd ${WRKSRC}; \
                   8586:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8587: 
1.100     rillig   8588: ...
1.87      wiz      8589:     </pre>
1.75      rillig   8590: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8591:     require GNU Make.</p>
1.75      rillig   8592: <p>There are times when the configure process makes
1.87      wiz      8593:     additional changes to the generated files, which then causes
                   8594:     the build process to try to re-execute the automake sequence.
                   8595:     This is prevented by touching various files in the configure
                   8596:     stage. If this causes problems with your package you can set
                   8597:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8598:     Makefile.</p>
1.75      rillig   8599: </div>
                   8600: </div>
                   8601: <div class="sect1" lang="en">
                   8602: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8603: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.87      wiz      8604: <div class="sect2" lang="en">
                   8605: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8606: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8607: <p>Compilers for the C, C++, and Fortran languages comes with
                   8608:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8609:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  8610:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8611: <p>To declare which language's compiler a package needs, set
                   8612:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8613:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8614:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8615:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8616:     written in C++, usually need a C compiler for the configure
                   8617:     phase.</p>
                   8618: </div>
                   8619: <div class="sect2" lang="en">
                   8620: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8621: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      8622: <p>If a program is written in Java, use the Java framework in
                   8623:     pkgsrc.  The package must include
                   8624:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8625:     provides the following variables:</p>
                   8626: <div class="itemizedlist"><ul type="disc">
                   8627: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8628:       dependency on the JDK is added.  If
                   8629:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8630:       there is only a runtime dependency on the JDK.  The default is
                   8631:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8632:       JDK.</p></li>
                   8633: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8634:       a package needs a Java2 implementation.  The supported values
                   8635:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8636:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8637:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8638:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8639:       above. This variable is not set by default.</p></li>
                   8640: </ul></div>
                   8641: </div>
                   8642: <div class="sect2" lang="en">
                   8643: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8644: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8645: <p>If your package contains interpreted perl scripts, add
                   8646:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8647:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8648:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8649:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8650:     that you want adjusted.  Every occurrence of
                   8651:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8652:     path to the perl executable.</p>
                   8653: <p>If a particular version of perl is needed, set the
                   8654:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8655:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.110     hubertf  8656: <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.87      wiz      8657:     about handling perl modules.</p>
                   8658: </div>
                   8659: <div class="sect2" lang="en">
                   8660: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8661: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87      wiz      8662: <p>Currently, there is no special handling for other languages
                   8663:     in pkgsrc.  If a compiler package provides a
                   8664:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8665:     just add a (build) dependency on the appropriate compiler
                   8666:     package.</p>
                   8667: </div>
                   8668: </div>
                   8669: <div class="sect1" lang="en">
                   8670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8671: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8672: <p>The most common failures when building a package are that
                   8673:        some platforms do not provide certain header files, functions or
                   8674:        libraries, or they provide the functions in a library that the
                   8675:        original package author didn't know. To work around this, you
                   8676:        can rewrite the source code in most cases so that it does not
                   8677:        use the missing functions or provides a replacement function.</p>
                   8678: <div class="sect2" lang="en">
                   8679: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8680: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8681: <p>If a package already comes with a GNU configure script, the
                   8682:        preferred way to fix the build failure is to change the
                   8683:        configure script, not the code. In the other cases, you can
                   8684:        utilize the C preprocessor, which defines certain macros
                   8685:        depending on the operating system and hardware architecture it
                   8686:        compiles for. These macros can be queried using for example
                   8687:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8688:        system, hardware architecture and compiler has its own macro.
                   8689:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8690:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8691:        are all defined, you know that you are using NetBSD on an i386
                   8692:        compatible CPU, and your compiler is GCC.</p>
                   8693: <p>The list of the following macros for hardware and
                   8694:        operating system depends on the compiler that is used. For
                   8695:        example, if you want to conditionally compile code on Solaris,
                   8696:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8697:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75      rillig   8698: <div class="sect3" lang="en">
                   8699: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8700: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8701: <p>To distinguish between 4.4 BSD-derived systems and the
                   8702:         rest of the world, you should use the following code.</p>
                   8703: <pre class="programlisting">
1.100     rillig   8704: #include &lt;sys/param.h&gt;
                   8705: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8706: /* BSD-specific code goes here */
                   8707: #else
                   8708: /* non-BSD-specific code goes here */
                   8709: #endif
1.75      rillig   8710: </pre>
1.77      rillig   8711: <p>If this distinction is not fine enough, you can also test
                   8712:        for the following macros.</p>
1.75      rillig   8713: <pre class="programlisting">
1.100     rillig   8714: FreeBSD     __FreeBSD__
                   8715: DragonFly   __DragonFly__
                   8716: Interix     __INTERIX
                   8717: IRIX        __sgi (TODO: get a definite source for this)
                   8718: Linux       linux, __linux, __linux__
                   8719: NetBSD      __NetBSD__
                   8720: OpenBSD     __OpenBSD__
                   8721: Solaris     sun, __sun
1.75      rillig   8722: </pre>
                   8723: </div>
                   8724: <div class="sect3" lang="en">
                   8725: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8726: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8727: <pre class="programlisting">
1.100     rillig   8728: i386        i386, __i386, __i386__
                   8729: MIPS        __mips
                   8730: SPARC       sparc, __sparc
1.75      rillig   8731: </pre>
                   8732: </div>
                   8733: <div class="sect3" lang="en">
                   8734: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8735: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8736: <pre class="programlisting">
1.100     rillig   8737: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8738: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8739: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8740: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8741: </pre>
                   8742: </div>
                   8743: </div>
1.78      rillig   8744: <div class="sect2" lang="en">
                   8745: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8746: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8747: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8748:         combinations of compiler version and architecture and almost
                   8749:         always relation to optimisation being enabled.  Common symptoms
                   8750:         are gcc internal errors or never finishing compiling a
1.78      rillig   8751:        file.</p>
                   8752: <p>Typically, a workaround involves testing the
                   8753:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8754:         optimisation for that combination of file,
                   8755:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8756:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8757:        number of examples.</p>
                   8758: </div>
                   8759: <div class="sect2" lang="en">
                   8760: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8761: <a name="undefined-reference"></a>19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.92      rillig   8762: <p>This error message often means that a package did not
1.78      rillig   8763:        link to a shared library it needs. The following functions are
                   8764:        known to cause this error message over and over.</p>
                   8765: <div class="informaltable">
                   8766: <a name="undefined-reference-functions"></a><table border="1">
                   8767: <colgroup>
                   8768: <col>
                   8769: <col>
                   8770: <col>
                   8771: </colgroup>
                   8772: <thead><tr>
                   8773: <th>Function</th>
                   8774: <th>Library</th>
                   8775: <th>Affected platforms</th>
                   8776: </tr></thead>
                   8777: <tbody>
                   8778: <tr>
                   8779: <td>accept, bind, connect</td>
                   8780: <td>-lsocket</td>
                   8781: <td>Solaris</td>
                   8782: </tr>
                   8783: <tr>
                   8784: <td>crypt</td>
                   8785: <td>-lcrypt</td>
                   8786: <td>DragonFly, NetBSD</td>
                   8787: </tr>
                   8788: <tr>
                   8789: <td>dlopen, dlsym</td>
                   8790: <td>-ldl</td>
                   8791: <td>Linux</td>
                   8792: </tr>
                   8793: <tr>
                   8794: <td>gethost*</td>
                   8795: <td>-lnsl</td>
                   8796: <td>Solaris</td>
                   8797: </tr>
                   8798: <tr>
                   8799: <td>inet_aton</td>
                   8800: <td>-lresolv</td>
                   8801: <td>Solaris</td>
                   8802: </tr>
                   8803: <tr>
                   8804: <td>nanosleep, sem_*, timer_*</td>
                   8805: <td>-lrt</td>
                   8806: <td>Solaris</td>
                   8807: </tr>
                   8808: <tr>
                   8809: <td>openpty</td>
                   8810: <td>-lutil</td>
                   8811: <td>Linux</td>
                   8812: </tr>
                   8813: </tbody>
                   8814: </table>
                   8815: </div>
                   8816: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8817:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8818:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8819:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8820:     bmake</strong></span>.</p>
1.92      rillig   8821: <div class="sect3" lang="en">
                   8822: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8823: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8824: <p>When you are using the SunPro compiler, there is another
                   8825: possibility. That compiler cannot handle the following code:</p>
                   8826: <pre class="programlisting">
1.100     rillig   8827: extern int extern_func(int);
1.93      rillig   8828: 
1.100     rillig   8829: static inline int
                   8830: inline_func(int x)
                   8831: {
1.92      rillig   8832:         return extern_func(x);
1.100     rillig   8833: }
1.93      rillig   8834: 
1.100     rillig   8835: int main(void)
                   8836: {
1.92      rillig   8837:         return 0;
1.100     rillig   8838: }
1.92      rillig   8839: </pre>
                   8840: <p>It generates the code for <code class="function">inline_func</code> even if
                   8841: that function is never used. This code then refers to
                   8842: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8843: solve this problem you can try to tell the package to disable inlining
                   8844: of functions.</p>
                   8845: </div>
1.87      wiz      8846: </div>
                   8847: <div class="sect2" lang="en">
                   8848: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8849: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8850: <p>Sometimes packages fail to build because the compiler runs
                   8851:     into an operating system specific soft limit.  With the
                   8852:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8853:     to unlimit the resources.  Currently, the allowed values are
                   8854:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8855:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8856:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8857:     segment size or maximum stack size of a process, respectively, to
                   8858:     their hard limits.</p>
1.78      rillig   8859: </div>
1.75      rillig   8860: </div>
                   8861: <div class="sect1" lang="en">
                   8862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8863: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   8864: <div class="sect2" lang="en">
                   8865: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8866: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8867: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8868:     with some operating systems cannot create more than one
                   8869:     directory at a time. As such, you should call
                   8870:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8871: <pre class="programlisting">
1.100     rillig   8872: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8873: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      8874:     </pre>
1.78      rillig   8875: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
1.87      wiz      8876:     dir2</code></span>&#8221; to the
                   8877:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8878:     automatically do the right thing.</p>
1.75      rillig   8879: </div>
                   8880: <div class="sect2" lang="en">
                   8881: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8882: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8883: <p>In general, documentation should be installed into
1.87      wiz      8884:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8885:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8886:     includes the version number of the package).</p>
1.84      wiz      8887: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8888:     directory where HTML documentation is installed with the
                   8889:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8890:     is needed because otherwise the documentation ends up in
                   8891:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8892:     places.</p>
                   8893: <p>An exception to the above is that library API documentation
1.91      rillig   8894:     generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      8895:     browsers (devhelp) should be left at their default location, which
                   8896:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8897:     documentation can be recognized from files ending in
                   8898:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8899:     (It is also acceptable to install such files in
                   8900:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8901:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8902:     <code class="filename">.devhelp*</code> file must be directly in that
                   8903:     directory then, no additional subdirectory level is allowed in
                   8904:     this case. This is usually achieved by using
                   8905:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8906:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8907:     though.)</p>
1.75      rillig   8908: </div>
                   8909: <div class="sect2" lang="en">
                   8910: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8911: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8912: <p>Certain packages, most of them in the games category, install
1.87      wiz      8913:     a score file that allows all users on the system to record their
                   8914:     highscores.  In order for this to work, the binaries need to be
                   8915:     installed setgid and the score files owned by the appropriate
                   8916:     group and/or owner (traditionally the "games" user/group).  The
                   8917:     following variables, documented in more detail in
                   8918:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8919:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8920:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8921:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75      rillig   8922: <p>Note that per default, setgid installation of games is
1.87      wiz      8923:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8924:     the other variables accordingly.</p>
1.114     jmcneill 8925: <p>A package should therefore never hard code file ownership or
1.87      wiz      8926:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8927:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8928:     correctly.</p>
1.75      rillig   8929: </div>
                   8930: <div class="sect2" lang="en">
                   8931: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8932: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8933: <p><code class="varname">DESTDIR</code> support means that a package
                   8934:     installs into a staging directory, not the final location of the
                   8935:     files. Then a binary package is created which can be used for
                   8936:     installation as usual. There are two ways: Either the package must
                   8937:     install as root (&#8220;<span class="quote">destdir</span>&#8221;) or the package can
                   8938:     install as non-root user (&#8220;<span class="quote">user-destdir</span>&#8221;).</p>
                   8939: <div class="itemizedlist"><ul type="disc">
                   8940: <li><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
                   8941:       set to &#8220;<span class="quote">destdir</span>&#8221; or &#8220;<span class="quote">user-destdir</span>&#8221;. If
                   8942:       bsd.prefs.mk is included in the Makefile,
                   8943:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8944:       the inclusion.</p></li>
1.103     wiz      8945: <li><p>All installation operations have to be prefixed with
                   8946:       <code class="filename">${DESTDIR}</code>.</p></li>
                   8947: <li><p>automake gets this DESTDIR mostly right
                   8948:       automatically. Many manual rules and pre/post-install often are
                   8949:       incorrect; fix them.</p></li>
                   8950: <li><p>If files are installed with special owner/group
1.118     imil     8951:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.103     wiz      8952: <li><p>In general, packages should support
                   8953:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8954:       DESTDIR.</p></li>
                   8955: </ul></div>
                   8956: </div>
                   8957: <div class="sect2" lang="en">
                   8958: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8959: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8960: <p>Your package may also contain scripts with hardcoded paths to
                   8961:       other interpreters besides (or as well as) perl.  To correct the
                   8962:       full pathname to the script interpreter, you need to set the
                   8963:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8964:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8965: <pre class="programlisting">
1.100     rillig   8966: REPLACE_INTERPRETER+=   tcl
                   8967: REPLACE.tcl.old=        .*/bin/tclsh
                   8968: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8969: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8970: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      8971:     </pre>
1.75      rillig   8972: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8973: <h3 class="title">Note</h3>
                   8974: <p>Before March 2006, these variables were called
1.87      wiz      8975:     <code class="varname">_REPLACE.*</code> and
                   8976:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8977: </div>
                   8978: </div>
                   8979: <div class="sect2" lang="en">
                   8980: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8981: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8982: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8983:     the Makefile fragment
                   8984:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8985:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8986:     configuration for such modules as well as various hooks to tune
                   8987:     this configuration.  See comments in this file for
                   8988:     details.</p>
1.75      rillig   8989: <p>Perl5 modules will install into different places depending
1.87      wiz      8990:     on the version of perl used during the build process.  To
                   8991:     address this, pkgsrc will append lines to the
                   8992:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8993:     the installed <code class="filename">.packlist</code> file generated by
                   8994:     most perl5 modules.  This is invoked by defining
                   8995:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8996:     paths to packlist files, e.g.:</p>
1.75      rillig   8997: <pre class="programlisting">
1.100     rillig   8998: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87      wiz      8999:     </pre>
1.75      rillig   9000: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87      wiz      9001:     <code class="varname">PERL5_SITEARCH</code>, and
                   9002:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   9003:     in which perl5 modules may be installed, and may be used by
                   9004:     perl5 packages that don't have a packlist.  These three
                   9005:     variables are also substituted for in the
                   9006:     <code class="filename">PLIST</code>.</p>
1.75      rillig   9007: </div>
                   9008: <div class="sect2" lang="en">
                   9009: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9010: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   9011: <p>Some packages install info files or use the
1.87      wiz      9012:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   9013:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9014:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9015:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9016:     handle registration of the info files in the Info directory
                   9017:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   9018:     files registration is either provided by the system, or by a
                   9019:     special purpose package automatically added as dependency if
                   9020:     needed.</p>
1.75      rillig   9021: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9022:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9023:     located. <code class="varname">PKGINFODIR</code> defaults to
                   9024:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
1.75      rillig   9025: <p>The info files for the package should be listed in the
1.87      wiz      9026:     package <code class="filename">PLIST</code>; however any split info files
                   9027:     need not be listed.</p>
1.75      rillig   9028: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
1.87      wiz      9029:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   9030:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   9031:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   9032:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9033:     variable in the package <code class="filename">Makefile</code>. By
                   9034:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9035:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9036:     does not match the required minimum, a build dependency on the
1.91      rillig   9037:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      9038:     be added automatically.</p>
1.75      rillig   9039: <p>The build and installation process of the software provided
1.87      wiz      9040:     by the package should not use the
1.110     hubertf  9041:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9042:     info files is the task of the package
                   9043:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9044:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9045: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9046:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9047:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9048:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9049: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9050:     no effect except the logging of a message. The script overriding
1.110     hubertf  9051:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9052:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9053:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9054: </div>
                   9055: <div class="sect2" lang="en">
                   9056: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9057: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   9058: <p>All packages that install manual pages should install them
1.87      wiz      9059:     into the same directory, so that there is one common place to look
                   9060:     for them. In pkgsrc, this place is
                   9061:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9062:     should be used in packages. The default for
                   9063:     <code class="varname">PKGMANDIR</code> is
                   9064:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   9065:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
1.75      rillig   9066: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9067: <h3 class="title">Note</h3>
1.87      wiz      9068: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9069:     is far from complete.</p>
1.75      rillig   9070: </div>
1.81      rillig   9071: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9072:     <code class="filename">man/</code> as the top level directory for the man
                   9073:     page file entries, and the pkgsrc framework will convert as
                   9074:     needed. In all other places, the correct
                   9075:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9076: <p>Packages that are
                   9077:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   9078:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   9079:     <code class="filename">./configure</code>
                   9080:     --mandir switch to set where the man pages should be installed.
                   9081:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9082:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9083: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9084:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   9085:     to &#8220;<span class="quote">no</span>&#8221;.
                   9086:     Or if the <code class="filename">./configure</code> script uses
                   9087:     a non-standard use of --mandir, you can set
                   9088:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  9089: <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.87      wiz      9090:     information on installation of compressed manual pages.</p>
1.75      rillig   9091: </div>
                   9092: <div class="sect2" lang="en">
                   9093: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   9094: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      9095: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   9096:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      9097:     you need to take some extra steps to make sure they get registered
                   9098:     in the database:</p>
1.75      rillig   9099: <div class="orderedlist"><ol type="1">
1.107     rillig   9100: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      9101:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   9102:        takes care of rebuilding the GConf database at installation and
1.87      wiz      9103:        deinstallation time, and tells the package where to install
1.107     rillig   9104:        GConf data files using some standard configure arguments.  It
1.87      wiz      9105:        also disallows any access to the database directly from the
                   9106:        package.</p></li>
1.75      rillig   9107: <li><p>Ensure that the package installs its
1.87      wiz      9108:        <code class="filename">.schemas</code> files under
                   9109:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9110:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9111:        need to manually patch the package.</p></li>
1.75      rillig   9112: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      9113:        directory, as they will be handled automatically.  See
1.110     hubertf  9114:        <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.107     rillig   9115: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      9116:        your <code class="filename">Makefile</code> with a list of all
                   9117:        <code class="filename">.schemas</code> files installed by the package, if
                   9118:        any.  Names must not contain any directories in them.</p></li>
1.107     rillig   9119: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      9120:        your <code class="filename">Makefile</code> with a
                   9121:        list of all <code class="filename">.entries</code> files installed by the
                   9122:        package, if any. Names must not contain any directories in
                   9123:        them.</p></li>
1.75      rillig   9124: </ol></div>
                   9125: </div>
                   9126: <div class="sect2" lang="en">
                   9127: <div class="titlepage"><div><div><h3 class="title">
1.119   ! mishka   9128: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      9129: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119   ! mishka   9130:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      9131:     get registered in the database:</p>
1.75      rillig   9132: <div class="orderedlist"><ol type="1">
                   9133: <li><p>Include
1.119   ! mishka   9134:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
        !          9135:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      9136:        takes care of rebuilding the scrollkeeper database at
                   9137:        installation and deinstallation time, and disallows any access
                   9138:        to it directly from the package.</p></li>
1.75      rillig   9139: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9140:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9141:        will be handled automatically.</p></li>
1.76      rillig   9142: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.119   ! mishka   9143:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
        !          9144:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   9145: </ol></div>
                   9146: </div>
                   9147: <div class="sect2" lang="en">
                   9148: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9149: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9150: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9151:     the fonts database in the directory where they get installed at
                   9152:     installation and deinstallation time.  This can be automatically
                   9153:     done by using the pkginstall framework.</p>
1.75      rillig   9154: <p>You can list the directories where fonts are installed in the
1.87      wiz      9155:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9156:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   9157:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   9158:     Also make sure that the database file
                   9159:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9160: <p>Note that you should not create new directories for fonts;
1.87      wiz      9161:     instead use the standard ones to avoid that the user needs to
                   9162:     manually configure his X server to find them.</p>
1.75      rillig   9163: </div>
                   9164: <div class="sect2" lang="en">
                   9165: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9166: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9167: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9168:     take some extra steps to get them registered in the GTK2 database
                   9169:     properly:</p>
1.75      rillig   9170: <div class="orderedlist"><ol type="1">
                   9171: <li><p>Include
1.87      wiz      9172:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9173:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9174:       rebuilding the database at installation and deinstallation time.</p></li>
                   9175: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   9176:       your package installs GTK2 immodules.</p></li>
                   9177: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   9178:       GTK2 loaders.</p></li>
1.75      rillig   9179: <li>
1.87      wiz      9180: <p>Patch the package to not touch any of the GTK2
                   9181:       databases directly.  These are:</p>
1.75      rillig   9182: <div class="itemizedlist"><ul type="disc">
1.76      rillig   9183: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9184: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9185: </ul></div>
                   9186: </li>
1.87      wiz      9187: <li><p>Check the <code class="filename">PLIST</code> and remove
                   9188:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9189:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9190: </ol></div>
                   9191: </div>
                   9192: <div class="sect2" lang="en">
                   9193: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9194: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9195: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9196:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9197:     etc.), you need to take some extra steps:</p>
1.75      rillig   9198: <div class="orderedlist"><ol type="1">
                   9199: <li><p>Include
1.87      wiz      9200:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9201:        your <code class="filename">Makefile</code>, which takes care of
                   9202:        registering those files in system-wide catalogs at
                   9203:        installation and deinstallation time.</p></li>
1.75      rillig   9204: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9205:        any SGML catalogs installed by the package.</p></li>
1.75      rillig   9206: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9207:        any XML catalogs installed by the package.</p></li>
1.75      rillig   9208: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9209:        to be added to the SGML catalog.  These come in groups of
                   9210:        three strings; see xmlcatmgr(1) for more information
                   9211:        (specifically, arguments recognized by the 'add' action).
                   9212:        Note that you will normally not use this variable.</p></li>
1.75      rillig   9213: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9214:        to be added to the XML catalog.  These come in groups of three
                   9215:        strings; see xmlcatmgr(1) for more information (specifically,
                   9216:        arguments recognized by the 'add' action).  Note that you will
                   9217:        normally not use this variable.</p></li>
1.75      rillig   9218: </ol></div>
                   9219: </div>
                   9220: <div class="sect2" lang="en">
                   9221: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9222: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9223: <p>If a package provides extensions to the MIME database by
1.87      wiz      9224:     installing <code class="filename">.xml</code> files inside
                   9225:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9226:     need to take some extra steps to ensure that the database is kept
                   9227:     consistent with respect to these new files:</p>
1.75      rillig   9228: <div class="orderedlist"><ol type="1">
                   9229: <li><p>Include
1.87      wiz      9230:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9231:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9232:        this same directory, which is reserved for inclusion from
                   9233:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9234:        care of rebuilding the MIME database at installation and
                   9235:        deinstallation time, and disallows any access to it directly
                   9236:        from the package.</p></li>
1.75      rillig   9237: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9238:        <code class="filename">share/mime</code> directory,
                   9239:        <span class="emphasis"><em>except</em></span> for files saved under
                   9240:        <code class="filename">share/mime/packages</code>.  The former are
                   9241:        handled automatically by
                   9242:        the update-mime-database program, but the latter are
                   9243:        package-dependent and must be removed by the package that
                   9244:        installed them in the first place.</p></li>
1.76      rillig   9245: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9246:        from the PLIST.  They will be handled by the shared-mime-info
                   9247:        package.</p></li>
1.75      rillig   9248: </ol></div>
                   9249: </div>
                   9250: <div class="sect2" lang="en">
                   9251: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9252: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9253: <p>If a package uses intltool during its build, add
                   9254:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9255:     which forces it to use the intltool package provided by pkgsrc,
                   9256:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9257: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9258:     latest available version; this way, the package benefits of any
                   9259:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9260: </div>
                   9261: <div class="sect2" lang="en">
                   9262: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9263: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9264: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9265:     the startup directory by default, but you can enable it, by adding
                   9266:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9267:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9268:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9269:     it will automatically remove the scripts when the package is
                   9270:     deinstalled.</p>
1.75      rillig   9271: </div>
                   9272: <div class="sect2" lang="en">
                   9273: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9274: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9275: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9276:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9277:     updated.</p>
1.75      rillig   9278: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9279: <h3 class="title">Note</h3>
                   9280: <p>Except the main TeX packages such as teTeX-texmf,
1.87      wiz      9281:     packages should install files
                   9282:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9283:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
1.75      rillig   9284: </div>
                   9285: <div class="orderedlist"><ol type="1">
                   9286: <li><p>Include
1.87      wiz      9287:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   9288:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   9289:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9290:       database at installation and deinstallation time.</p></li>
1.75      rillig   9291: <li>
                   9292: <p>If your package installs files into a texmf
1.87      wiz      9293:       tree other than the one
                   9294:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9295:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   9296:       trees that need database update.</p>
1.75      rillig   9297: <p>If your package also installs font map files that need
1.110     hubertf  9298:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.87      wiz      9299:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
1.110     hubertf  9300:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9301:       be run automatically at installation/deinstallation to
                   9302:       enable/disable font map files for TeX output
                   9303:       drivers.</p>
1.75      rillig   9304: </li>
1.76      rillig   9305: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9306:       databases are included in <code class="filename">PLIST</code>, as
                   9307:       they will be removed only by the teTeX-bin package.</p></li>
1.75      rillig   9308: </ol></div>
                   9309: </div>
1.85      jmmv     9310: <div class="sect2" lang="en">
                   9311: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9312: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      9313:     emulation</h3></div></div></div>
                   9314: <p>There are some packages that provide libraries and
                   9315:     executables for running binaries from a one operating system
                   9316:     on a different one (if the latter supports it).  One example
                   9317:     is running Linux binaries on NetBSD.</p>
1.91      rillig   9318: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      9319:     helps in extracting and packaging Linux rpm packages.</p>
                   9320: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9321:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9322:     if all libraries for each installed executable can be found by
                   9323:     the dynamic linker.  Since the standard dynamic linker is run,
                   9324:     this fails for emulation packages, because the libraries used
                   9325:     by the emulation are not in the standard directories.</p>
                   9326: </div>
                   9327: <div class="sect2" lang="en">
                   9328: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9329: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9330: <p>If a package installs images under the
1.87      wiz      9331:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9332:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9333:     database, you need to take some extra steps to make sure that the
                   9334:     shared theme directory is handled appropriately and that the cache
                   9335:     database is rebuilt:</p>
1.85      jmmv     9336: <div class="orderedlist"><ol type="1">
                   9337: <li><p>Include
1.87      wiz      9338:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9339: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   9340:        entry that refers to the theme cache.</p></li>
1.85      jmmv     9341: <li><p>Ensure that the PLIST does not remove the shared icon
                   9342:          directories from the <code class="filename">share/icons/hicolor</code>
                   9343:          hierarchy because they will be handled automatically.</p></li>
                   9344: </ol></div>
                   9345: <p>The best way to verify that the PLIST is correct with
                   9346:       respect to the last two points is to regenerate it using
1.110     hubertf  9347:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     9348: </div>
                   9349: <div class="sect2" lang="en">
                   9350: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9351: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9352: <p>If a package installs <code class="filename">.desktop</code> files
                   9353:       under <code class="filename">share/applications</code> and these include
                   9354:       MIME information, you need to take extra steps to ensure that they
                   9355:       are registered into the MIME database:</p>
                   9356: <div class="orderedlist"><ol type="1">
                   9357: <li><p>Include
                   9358:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9359: <li><p>Check the PLIST and remove the entry that refers to the
                   9360:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9361:          It will be handled automatically.</p></li>
                   9362: </ol></div>
                   9363: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  9364:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     9365:       print-PLIST</strong></span>.</p>
1.75      rillig   9366: </div>
                   9367: </div>
1.87      wiz      9368: <div class="sect1" lang="en">
                   9369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9370: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9371: <p>In some cases one does not have the time to solve a problem
                   9372:   immediately.  There are currently two ways to declare that one knows
                   9373:   that a package has problems.</p>
                   9374: <div class="itemizedlist"><ul type="disc">
                   9375: <li><p>The first way is to plainly mark it as broken.  For
                   9376:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9377:     reason why the package is broken (similar to the
                   9378:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9379:     the package will immediately be shown this message, and the build
                   9380:     will not be even tried.</p></li>
                   9381: <li><p>After each pkgsrc freeze period (a time when the
                   9382:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9383:     that were not building in the official branch build on the latest
                   9384:     NetBSD release will be marked as broken on that branch.  This is
                   9385:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9386:     branch name (or appending the branch name to it).  If a user tries
                   9387:     to build such a package and the build fails, the user gets a
                   9388:     message that says that the package was broken on the respective
                   9389:     branch(es).</p></li>
                   9390: </ul></div>
                   9391: <p>Both types of packages are removed from pkgsrc in irregular
                   9392:   intervals.</p>
                   9393: </div>
1.75      rillig   9394: </div>
                   9395: <div class="chapter" lang="en">
                   9396: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9397: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      9398: <p>To check out all the gotchas when building a package, here are
                   9399:   the steps that I do in order to get a package working.  Please note
                   9400:   this is basically the same as what was explained in the previous
                   9401:   sections, only with some debugging aids.</p>
1.75      rillig   9402: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9403: <li><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>
1.75      rillig   9404: <li>
1.91      rillig   9405: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      9406:       create a directory for a new package, change into it, then run
1.110     hubertf  9407:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   9408: <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>
                   9409: <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>
                   9410: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9411: </li>
1.76      rillig   9412: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9413: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.110     hubertf  9414: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.75      rillig   9415: <li><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9416:       configure step to the package's
                   9417:       <code class="filename">Makefile</code>.</p></li>
1.75      rillig   9418: <li>
                   9419: <p>Make the package compile, doing multiple rounds of</p>
                   9420: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9421: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9422: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9423: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9424: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9425: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9426: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9427: <p>Doing this step as non-root user will ensure that no files
                   9428:       are modified that shouldn't be, especially during the build
1.110     hubertf  9429:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9430:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91      rillig   9431:       from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88      wiz      9432:       package.</p>
1.75      rillig   9433: </li>
1.88      wiz      9434: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.116     rillig   9435:       necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, &#8220;Makefile&#8221;</a>.</p></li>
1.75      rillig   9436: <li>
1.76      rillig   9437: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9438: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9439: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9440: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9441: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9442: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9443: <p>You usually need to be <code class="username">root</code> to do
                   9444:       this.  Look if there are any files left:</p>
1.75      rillig   9445: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9446: <p>If this reveals any files that are missing in
1.88      wiz      9447:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9448: </li>
                   9449: <li>
1.88      wiz      9450: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9451:       package again and make a binary package:</p>
1.75      rillig   9452: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9453: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9454: </li>
                   9455: <li>
                   9456: <p>Delete the installed package:</p>
1.88      wiz      9457: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75      rillig   9458: </li>
                   9459: <li>
1.110     hubertf  9460: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      9461:       command, which shouldn't find anything now:</p>
1.75      rillig   9462: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9463: </li>
                   9464: <li>
                   9465: <p>Reinstall the binary package:</p>
1.93      rillig   9466: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75      rillig   9467: </li>
1.88      wiz      9468: <li><p>Play with it.  Make sure everything works.</p></li>
1.75      rillig   9469: <li>
1.110     hubertf  9470: <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.88      wiz      9471:       reports:</p>
1.75      rillig   9472: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9473: </li>
1.110     hubertf  9474: <li><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.75      rillig   9475: </ul></div>
                   9476: </div>
                   9477: <div class="chapter" lang="en">
                   9478: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9479: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   9480: <div class="toc">
                   9481: <p><b>Table of Contents</b></p>
                   9482: <dl>
1.106     rillig   9483: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9484: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9485: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9486: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   9487: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   9488: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9489: </dl>
                   9490: </div>
                   9491: <div class="sect1" lang="en">
                   9492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9493: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9494: <p>Our policy is that we accept binaries only from pkgsrc
                   9495:        developers to guarantee that the packages don't contain any
                   9496:        trojan horses etc. This is not to annoy anyone but rather to
                   9497:        protect our users! You're still free to put up your home-made
                   9498:        binary packages and tell the world where to get them. NetBSD
                   9499:        developers doing bulk builds and wanting to upload them please
1.110     hubertf  9500:        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.75      rillig   9501: </div>
                   9502: <div class="sect1" lang="en">
                   9503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9504: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9505: <p>First, check that your package is complete, compiles and
1.110     hubertf  9506:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
                   9507:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9508:        archive that contains all files that make up the package.
1.87      wiz      9509:        Finally, send this package to the pkgsrc bug tracking system,
1.110     hubertf  9510:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9511:        that, go to the web page
1.110     hubertf  9512:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.87      wiz      9513:        which contains some instructions and a link to a form, where you
                   9514:        can submit packages.</p>
                   9515: <p>In the form of the problem report, the category should be
                   9516:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9517:        and version number, and the description field should contain a
                   9518:        short description of your package (contents of the COMMENT
                   9519:        variable or DESCR file are OK). The uuencoded package data should
                   9520:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
1.75      rillig   9521: <p>If you want to submit several packages, please send a
                   9522:        separate PR for each one, it's easier for us to track things
                   9523:        that way.</p>
                   9524: <p>Alternatively, you can also import new packages into
                   9525:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
1.110     hubertf  9526:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75      rillig   9527:        for details.</p>
                   9528: </div>
                   9529: <div class="sect1" lang="en">
                   9530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9531: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9532: <p>Please note all package additions, updates, moves, and
1.93      rillig   9533:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9534:        important to keep this file up to date and conforming to the
                   9535:        existing format, because it will be used by scripts to
1.110     hubertf  9536:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9537:        sites. Additionally, check the
1.76      rillig   9538:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9539:        for the package you updated or removed, in case it was mentioned
                   9540:        there.</p>
                   9541: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9542:        bumped, the change should appear in
1.93      rillig   9543:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9544:        related or otherwise relevant. Mass bumps that result from a
                   9545:        dependency being updated should not be mentioned. In all other
                   9546:        cases it's the developer's decision.</p>
                   9547: <p>There is a make target that helps in creating proper
1.110     hubertf  9548:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9549:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9550:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9551:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9552:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9553:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9554:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9555:   For new packages, or package moves or removals, set the
                   9556:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9557:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9558:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.75      rillig   9559:   not the same as your NetBSD login name. Don't forget to commit
1.93      rillig   9560:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
1.75      rillig   9561: </div>
                   9562: <div class="sect1" lang="en">
                   9563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9564: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87      wiz      9565: <p>This section is only of interest for pkgsrc developers with write
1.75      rillig   9566:   access to the pkgsrc repository. Please remember that cvs
                   9567:   imports files relative to the current working directory, and that
                   9568:   the pathname that you
1.110     hubertf  9569:   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75      rillig   9570:   to place the files in the repository.  Newly created packages should be
                   9571:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
1.87      wiz      9572:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
1.75      rillig   9573: <pre class="programlisting">
1.100     rillig   9574: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9575: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75      rillig   9576: </pre>
1.87      wiz      9577: <p>Remember to move the directory from which you imported out of
1.75      rillig   9578:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9579:   update</span>&#8221; your source tree.  Also don't forget to add the new
1.87      wiz      9580:   package to the category's <code class="filename">Makefile</code>.</p>
                   9581: <p>The commit message of the initial import should include part of the
1.76      rillig   9582:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9583:   what the package is/does.</p>
                   9584: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
1.75      rillig   9585:   add</span>&#8221; because the former gets everything with a single command,
1.87      wiz      9586:   and provides a consistent tag.</p>
1.75      rillig   9587: </div>
                   9588: <div class="sect1" lang="en">
                   9589: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9590: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9591: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9592:   changes between old and new versions into the commit log when updating
1.87      wiz      9593:   a package. There are various reasons for this:</p>
1.75      rillig   9594: <div class="itemizedlist"><ul type="disc">
1.87      wiz      9595: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9596:   or its information may be overwritten by newer information.</p></li>
                   9597: <li><p>Having the change information between old and new versions in our CVS
                   9598:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9599: <li><p>Having the change information between old and new versions in our CVS
1.75      rillig   9600:   repository is very useful for people who read the pkgsrc-changes mailing
                   9601:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9602:   the package.</p></li>
1.75      rillig   9603: </ul></div>
1.87      wiz      9604: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9605:   has been released, it should not automatically be upgraded in the CVS
                   9606:   repository.  We prefer to be conservative in the packages that are
                   9607:   included in pkgsrc - development or beta packages are not really the
                   9608:   best thing for most places in which pkgsrc is used. Please use your
                   9609:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9610:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9611: </div>
                   9612: <div class="sect1" lang="en">
                   9613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9614: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.75      rillig   9615: <div class="orderedlist"><ol type="1">
                   9616: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9617: <li>
                   9618: <p>Remove all CVS dirs.</p>
1.87      wiz      9619: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9620: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87      wiz      9621: <p>and use that for further work.</p>
1.75      rillig   9622: </li>
                   9623: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9624: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9625: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
1.110     hubertf  9626: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9627: place.</p></li>
                   9628: <li>
                   9629: <p>Check if any package depends on it:
                   9630: </p>
                   9631: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9632: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9633: </li>
                   9634: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.110     hubertf  9635: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76      rillig   9636: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9637: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75      rillig   9638: <li>
                   9639: <p>Commit the changed and removed files:</p>
                   9640: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87      wiz      9641: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9642: </li>
                   9643: </ol></div>
                   9644: </div>
                   9645: </div>
                   9646: <div class="chapter" lang="en">
                   9647: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9648: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9649: <p>This section contains the answers to questions that may
                   9650:        arise when you are writing a package. If you don't find your
                   9651:        question answered here, first have a look in the other chapters,
                   9652:        and if you still don't have the answer, ask on the
                   9653:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9654: <div class="qandaset">
                   9655: <dl>
1.106     rillig   9656: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9657:        MAKEFLAGS, .MAKEFLAGS and
                   9658:        MAKE_FLAGS?</a>
                   9659: </dt>
1.106     rillig   9660: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9661:        MAKE, GMAKE and
                   9662:        MAKE_PROGRAM?</a>
                   9663: </dt>
1.106     rillig   9664: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9665:        CC, PKG_CC and
                   9666:        PKGSRC_COMPILER?</a>
                   9667: </dt>
1.106     rillig   9668: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9669:        BUILDLINK_LDFLAGS,
                   9670:        BUILDLINK_LDADD and
                   9671:        BUILDLINK_LIBS?</a>
                   9672: </dt>
1.106     rillig   9673: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9674:        VARNAME=BUILDLINK_PREFIX.foo
                   9675:        say it's empty?</a>
                   9676: </dt>
1.106     rillig   9677: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9678:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9679:        don't understand the := inside
                   9680:        it.</a>
                   9681: </dt>
1.106     rillig   9682: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9683:        developers?</a>
                   9684: </dt>
1.106     rillig   9685: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9686:        documentation?</a>
                   9687: </dt>
1.106     rillig   9688: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   9689: do?</a>
                   9690: </dt>
1.75      rillig   9691: </dl>
                   9692: <table border="0" summary="Q and A Set">
                   9693: <col align="left" width="1%">
                   9694: <tbody>
                   9695: <tr class="question">
                   9696: <td align="left" valign="top">
1.119   ! mishka   9697: <a name="devfaq.makeflags"></a><a name="id1168230291165"></a><p><b>22.1.</b></p>
1.75      rillig   9698: </td>
                   9699: <td align="left" valign="top"><p>What is the difference between
                   9700:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9701:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9702: </tr>
                   9703: <tr class="answer">
1.91      rillig   9704: <td align="left" valign="top"></td>
1.75      rillig   9705: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110     hubertf  9706:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   9707:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9708:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9709:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9710: </tr>
                   9711: <tr class="question">
                   9712: <td align="left" valign="top">
1.119   ! mishka   9713: <a name="devfaq.make"></a><a name="id1168230291198"></a><p><b>22.2.</b></p>
1.75      rillig   9714: </td>
                   9715: <td align="left" valign="top"><p>What is the difference between
                   9716:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9717:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9718: </tr>
                   9719: <tr class="answer">
1.91      rillig   9720: <td align="left" valign="top"></td>
1.75      rillig   9721: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110     hubertf  9722:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   9723:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9724:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9725:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9726:        Make program that is used for building the
                   9727:        package.</p></td>
                   9728: </tr>
                   9729: <tr class="question">
                   9730: <td align="left" valign="top">
1.119   ! mishka   9731: <a name="devfaq.cc"></a><a name="id1168230291236"></a><p><b>22.3.</b></p>
1.75      rillig   9732: </td>
                   9733: <td align="left" valign="top"><p>What is the difference between
                   9734:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9735:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9736: </tr>
                   9737: <tr class="answer">
1.91      rillig   9738: <td align="left" valign="top"></td>
1.75      rillig   9739: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9740:        compiler, which can be configured by the pkgsrc user.
                   9741:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9742:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9743:        path to a compiler, but the type of compiler that should be
1.76      rillig   9744:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9745:        information about the latter variable.</p></td>
                   9746: </tr>
                   9747: <tr class="question">
                   9748: <td align="left" valign="top">
1.119   ! mishka   9749: <a name="devfaq.bl3flags"></a><a name="id1168230291270"></a><p><b>22.4.</b></p>
1.75      rillig   9750: </td>
                   9751: <td align="left" valign="top"><p>What is the difference between
                   9752:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9753:        <code class="varname">BUILDLINK_LDADD</code> and
                   9754:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9755: </tr>
                   9756: <tr class="answer">
1.91      rillig   9757: <td align="left" valign="top"></td>
1.75      rillig   9758: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9759: </tr>
                   9760: <tr class="question">
                   9761: <td align="left" valign="top">
1.119   ! mishka   9762: <a name="devfaq.bl3prefix"></a><a name="id1168230291289"></a><p><b>22.5.</b></p>
1.75      rillig   9763: </td>
1.110     hubertf  9764: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9765:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9766:        say it's empty?</p></td>
                   9767: </tr>
                   9768: <tr class="answer">
1.91      rillig   9769: <td align="left" valign="top"></td>
1.75      rillig   9770: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9771:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9772:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
1.110     hubertf  9773:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9774:        command.</p></td>
                   9775: </tr>
1.78      rillig   9776: <tr class="question">
                   9777: <td align="left" valign="top">
1.119   ! mishka   9778: <a name="devfaq.master_sites"></a><a name="id1168230291315"></a><p><b>22.6.</b></p>
1.78      rillig   9779: </td>
                   9780: <td align="left" valign="top"><p>What does
                   9781:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9782:        don't understand the <code class="literal">:=</code> inside
                   9783:        it.</p></td>
                   9784: </tr>
                   9785: <tr class="answer">
1.91      rillig   9786: <td align="left" valign="top"></td>
1.78      rillig   9787: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9788:        assignment operator, like you might expect at first sight.
                   9789:        Instead, it is a degenerate form of
                   9790:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110     hubertf  9791:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
1.78      rillig   9792:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9793:        case of <code class="varname">MASTER_SITE_*</code>,
                   9794:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9795:        <em class="replaceable"><code>new_string</code></em> is
                   9796:        <code class="literal">package/</code>. That's where the
                   9797:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9798:        together.</p></td>
                   9799: </tr>
                   9800: <tr class="question">
                   9801: <td align="left" valign="top">
1.119   ! mishka   9802: <a name="devfaq.mailinglists"></a><a name="id1168230291450"></a><p><b>22.7.</b></p>
1.78      rillig   9803: </td>
                   9804: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9805:        developers?</p></td>
                   9806: </tr>
                   9807: <tr class="answer">
1.91      rillig   9808: <td align="left" valign="top"></td>
1.78      rillig   9809: <td align="left" valign="top"><div class="variablelist"><dl>
1.110     hubertf  9810: <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.78      rillig   9811: <dd><p>This is a list for technical discussions related
                   9812:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9813:        pkgsrc infrastructure, proposed new features, questions related
                   9814:        to porting pkgsrc to a new platform, advice for maintaining a
                   9815:        package, patches that affect many packages, help requests moved
                   9816:        from pkgsrc-users when an infrastructure bug is found,
                   9817:        etc.</p></dd>
1.110     hubertf  9818: <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.78      rillig   9819: <dd><p>All bug reports in category "pkg" sent with
1.110     hubertf  9820:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   9821:        directly; use one of the other mailing
                   9822:        lists.</p></dd>
                   9823: </dl></div></td>
                   9824: </tr>
1.80      rillig   9825: <tr class="question">
                   9826: <td align="left" valign="top">
1.119   ! mishka   9827: <a name="devfaq.documentation"></a><a name="id1168230291481"></a><p><b>22.8.</b></p>
1.80      rillig   9828: </td>
                   9829: <td align="left" valign="top"><p>Where is the pkgsrc
                   9830:        documentation?</p></td>
                   9831: </tr>
                   9832: <tr class="answer">
1.91      rillig   9833: <td align="left" valign="top"></td>
1.80      rillig   9834: <td align="left" valign="top">
                   9835: <p>There are many places where you can find
                   9836:        documentation about pkgsrc:</p>
                   9837: <div class="itemizedlist"><ul type="disc">
                   9838: <li><p>The pkgsrc guide (this document) is a collection
                   9839:        of chapters that explain large parts of pkgsrc, but some
                   9840:        chapters tend to be outdated. Which ones they are is hard to
                   9841:        say.</p></li>
1.110     hubertf  9842: <li><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.80      rillig   9843:        about certain features, announcements of new parts of the pkgsrc
                   9844:        infrastructure and sometimes even announcements that a certain
                   9845:        feature has been marked as obsolete. The benefit here is that
                   9846:        each message has a date appended to it.</p></li>
                   9847: <li><p>Many of the files in the
                   9848:        <code class="filename">mk/</code> directory start with a comment that
                   9849:        describes the purpose of the file and how it can be used by the
1.92      rillig   9850:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9851:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9852:        help</strong></span>.</p></li>
1.80      rillig   9853: <li><p>The CVS log messages are a rich source of
                   9854:        information, but they tend to be highly abbreviated, especially
                   9855:        for actions that occur often. Some contain a detailed
                   9856:        description of what has changed, but they are geared towards the
                   9857:        other pkgsrc developers, not towards an average pkgsrc user.
                   9858:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9859:        don't know what has been before, these messages may not be worth
                   9860:        too much to you.</p></li>
                   9861: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9862:        documented</span>&#8221;, that is the documentation exists only in the
                   9863:        mind of the developer who wrote the code. To get this
1.110     hubertf  9864:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9865:        to see who has written it and ask on the
                   9866:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9867:        find your questions later (see above). To be sure that the
                   9868:        developer in charge reads the mail, you may CC him or
                   9869:        her.</p></li>
                   9870: </ul></div>
                   9871: </td>
                   9872: </tr>
1.92      rillig   9873: <tr class="question">
                   9874: <td align="left" valign="top">
1.119   ! mishka   9875: <a name="devfaq.too-much-time"></a><a name="id1168230291536"></a><p><b>22.9.</b></p>
1.92      rillig   9876: </td>
                   9877: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9878: do?</p></td>
                   9879: </tr>
                   9880: <tr class="answer">
                   9881: <td align="left" valign="top"></td>
                   9882: <td align="left" valign="top">
1.93      rillig   9883: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9884: anyway.</p>
                   9885: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9886: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92      rillig   9887:     <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
                   9888:     will tell you about newer versions of installed packages that are
                   9889:     available, but not yet updated in pkgsrc.</p></li>
                   9890: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.114     jmcneill 9891:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9892:     cleanups and enhancements for pkgsrc that would be nice to
                   9893:     have.</p></li>
                   9894: <li><p>Review packages for which review was requested on
1.110     hubertf  9895:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92      rillig   9896:     mailing list.</p></li>
                   9897: </ul></div>
                   9898: </td>
                   9899: </tr>
1.75      rillig   9900: </tbody>
                   9901: </table>
                   9902: </div>
                   9903: </div>
1.85      jmmv     9904: <div class="chapter" lang="en">
                   9905: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9906: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9907: <div class="toc">
                   9908: <p><b>Table of Contents</b></p>
                   9909: <dl>
1.106     rillig   9910: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9911: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9912: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9913: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9914: </dl>
                   9915: </div>
1.110     hubertf  9916: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9917: site</a>:</p>
                   9918: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9919:   environment, an intuitive and attractive desktop for users, and the
                   9920:   GNOME development platform, an extensive framework for building
                   9921:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9922: <p>pkgsrc provides a seamless way to automatically build and install
                   9923: a complete GNOME environment <span class="emphasis"><em>under many different
                   9924: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9925: the most advanced build and packaging systems for GNOME due to its
                   9926: included technologies buildlink3, the wrappers and tools framework and
                   9927: automatic configuration file management.  Lots of efforts are put into
                   9928: achieving a completely clean deinstallation of installed software
                   9929: components.</p>
1.110     hubertf  9930: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9931: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9932: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9933: pkgsrc as its preferred packaging system, contributing lots of
                   9934: portability fixes to make GNOME build and install under it.</p>
                   9935: <p>This chapter is aimed at pkgsrc developers and other people
                   9936: interested in helping our GNOME porting and packaging efforts.  It
                   9937: provides instructions on how to manage the existing packages and some
                   9938: important information regarding their internals.</p>
                   9939: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9940: <h3 class="title">We need your help!</h3>
                   9941: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9942:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9943:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9944:   work</a> list!  There is still a long way to go to get a
                   9945:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9946:   achieve it!</p>
                   9947: </div>
                   9948: <div class="sect1" lang="en">
                   9949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9950: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9951: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9952: <div class="itemizedlist"><ul type="disc">
1.91      rillig   9953: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
1.85      jmmv     9954:     the core GNOME desktop environment.  It only includes the necessary
                   9955:     bits to get it to boot correctly, although it may lack important
                   9956:     functionality for daily operation.  The idea behind this package is
                   9957:     to let end users build their own configurations on top of this one,
                   9958:     first installing this meta package to achieve a functional setup and
                   9959:     then adding individual applications.</p></li>
1.91      rillig   9960: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.85      jmmv     9961:     complete installation of the GNOME platform and desktop as defined
                   9962:     by the GNOME project; this is based on the components distributed in
                   9963:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9964:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9965:     official FTP server.  Developer-only tools found in those
                   9966:     directories are not installed unless required by some other
                   9967:     component to work properly.  Similarly, packages from the bindings
                   9968:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9969:     in unless required as a dependency for an end-user component.  This
1.91      rillig   9970:     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>
                   9971: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.85      jmmv     9972:     Installs all the tools required to build a GNOME component when
                   9973:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9974:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9975: </ul></div>
                   9976: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9977: sorted in a way that eases updates: a package may depend on other
                   9978: packages listed before it but not on any listed after it.  It is very
                   9979: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9980: change it to alphabetical sorting!</em></span></p>
                   9981: </div>
                   9982: <div class="sect1" lang="en">
                   9983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9984: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9985: <p>Almost all GNOME applications are written in C and use a common
                   9986: set of tools as their build system.  Things get different with the new
                   9987: bindings to other languages (such as Python), but the following will
                   9988: give you a general idea on the minimum required tools:</p>
                   9989: <div class="itemizedlist"><ul type="disc">
                   9990: <li>
                   9991: <p>Almost all GNOME applications use the GNU Autotools as their
                   9992:     build system.  As a general rule you will need to tell this to your
                   9993:     package:</p>
1.100     rillig   9994: <pre class="programlisting">
                   9995: GNU_CONFIGURE=yes
1.85      jmmv     9996: USE_LIBTOOL=yes
1.100     rillig   9997: USE_TOOLS+=gmake
                   9998: </pre>
1.85      jmmv     9999: </li>
                   10000: <li>
                   10001: <p>If the package uses pkg-config to detect dependencies, add this
                   10002:     tool to the list of required utilities:</p>
                   10003: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   10004: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85      jmmv     10005:     the end of the build process to ensure that you did not miss to
                   10006:     specify any dependency in your package and that the version
                   10007:     requirements are all correct.</p>
                   10008: </li>
1.93      rillig   10009: <li><p>If the package uses intltool, be sure to add
                   10010:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     10011:     to handle dependencies and to force the package to use the latest
                   10012:     available version.</p></li>
                   10013: <li>
                   10014: <p>If the package uses gtk-doc (a documentation generation
                   10015:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   10016:     tool is rather big and the distfile should come with pregenerated
                   10017:     documentation anyway; if it does not, it is a bug that you ought to
                   10018:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   10019:     the default):</p>
                   10020: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   10021: <p>The default location of installed HTML files
                   10022:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   10023:     and should not be changed unless the package insists on installing
                   10024:     them somewhere else.  Otherwise programs as
1.110     hubertf  10025:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   10026:     do that with an entry similar to:</p>
                   10027: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     10028: </li>
                   10029: </ul></div>
                   10030: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   10031: files under the installation prefix to maintain databases.  In this
                   10032: context, shared means that those exact same directories and files are
                   10033: used among several different packages, leading to conflicts in the
                   10034: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   10035: handle the most common cases, so you have to forget about using
                   10036: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   10037: omitting shared files from them.  If you find yourself doing those,
                   10038: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   10039: <p>The following table lists the common situations that result in
                   10040: using shared directories or files.  For each of them, the appropriate
                   10041: solution is given.  After applying the solution be sure to
                   10042: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  10043: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     10044: <div class="table">
1.106     rillig   10045: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   10046: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     10047: <colgroup>
                   10048: <col>
                   10049: <col>
                   10050: </colgroup>
                   10051: <thead><tr>
                   10052: <th>If the package...</th>
                   10053: <th>Then...</th>
                   10054: </tr></thead>
                   10055: <tbody>
                   10056: <tr>
                   10057: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119   ! mishka   10058: <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.85      jmmv     10059: </tr>
                   10060: <tr>
                   10061: <td>Installs icons under the
                   10062:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   10063:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  10064: <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.85      jmmv     10065: </tr>
                   10066: <tr>
                   10067: <td>Installs files under
                   10068:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  10069: <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.85      jmmv     10070: </tr>
                   10071: <tr>
                   10072: <td>Installs <code class="filename">.desktop</code> files under
                   10073:         <code class="filename">share/applications</code> and these include MIME
                   10074:         information.</td>
1.110     hubertf  10075: <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.85      jmmv     10076: </tr>
                   10077: </tbody>
1.91      rillig   10078: </table></div>
1.85      jmmv     10079: </div>
1.91      rillig   10080: <br class="table-break">
1.85      jmmv     10081: </div>
                   10082: <div class="sect1" lang="en">
                   10083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10084: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     10085: <p>When seeing GNOME as a whole, there are two kinds of
                   10086: updates:</p>
                   10087: <div class="variablelist"><dl>
                   10088: <dt><span class="term">Major update</span></dt>
                   10089: <dd>
                   10090: <p>Given that there is still a very long way for GNOME 3 (if it
                   10091:       ever appears), we consider a major update one that goes from a
                   10092:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   10093:       where <code class="literal">Y</code> is even and greater than
                   10094:       <code class="literal">X</code>.  These are hard to achieve because they
                   10095:       introduce lots of changes in the components' code and almost all
                   10096:       GNOME distfiles are updated to newer versions.  Some of them can
                   10097:       even break API and ABI compatibility with the previous major
                   10098:       version series.  As a result, the update needs to be done all at
                   10099:       once to minimize breakage.</p>
                   10100: <p>A major update typically consists of around 80 package
                   10101:       updates and the addition of some new ones.</p>
                   10102: </dd>
                   10103: <dt><span class="term">Minor update</span></dt>
                   10104: <dd>
                   10105: <p>We consider a minor update one that goes from a
                   10106:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10107:       one where <code class="literal">Y</code> is greater than
                   10108:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10109:       not update all GNOME components, can be done in an incremental way
                   10110:       and do not break API nor ABI compatibility.</p>
                   10111: <p>A minor update typically consists of around 50 package
                   10112:       updates, although the numbers here may vary a lot.</p>
                   10113: </dd>
                   10114: </dl></div>
                   10115: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10116: release (either major or minor), the following steps should be
                   10117: followed:</p>
                   10118: <div class="orderedlist"><ol type="1">
                   10119: <li>
                   10120: <p>Get a list of all the tarballs that form the new release by
                   10121:     using the following commands.  These will leave the full list of the
                   10122:     components's distfiles into the <code class="filename">list.txt</code>
                   10123:     file:</p>
1.88      wiz      10124: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10125:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10126:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      10127: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10128:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10129:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10130: </li>
                   10131: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   10132:     bump their version to the release you are updating them to.  The
                   10133:     three meta packages should be always consistent with versioning.
                   10134:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10135:     in them.</p></li>
                   10136: <li>
                   10137: <p>For each meta package, update all its
                   10138:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10139:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10140:     newer version (even if found in the FTP) because the meta packages
                   10141:     are supposed to list the exact versions that form a specific GNOME
                   10142:     release.  Exceptions are permitted here if a newer version solves a
                   10143:     serious issue in the overall desktop experience; these typically
                   10144:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10145:     from the developers.</p>
                   10146: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10147:     should be updated to the latest version available (if found in
                   10148:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   10149:     GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85      jmmv     10150: </li>
                   10151: <li>
                   10152: <p>Generate a patch from the modified meta packages and extract the
                   10153:     list of "new" lines.  This will provide you an outline on what
                   10154:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   10155: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' &gt;todo.txt</code></strong></pre>
1.85      jmmv     10156: </li>
                   10157: <li><p>For major desktop updates it is recommended to zap all your
                   10158:     installed packages and start over from scratch at this point.</p></li>
                   10159: <li><p>Now comes the longest step by far: iterate over the contents
                   10160:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10161:     it in order.  For major desktop updates none of these should be
1.93      rillig   10162:     committed until the entire set is completed because there are chances
1.85      jmmv     10163:     of breaking not-yet-updated packages.</p></li>
                   10164: <li><p>Once the packages are up to date and working, commit them to
                   10165:     the tree one by one with appropriate log messages.  At the end,
                   10166:     commit the three meta package updates and all the corresponding
                   10167:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10168:     <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>
                   10169: </ol></div>
                   10170: </div>
                   10171: <div class="sect1" lang="en">
                   10172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10173: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     10174: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10175: packages.  Please, it is very important that you always, always,
                   10176: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  10177: 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.85      jmmv     10178: their attention on portability issues and to ensure that future versions
                   10179: can be built out-of-the box on NetBSD.  The less custom patches in
                   10180: pkgsrc, the easier further updates are.  Those developers in charge of
                   10181: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  10182: <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.85      jmmv     10183: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10184: of them do.  Do not be short on your reports: always provide detailed
                   10185: explanations of the current failure, how it can be improved to achieve
                   10186: maximum portability and, if at all possible, provide a patch against CVS
                   10187: head.  The more verbose you are, the higher chances of your patch being
                   10188: accepted.</p>
                   10189: <p>Also, please avoid using preprocessor magic to fix portability
                   10190: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10191: GNOME to their operating system, the official GNOME sources are now
                   10192: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10193: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  10194: 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.85      jmmv     10195: details.</p>
                   10196: </div>
                   10197: </div>
1.75      rillig   10198: </div>
                   10199: <div class="part" lang="en">
                   10200: <div class="titlepage"><div><div><h1 class="title">
                   10201: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   10202: <div class="partintro" lang="en">
                   10203: <div></div>
                   10204: <p>This part of the guide deals with everything
                   10205:        from the infrastructure that is behind the interfaces described
                   10206:        in the developer's guide. A casual package maintainer should not
                   10207:        need anything from this part.</p>
                   10208: <div class="toc">
                   10209: <p><b>Table of Contents</b></p>
                   10210: <dl>
1.106     rillig   10211: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10212: <dd><dl>
1.106     rillig   10213: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10214: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10215: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   10216: <dd><dl>
1.106     rillig   10217: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10218: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   10219: </dl></dd>
1.106     rillig   10220: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10221: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10222: <dd><dl>
1.106     rillig   10223: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10224: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10225: </dl></dd>
1.106     rillig   10226: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10227: <dd><dl>
1.116     rillig   10228: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
                   10229: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75      rillig   10230: </dl></dd>
                   10231: </dl></dd>
1.106     rillig   10232: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   10233: <dd><dl>
1.106     rillig   10234: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10235: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10236: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10237: <dd><dl>
1.106     rillig   10238: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10239: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10240: </dl></dd>
                   10241: </dl></dd>
1.106     rillig   10242: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig   10243: <dd><dl>
1.106     rillig   10244: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10245: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10246: </dl></dd>
                   10247: </dl>
                   10248: </div>
                   10249: </div>
                   10250: <div class="chapter" lang="en">
                   10251: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10252: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10253: <div class="toc">
                   10254: <p><b>Table of Contents</b></p>
                   10255: <dl>
1.106     rillig   10256: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10257: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10258: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   10259: <dd><dl>
1.106     rillig   10260: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10261: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   10262: </dl></dd>
1.106     rillig   10263: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10264: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10265: <dd><dl>
1.106     rillig   10266: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10267: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10268: </dl></dd>
1.106     rillig   10269: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10270: <dd><dl>
1.116     rillig   10271: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
                   10272: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75      rillig   10273: </dl></dd>
                   10274: </dl>
                   10275: </div>
                   10276: <p>The pkgsrc infrastructure consists of many small Makefile
                   10277:        fragments. Each such fragment needs a properly specified
                   10278:        interface. This chapter explains how such an interface looks
                   10279:        like.</p>
                   10280: <div class="sect1" lang="en">
                   10281: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10282: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10283: <p>Whenever a variable is defined in the pkgsrc
                   10284:        infrastructure, the location and the way of definition provide
                   10285:        much information about the intended use of that variable.
                   10286:        Additionally, more documentation may be found in a header
                   10287:        comment or in this pkgsrc guide.</p>
                   10288: <p>A special file is
                   10289:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10290:        variables that are intended to be user-defined. They are either
                   10291:        defined using the <code class="literal">?=</code> operator or they are
                   10292:        left undefined because defining them to anything would
                   10293:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10294:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10295:        file.</p>
                   10296: <p>Outside this file, the following conventions apply:
                   10297:        Variables that are defined using the <code class="literal">?=</code>
                   10298:        operator may be overridden by a package.</p>
                   10299: <p>Variables that are defined using the <code class="literal">=</code>
                   10300:        operator may be used read-only at run-time.</p>
                   10301: <p>Variables whose name starts with an underscore must not be
                   10302:        accessed outside the pkgsrc infrastructure at all. They may
                   10303:        change without further notice.</p>
                   10304: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10305: <h3 class="title">Note</h3>
                   10306: <p>These conventions are currently not applied
                   10307:        consistently to the complete pkgsrc
                   10308:        infrastructure.</p>
                   10309: </div>
                   10310: </div>
                   10311: <div class="sect1" lang="en">
                   10312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10313: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10314: <p>All variables that contain lists of things should default
                   10315:        to being empty. Two examples that do not follow this rule are
                   10316:        <code class="varname">USE_LANGUAGES</code> and
                   10317:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10318:        modified using the <code class="literal">+=</code> operator in package
                   10319:        <code class="filename">Makefile</code>s (or other files included by
                   10320:        them), since there is no guarantee whether the variable is
                   10321:        already set or not, and what its value is. In the case of
                   10322:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10323:        the default value and just define it as in the following
                   10324:        example.</p>
                   10325: <pre class="programlisting">
1.100     rillig   10326: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10327: </pre>
                   10328: <p>Because of the selection of this default value, the same
                   10329:        value appears in many package Makefiles. Similarly for
                   10330:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10331:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10332:        doesn't stand out. Nevertheless it is mentioned in many
                   10333:        files.</p>
                   10334: </div>
                   10335: <div class="sect1" lang="en">
                   10336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10337: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.75      rillig   10338: <div class="sect2" lang="en">
                   10339: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10340: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   10341: <p>Variable evaluation takes place either at load time or at
                   10342:        runtime, depending on the context in which they occur. The
                   10343:        contexts where variables are evaluated at load time are:</p>
                   10344: <div class="itemizedlist"><ul type="disc">
                   10345: <li><p>The right hand side of the <code class="literal">:=</code>
                   10346:        and <code class="literal">!=</code> operators,</p></li>
                   10347: <li><p>Make directives like <code class="literal">.if</code> or
                   10348:        <code class="literal">.for</code>,</p></li>
                   10349: <li><p>Dependency lines.</p></li>
                   10350: </ul></div>
                   10351: <p>A special exception are references to the iteration
                   10352:        variables of <code class="literal">.for</code> loops, which are expanded
                   10353:        inline, no matter in which context they appear.</p>
                   10354: <p>As the values of variables may change during load time,
                   10355:        care must be taken not to evaluate them by accident. Typical
                   10356:        examples for variables that should not be evaluated at load time
                   10357:        are <code class="varname">DEPENDS</code> and
                   10358:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10359:        clear, here is an example:</p>
                   10360: <pre class="programlisting">
1.100     rillig   10361: CONFIGURE_ARGS=         # none
                   10362: CFLAGS=                 -O
                   10363: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10364: 
1.100     rillig   10365: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10366: 
1.100     rillig   10367: CFLAGS+=                -Wall
1.75      rillig   10368:        </pre>
                   10369: <p>This code shows how the use of the <code class="literal">:=</code>
                   10370:        operator can quickly lead to unexpected results. The first
                   10371:        paragraph is fairly common code. The second paragraph evaluates
                   10372:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10373:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10374:        <code class="literal">-Wall</code> is appended to the
                   10375:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10376:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10377:        paragraphs from above typically occur in completely unrelated
                   10378:        files.</p>
                   10379: </div>
                   10380: <div class="sect2" lang="en">
                   10381: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10382: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   10383: <p>After all the files have been loaded, the values of the
                   10384:        variables cannot be changed anymore. Variables that are used in
                   10385:        the shell commands are expanded at this point.</p>
                   10386: </div>
                   10387: </div>
                   10388: <div class="sect1" lang="en">
                   10389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10390: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10391: <p>There are many ways in which the definition and use of a
                   10392:        variable can be restricted in order to detect bugs and
                   10393:        violations of the (mostly unwritten) policies. See the
                   10394:        <code class="literal">pkglint</code> developer's documentation for further
                   10395:        details.</p>
                   10396: </div>
                   10397: <div class="sect1" lang="en">
                   10398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10399: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10400: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10401:        of the following classes. Cases where a file falls into more
                   10402:        than one class should be avoided as it often leads to subtle
                   10403:        bugs.</p>
                   10404: <div class="sect2" lang="en">
                   10405: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10406: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10407: <p>In a traditional imperative programming language some of
1.76      rillig   10408:        the <code class="filename">.mk</code> files could be described as
1.114     jmcneill 10409:        procedures. They take some input parameters and&mdash;after
                   10410:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10411:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10412:        care must be taken not to use parameter names that have already
                   10413:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10414:        bad choice for a parameter name.</p>
                   10415: <p>Procedures are completely evaluated at preprocessing time.
                   10416:        That is, when calling a procedure all input parameters must be
                   10417:        completely resolvable. For example,
                   10418:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10419:        parameter since it is very likely that further text will be
                   10420:        added after calling the procedure, which would effectively apply
                   10421:        the procedure to only a part of the variable. Also, references
                   10422:        to other variables wit will be modified after calling the
                   10423:        procedure.</p>
                   10424: <p>A procedure can declare its output parameters either as
                   10425:        suitable for use in preprocessing directives or as only
                   10426:        available at runtime. The latter alternative is for variables
                   10427:        that contain references to other runtime variables.</p>
                   10428: <p>Procedures shall be written such that it is possible to
                   10429:        call the procedure more than once. That is, the file must not
                   10430:        contain multiple-inclusion guards.</p>
                   10431: <p>Examples for procedures are
1.76      rillig   10432:        <code class="filename">mk/bsd.options.mk</code> and
                   10433:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10434:        that the parameters are evaluated at load time, they should be
                   10435:        assigned using the <code class="literal">:=</code> operator, which should
                   10436:        be used only for this purpose.</p>
                   10437: </div>
                   10438: <div class="sect2" lang="en">
                   10439: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10440: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10441: <p>Action files take some input parameters and may define
                   10442:        runtime variables. They shall not define loadtime variables.
                   10443:        There are action files that are included implicitly by the
                   10444:        pkgsrc infrastructure, while other must be included
                   10445:        explicitly.</p>
                   10446: <p>An example for action files is
1.76      rillig   10447:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10448: </div>
                   10449: </div>
1.81      rillig   10450: <div class="sect1" lang="en">
                   10451: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10452: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10453: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10454:        a set of variable definitions, and include the file
                   10455:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10456:        Before that, they may also include various other
                   10457:        <code class="filename">*.mk</code> files if they need to query the
                   10458:        availability of certain features like the type of compiler or
                   10459:        the X11 implementation. Due to the heavy use of preprocessor
                   10460:        directives like <code class="literal">.if</code> and
                   10461:        <code class="literal">.for</code>, the order in which the files are loaded
                   10462:        matters.</p>
                   10463: <p>This section describes at which point the various files
                   10464:        are loaded and gives reasons for that order.</p>
                   10465: <div class="sect2" lang="en">
                   10466: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10467: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10468: </h3></div></div></div>
                   10469: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10470:        is to define some essential variables like
                   10471:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10472:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10473: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10474:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104     rillig   10475:        After that, those variables
1.81      rillig   10476:        that have not been overridden by the user are loaded from
                   10477:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10478: <p>After the user settings, the system settings and platform
                   10479:        settings are loaded, which may override the user
                   10480:        settings.</p>
                   10481: <p>Then, the tool definitions are loaded. The tool wrappers
                   10482:        are not yet in effect. This only happens when building a
                   10483:        package, so the proper variables must be used instead of the
                   10484:        direct tool names.</p>
                   10485: <p>As the last steps, some essential variables from the
                   10486:        wrapper and the package system flavor are loaded, as well as the
                   10487:        variables that have been cached in earlier phases of a package
                   10488:        build.</p>
                   10489: </div>
                   10490: <div class="sect2" lang="en">
                   10491: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10492: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10493: </h3></div></div></div>
1.81      rillig   10494: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10495: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10496:        loaded, which fill default values for those variables that have
1.93      rillig   10497:        not been defined by the package. These variables may later
1.81      rillig   10498:        be used even in unrelated files.</p>
                   10499: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10500:        provides the target <code class="literal">error-check</code> that is added
                   10501:        as a special dependency to all other targets that use
                   10502:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10503:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10504: <p>Then, the package-specific hacks from
                   10505:        <code class="filename">hacks.mk</code> are included.</p>
                   10506: <p>Then, various other files follow. Most of them don't have
                   10507:        any dependencies on what they need to have included before or
                   10508:        after them, though some do.</p>
                   10509: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10510:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10511:        restricts the use of these variables to all the files that have
                   10512:        been included before. Appearances in later files will be
                   10513:        silently ignored.</p>
                   10514: <p>Then, the files for the main targets are included, in the
                   10515:        order of later execution, though the actual order should not
                   10516:        matter.</p>
                   10517: <p>At last, some more files are included that don't set any
                   10518:        interesting variables but rather just define make targets to be
                   10519:        executed.</p>
                   10520: </div>
                   10521: </div>
1.75      rillig   10522: </div>
                   10523: <div class="chapter" lang="en">
                   10524: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10525: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   10526: <div class="toc">
                   10527: <p><b>Table of Contents</b></p>
                   10528: <dl>
1.106     rillig   10529: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10530: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10531: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10532: <dd><dl>
1.106     rillig   10533: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10534: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10535: </dl></dd>
                   10536: </dl>
                   10537: </div>
                   10538: <p>The pkgsrc infrastructure consists of a large codebase,
                   10539:        and there are many corners where every little bit of a file is
                   10540:        well thought out, making pkgsrc likely to fail as soon as
                   10541:        anything is changed near those parts. To prevent most changes
                   10542:        from breaking anything, a suite of regression tests should go
                   10543:        along with every important part of the pkgsrc infrastructure.
                   10544:        This chapter describes how regression tests work in pkgsrc and
                   10545:        how you can add new tests.</p>
                   10546: <div class="sect1" lang="en">
                   10547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10548: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10549: <p></p>
                   10550: </div>
                   10551: <div class="sect1" lang="en">
                   10552: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10553: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10554: <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.110     hubertf  10555:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10556:        can simply run that command, which will run all tests in the
1.76      rillig   10557:        <code class="filename">regress</code> category.</p>
1.75      rillig   10558: </div>
                   10559: <div class="sect1" lang="en">
                   10560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10561: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10562: <p>Every directory in the <code class="filename">regress</code>
                   10563:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10564:        is considered a regression test. This file is a shell program
1.110     hubertf  10565:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10566:        The following functions can be overridden to suit your
                   10567:        needs.</p>
                   10568: <div class="sect2" lang="en">
                   10569: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10570: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10571: <p>These functions do not take any parameters. They are all
                   10572:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10573:        to check the exitcodes of any commands you run in the
                   10574:        test.</p>
                   10575: <div class="variablelist"><dl>
                   10576: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10577: <dd><p>This function prepares the environment for the
                   10578:        test. By default it does nothing.</p></dd>
                   10579: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10580: <dd><p>This function runs the actual test. By default,
                   10581:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10582:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10583:        error messages into the file
                   10584:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10585: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10586: <dd><p>This function is run after the test and is
                   10587:        typically used to compare the actual output from the one that is
                   10588:        expected. It can make use of the various helper functions from
                   10589:        the next section.</p></dd>
                   10590: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10591: <dd><p>This function cleans everything up after the
                   10592:        test has been run. By default it does nothing.</p></dd>
                   10593: </dl></div>
                   10594: </div>
                   10595: <div class="sect2" lang="en">
                   10596: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10597: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75      rillig   10598: <div class="variablelist"><dl>
                   10599: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10600: <dd><p>This function compares the exitcode of the
1.110     hubertf  10601:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75      rillig   10602:        If they differ, the test will fail.</p></dd>
                   10603: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10604: <dd><p>This function checks for each of its parameters
1.110     hubertf  10605:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75      rillig   10606:        extended regular expression. If it does not, the test will
                   10607:        fail.</p></dd>
                   10608: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10609: <dd><p>This function checks for each of its parameters
1.110     hubertf  10610:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10611:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10612:        If any of the regular expressions matches, the test will
                   10613:        fail.</p></dd>
                   10614: </dl></div>
                   10615: </div>
                   10616: </div>
                   10617: </div>
                   10618: <div class="chapter" lang="en">
                   10619: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10620: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10621: <div class="toc">
                   10622: <p><b>Table of Contents</b></p>
                   10623: <dl>
1.106     rillig   10624: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10625: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10626: </dl>
                   10627: </div>
                   10628: <p>The pkgsrc system has already been ported to many
                   10629:        operating systems, hardware architectures and compilers. This
                   10630:        chapter explains the necessary steps to make pkgsrc even more
                   10631:        portable.</p>
                   10632: <div class="sect1" lang="en">
                   10633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10634: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10635: <p>To port pkgsrc to a new operating system (called
                   10636:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10637:        following files:</p>
                   10638: <div class="variablelist"><dl>
1.93      rillig   10639: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75      rillig   10640: <dd><p>This file contains some basic definitions, for
                   10641:        example the name of the C
                   10642:        compiler.</p></dd>
1.76      rillig   10643: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10644: <dd><p>Insert code that defines the variables
                   10645:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10646:        <code class="varname">LOWER_OS_VERSION</code>,
                   10647:        <code class="varname">LOWER_VENDOR</code>,
                   10648:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10649:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10650:        appear in this file.</p></dd>
1.93      rillig   10651: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10652: <dd><p>This file contains the platform-specific
                   10653:        definitions that are used by pkgsrc. Start by copying one of the
                   10654:        other files and edit it to your
                   10655:        needs.</p></dd>
1.93      rillig   10656: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10657: <dd><p>This file contains a list of directories,
                   10658:        together with their permission bits and ownership. These
                   10659:        directories will be created automatically with every package
1.98      wiz      10660:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10661:        be removed.</p></dd>
1.93      rillig   10662: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10663: <dd><p>Just copy one of the pre-existing x11.dist files
                   10664:        to your
1.76      rillig   10665:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10666: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10667: <dd><p>On some operating systems, the tools that are
                   10668:        provided with the base system are not good enough for pkgsrc.
1.110     hubertf  10669:        For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
1.75      rillig   10670:        narrow limit on the line length they can process. Therefore
                   10671:        pkgsrc brings its own tools, which can be enabled
                   10672:        here.</p></dd>
1.93      rillig   10673: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10674: <dd><p>This file defines the paths to all the tools
                   10675:        that are needed by one or the other package in pkgsrc, as well
                   10676:        as by pkgsrc itself. Find out where these tools are on your
                   10677:        platform and add them.</p></dd>
                   10678: </dl></div>
                   10679: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10680:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10681: </div>
                   10682: <div class="sect1" lang="en">
                   10683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10684: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10685: <p>TODO</p>
                   10686: </div>
                   10687: </div>
                   10688: </div>
                   10689: <div class="appendix" lang="en">
                   10690: <div class="titlepage"><div><div><h2 class="title">
                   10691: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10692: <div class="toc">
                   10693: <p><b>Table of Contents</b></p>
                   10694: <dl>
                   10695: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10696: <dd><dl>
                   10697: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10698: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10699: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.116     rillig   10700: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   10701: </dl></dd>
                   10702: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10703: </dl>
                   10704: </div>
                   10705: <p>We checked to find a piece of software that wasn't in the packages
                   10706:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10707:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10708:     present in the tree is beyond us, but it's useful for the purposes of
                   10709:     this exercise.</p>
                   10710: <div class="sect1" lang="en">
                   10711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10712: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10713: <div class="sect2" lang="en">
                   10714: <div class="titlepage"><div><div><h3 class="title">
                   10715: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10716: <pre class="programlisting">
1.100     rillig   10717: # $NetBSD$
                   10718: #
1.1       grant    10719: 
1.100     rillig   10720: DISTNAME=       bison-1.25
                   10721: CATEGORIES=     devel
                   10722: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10723: 
1.100     rillig   10724: MAINTAINER=     thorpej@NetBSD.org
                   10725: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10726: COMMENT=        GNU yacc clone
1.1       grant    10727: 
1.100     rillig   10728: GNU_CONFIGURE=  yes
                   10729: INFO_FILES=     bison.info
1.1       grant    10730: 
1.100     rillig   10731: .include "../../mk/bsd.pkg.mk"
1.1       grant    10732: </pre>
1.75      rillig   10733: </div>
                   10734: <div class="sect2" lang="en">
                   10735: <div class="titlepage"><div><div><h3 class="title">
                   10736: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10737: <pre class="programlisting">
1.100     rillig   10738: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.110     hubertf  10739: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10740: of the NetBSD source tree is beyond me.
1.1       grant    10741: </pre>
1.75      rillig   10742: </div>
                   10743: <div class="sect2" lang="en">
                   10744: <div class="titlepage"><div><div><h3 class="title">
                   10745: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10746: <pre class="programlisting">
1.100     rillig   10747: @comment $NetBSD$
                   10748: bin/bison
                   10749: man/man1/bison.1.gz
                   10750: share/bison.simple
                   10751: share/bison.hairy
1.1       grant    10752: </pre>
1.75      rillig   10753: </div>
                   10754: <div class="sect2" lang="en">
                   10755: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  10756: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   10757: </h3></div></div></div>
1.75      rillig   10758: <p>The NetBSD package system comes with
1.91      rillig   10759:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10760:        which helps to check the contents of these
                   10761:        files. After installation it is quite easy to use, just change to the
                   10762:        directory of the package you wish to examine and execute
1.110     hubertf  10763:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10764: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10765: looks fine.</pre>
                   10766: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  10767:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   10768:        -Wall</strong></span> for a very thorough check.</p>
                   10769: </div>
                   10770: </div>
                   10771: <div class="sect1" lang="en">
                   10772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10773: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10774: <p>Create the directory where the package lives,
                   10775:       plus any auxiliary directories:</p>
                   10776: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10777: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10778: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10779: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10780: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  10781:       <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.75      rillig   10782:       then continue with fetching the distfile:</p>
                   10783: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10784: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10785: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10786: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10787: ftp: Error retrieving file: 500 Internal error
                   10788: 
                   10789: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10790: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10791: ftp: Error retrieving file: 500 Internal error
                   10792: 
                   10793: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10794: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10795: Successfully retrieved file.</pre>
                   10796: <p>Generate the checksum of the distfile into
1.76      rillig   10797:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10798: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10799: <p>Now compile:</p>
                   10800: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10801: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10802: ===&gt;  Extracting for bison-1.25
                   10803: ===&gt;  Patching for bison-1.25
                   10804: ===&gt;   Ignoring empty patch directory
                   10805: ===&gt;  Configuring for bison-1.25
                   10806: creating cache ./config.cache
                   10807: checking for gcc... cc
                   10808: checking whether we are using GNU C... yes
                   10809: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10810: checking how to run the C preprocessor... cc -E
                   10811: checking for minix/config.h... no
                   10812: checking for POSIXized ISC... no
                   10813: checking whether cross-compiling... no
                   10814: checking for ANSI C header files... yes
                   10815: checking for string.h... yes
                   10816: checking for stdlib.h... yes
                   10817: checking for memory.h... yes
                   10818: checking for working const... yes
                   10819: checking for working alloca.h... no
                   10820: checking for alloca... yes
                   10821: checking for strerror... yes
                   10822: updating cache ./config.cache
                   10823: creating ./config.status
                   10824: creating Makefile
                   10825: ===&gt;  Building for bison-1.25
                   10826: 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
                   10827: 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
                   10828: 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
                   10829: 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
                   10830: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10831: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\"  -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1  -g  ./files.c
1.1       grant    10832: 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
                   10833: 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
                   10834: 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
                   10835: 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
                   10836: 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
                   10837: 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
                   10838: 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
                   10839: 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
                   10840: 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
                   10841: 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
                   10842: 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
                   10843: 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
                   10844: 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
                   10845: 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
                   10846: 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
                   10847: 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
                   10848: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10849: rm -f bison.s1
1.75      rillig   10850: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10851: <p>Everything seems OK, so install the files:</p>
                   10852: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10853: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10854: ===&gt;  Installing for bison-1.25
                   10855: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10856: rm -f /usr/pkg/bin/bison
                   10857: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10858: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10859: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10860: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10861: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10862: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10863: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10864: ===&gt;  Registering installation for bison-1.25</pre>
                   10865: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10866:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10867:       binary package, do this now:</p>
                   10868: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10869: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10870: ===&gt;  Building package for bison-1.25
                   10871: Creating package bison-1.25.tgz
                   10872: Registering depends:.
1.75      rillig   10873: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10874: <p>Now that you don't need the source and object files
                   10875:       any more, clean up:</p>
                   10876: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10877: ===&gt;  Cleaning for bison-1.25</pre>
                   10878: </div>
                   10879: </div>
                   10880: <div class="appendix" lang="en">
                   10881: <div class="titlepage"><div><div><h2 class="title">
                   10882: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10883: <div class="toc">
                   10884: <p><b>Table of Contents</b></p>
                   10885: <dl>
                   10886: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10887: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10888: </dl>
                   10889: </div>
                   10890: <div class="sect1" lang="en">
                   10891: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10892: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10893: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10894: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10895: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10896: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10897: =&gt; [172219 bytes]
                   10898: Connected to ftp.plig.net.
                   10899: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10900: 331 Guest login ok, send your complete e-mail address as password.
                   10901: 230-You are user #5 of 500 simultaneous users allowed.
                   10902: 230-
1.68      rillig   10903: 230-  ___ _             _ _
                   10904: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10905: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10906: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10907: 230-         |_|   |_|     |___|         |___|
                   10908: 230-
                   10909: 230-** Welcome to ftp.plig.org **
                   10910: 230-
                   10911: 230-Please note that all transfers from this FTP site are logged. If you
                   10912: 230-do not like this, please disconnect now.
                   10913: 230-
                   10914: 230-This arhive is available via
                   10915: 230-
                   10916: 230-HTTP:  http://ftp.plig.org/
                   10917: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10918: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10919: 230-
                   10920: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10921: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10922: 230-
                   10923: 230-
                   10924: 230 Logged in anonymously.
                   10925: Remote system type is UNIX.
                   10926: Using binary mode to transfer files.
                   10927: 200 Type okay.
                   10928: 250 "/pub" is new cwd.
                   10929: 250-"/pub/figlet" is new cwd.
                   10930: 250-
                   10931: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10932: 250-
1.75      rillig   10933: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10934: 250-
                   10935: 250-The official FIGlet web page is:
1.75      rillig   10936: 250-   http://www.figlet.org/
1.1       grant    10937: 250-
                   10938: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10939: 250-contribute a font or something else, you can email us.
1.68      rillig   10940: 250
1.1       grant    10941: 250 "/pub/figlet/program" is new cwd.
                   10942: 250 "/pub/figlet/program/unix" is new cwd.
                   10943: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10944: 502 Unimplemented command.
                   10945: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10946: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10947: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10948: 226 Transfer completed.
                   10949: 172219 bytes received in 00:02 (75.99 KB/s)
                   10950: 221 Goodbye.
                   10951: =&gt; Checksum OK for figlet221.tar.gz.
                   10952: ===&gt; Extracting for figlet-2.2.1nb2
                   10953: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10954: ===&gt; Patching for figlet-2.2.1nb2
                   10955: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10956: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10957: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10958: ===&gt; Configuring for figlet-2.2.1nb2
                   10959: ===&gt; Building for figlet-2.2.1nb2
                   10960: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10961: chmod a+x figlet
                   10962: gcc -O2 -o chkfont chkfont.c
                   10963: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10964: <code class="prompt">#</code>
1.75      rillig   10965: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10966: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10967: ===&gt; Installing for figlet-2.2.1nb2
                   10968: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10969: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10970: mkdir -p /usr/pkg/share/figlet
                   10971: cp figlet /usr/pkg/bin
                   10972: cp chkfont /usr/pkg/bin
                   10973: chmod 555 figlist showfigfonts
                   10974: cp figlist /usr/pkg/bin
                   10975: cp showfigfonts /usr/pkg/bin
                   10976: cp fonts/*.flf /usr/pkg/share/figlet
                   10977: cp fonts/*.flc /usr/pkg/share/figlet
                   10978: cp figlet.6 /usr/pkg/man/man6
                   10979: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10980: <code class="prompt">#</code></pre>
                   10981: </div>
                   10982: <div class="sect1" lang="en">
                   10983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10984: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10985: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10986: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10987: ===&gt; Packaging figlet-2.2.1nb2
                   10988: ===&gt; Building binary package for figlet-2.2.1nb2
                   10989: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10990: Using SrcDir value of /usr/pkg
1.68      rillig   10991: Registering depends:.
1.75      rillig   10992: <code class="prompt">#</code></pre>
                   10993: </div>
                   10994: </div>
                   10995: <div class="appendix" lang="en">
                   10996: <div class="titlepage"><div><div><h2 class="title">
1.76      rillig   10997: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10998: <div class="toc">
                   10999: <p><b>Table of Contents</b></p>
                   11000: <dl>
1.116     rillig   11001: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
                   11002: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
                   11003: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
                   11004: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
                   11005: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
                   11006: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
                   11007: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
                   11008: pkgsrc-200xQy:
1.76      rillig   11009: source packages</a></span></dt>
                   11010: </dl>
                   11011: </div>
                   11012: <p>As in other big projects, the directory layout of pkgsrc
                   11013:        is quite complex for newbies. This chapter explains where you
                   11014:        find things on the FTP server. The base directory on
1.110     hubertf  11015:        <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.89      rillig   11016:        On other servers it may be different, but inside this directory,
                   11017:        everything should look the same, no matter on which server you
                   11018:        are. This directory contains some subdirectories, which are
                   11019:        explained below.</p>
1.76      rillig   11020: <div class="sect1" lang="en">
                   11021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11022: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.109     rillig   11023: <p>This directory used to contain binary packages of the
                   11024:        package management tools for various platforms. For those
                   11025:        package collections that need them, they are now stored near the
1.110     hubertf  11026:        binary packages, so you should look <a class="link" href="#ftp-packages" title="C.5. packages: Binary packages">in the <code class="filename">packages</code>
1.109     rillig   11027:        directory</a>.</p>
1.76      rillig   11028: </div>
                   11029: <div class="sect1" lang="en">
                   11030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11031: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   11032: <p>The directory <code class="filename">distfiles</code> contains lots
                   11033:        of archive files from all pkgsrc packages, which are mirrored
                   11034:        here. The subdirectories are called after their package names
                   11035:        and are used when the distributed files have names that don't
                   11036:        explicitly contain a version number or are otherwise too generic
                   11037:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11038: </div>
                   11039: <div class="sect1" lang="en">
                   11040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11041: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   11042: <p>This directory is currently not in use.</p>
                   11043: </div>
                   11044: <div class="sect1" lang="en">
                   11045: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11046: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   11047: <p>This directory contains things that individual pkgsrc
                   11048:        developers find worth publishing.</p>
                   11049: </div>
                   11050: <div class="sect1" lang="en">
                   11051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102     rillig   11052: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   11053: <p>This directory contains binary packages for the various
                   11054:        platforms that are supported by pkgsrc.
                   11055:        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>
                   11056: <div class="itemizedlist"><ul type="disc">
1.108     rillig   11057: <li><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   11058:        operating system for which the packages have been built. The
1.110     hubertf  11059:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   11060:        command, so it may differ from the one you are used to
                   11061:        hear.</p></li>
1.108     rillig   11062: <li><p><code class="varname">ARCH</code> is the hardware
                   11063:        architecture of the platform for which the packages have been
1.110     hubertf  11064:        built. It also includes the <code class="varname">ABI</code> (Application
                   11065:        Binary Interface) for platforms that have several of
                   11066:        them.</p></li>
1.108     rillig   11067: <li><p><code class="varname">OSVERSION</code> is the version of
                   11068:        the operating system. For version numbers that change often (for
                   11069:        example NetBSD-current), the often-changing part should be
                   11070:        replaced with an <code class="literal">x</code>, for example
                   11071:        <code class="literal">4.99.x</code>.</p></li>
                   11072: <li><p><code class="varname">TAG</code> is either
                   11073:        <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11074:        for a stable branch, or <code class="literal">head</code> for packages
                   11075:        built from the HEAD branch. The latter should only be used when
                   11076:        the packages are updated on a regular basis. Otherwise the date
                   11077:        from checking out pkgsrc should be appended, for example
                   11078:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   11079: </ul></div>
                   11080: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11081:        can quickly click through the directories on the
                   11082:        server and find the best binary packages for their machines. Since they
                   11083:        usually know the operating system and the hardware architecture, OPSYS
                   11084:        and ARCH are placed first. After these choices, they can select the
                   11085:        best combination of OSVERSION and TAG together, since it is usually the
                   11086:        case that packages stay compatible between different version of the
                   11087:        operating system.</p>
                   11088: <p>In each of these directories, there is a
                   11089:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   11090:        <code class="filename">All</code> which contains all binary packages.
                   11091:        Besides that, there are various category directories that
                   11092:        contain symbolic links to the real binary packages.</p>
                   11093: </div>
                   11094: <div class="sect1" lang="en">
                   11095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   11096: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
                   11097: <p>Here are the reports from bulk builds, for those who want
                   11098:        to fix packages that didn't build on some of the platforms. The
1.116     rillig   11099:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.5. packages: Binary packages">Section C.5, &#8220;packages: Binary packages&#8221;</a>.</p>
1.108     rillig   11100: </div>
                   11101: <div class="sect1" lang="en">
                   11102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11103: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.93      rillig   11104: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11105: source packages</h2></div></div></div>
                   11106: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   11107:        that is the files that define how to create binary packages from
                   11108:        source archives.</p>
                   11109: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11110:        snapshot of the CVS repository, which is updated regularly. The
                   11111:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11112:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   11113: <p>In the directories for the quarterly branches, there is an
                   11114:        additional file called
                   11115:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   11116:        which contains the state of pkgsrc when it was branched.</p>
                   11117: </div>
1.75      rillig   11118: </div>
                   11119: <div class="appendix" lang="en">
                   11120: <div class="titlepage"><div><div><h2 class="title">
                   11121: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   11122: <div class="toc">
                   11123: <p><b>Table of Contents</b></p>
                   11124: <dl>
1.79      rillig   11125: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   11126: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11127: </dl>
                   11128: </div>
1.79      rillig   11129: <p>This section contains information on editing the pkgsrc
                   11130:        guide itself.</p>
1.75      rillig   11131: <div class="sect1" lang="en">
                   11132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   11133: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11134: <p>The pkgsrc guide's source code is stored in
                   11135:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11136:        are created from it:</p>
                   11137: <div class="itemizedlist"><ul type="disc">
                   11138: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11139: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.110     hubertf  11140: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   11141: <li><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.79      rillig   11142:        The PDF version of the pkgsrc guide.</p></li>
1.110     hubertf  11143: <li><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.79      rillig   11144:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   11145: </ul></div>
                   11146: </div>
                   11147: <div class="sect1" lang="en">
                   11148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11149: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   11150: <p>The procedure to edit the pkgsrc guide is:</p>
                   11151: <div class="procedure"><ol type="1">
                   11152: <li><p>Make sure you have the packages needed to
1.83      wiz      11153:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.91      rillig   11154:        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
                   11155:        ASCII and HTML versions, and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/netbsd-doc-print/README.html" target="_top"><code class="filename">meta-pkgs/netbsd-doc-print</code></a> for the
1.79      rillig   11156:        PostScript and PDF versions. You will need both packages
                   11157:        installed, to make sure documentation is consistent across all
                   11158:        formats.</p></li>
1.110     hubertf  11159: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   11160:        right directory. All further steps will take place
                   11161:        here.</p></li>
                   11162: <li><p>Edit the XML file(s) in
                   11163:        <code class="filename">files/</code>.</p></li>
1.110     hubertf  11164: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   11165:        guide for valid XML and to build the final output files. If you
                   11166:        get any errors at this stage, you can just edit the files, as
                   11167:        there are only symbolic links in the working directory, pointing
                   11168:        to the files in <code class="filename">files/</code>.</p></li>
1.110     hubertf  11169: <li><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   11170:        commit)</strong></span></p></li>
1.110     hubertf  11171: <li><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   11172:        regenerate the output files with the proper RCS
                   11173:        Ids.</p></li>
1.91      rillig   11174: <li>
1.110     hubertf  11175: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   11176:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11177:        <code class="filename">htdocs</code>.</p>
                   11178: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11179: <h3 class="title">Note</h3>
                   11180: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  11181:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11182:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   11183:        directory.</p>
                   11184: </div>
                   11185: </li>
1.79      rillig   11186: </ol></div>
1.75      rillig   11187: </div>
                   11188: </div>
                   11189: </div></body>
1.1       grant    11190: </html>

CVSweb <webmaster@jp.NetBSD.org>