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

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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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.123     snj       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>
1.122     reed      392: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                    393: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig    394: </dl></dd>
                    395: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    396: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    397: <dd><dl>
                    398: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    399: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    400: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    401: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv      402: </dl></dd>
1.75      rillig    403: </dl></dd>
                    404: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    405: <dd><dl>
1.106     rillig    406: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    407: <dd><dl>
1.106     rillig    408: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    409: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    410: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig    411: <dd><dl>
1.106     rillig    412: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    413: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig    414: </dl></dd>
1.106     rillig    415: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    416: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    417: <dd><dl>
1.106     rillig    418: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    419: <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    420: </dl></dd>
1.106     rillig    421: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig    422: <dd><dl>
1.123     snj       423: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
                    424: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75      rillig    425: </dl></dd>
                    426: </dl></dd>
1.106     rillig    427: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig    428: <dd><dl>
1.106     rillig    429: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    430: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    431: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig    432: <dd><dl>
1.106     rillig    433: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    434: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig    435: </dl></dd>
                    436: </dl></dd>
1.106     rillig    437: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig    438: <dd><dl>
1.106     rillig    439: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    440: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig    441: </dl></dd>
                    442: </dl></dd>
                    443: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    444: <dd><dl>
                    445: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    446: <dd><dl>
                    447: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    448: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    449: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.123     snj       450: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    451: </dl></dd>
                    452: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    453: </dl></dd>
                    454: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    455: <dd><dl>
                    456: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    457: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    458: </dl></dd>
1.76      rillig    459: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    460: <dd><dl>
1.123     snj       461: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
                    462: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
                    463: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
                    464: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
                    465: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
                    466: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
                    467: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
                    468: pkgsrc-200xQy:
1.76      rillig    469: source packages</a></span></dt>
                    470: </dl></dd>
1.75      rillig    471: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    472: <dd><dl>
1.79      rillig    473: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    474: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    475: </dl></dd>
                    476: </dl>
                    477: </div>
1.82      rillig    478: <div class="list-of-tables">
                    479: <p><b>List of Tables</b></p>
                    480: <dl>
                    481: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    482: </dt>
1.106     rillig    483: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      484: </dt>
1.106     rillig    485: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      486: </dt>
1.82      rillig    487: </dl>
                    488: </div>
1.75      rillig    489: <div class="chapter" lang="en">
                    490: <div class="titlepage"><div><div><h2 class="title">
                    491: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    492: <div class="toc">
                    493: <p><b>Table of Contents</b></p>
                    494: <dl>
                    495: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    496: <dd><dl>
                    497: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    498: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    499: </dl></dd>
1.75      rillig    500: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    501: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       502: <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    503: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    504: </dl>
                    505: </div>
                    506: <div class="sect1" lang="en">
                    507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    508: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    509: <p>There is a lot of software freely available for Unix-based
                    510: systems, which is usually available in form of the source code. Before
                    511: such software can be used, it needs to be configured to the local
                    512: system, compiled and installed, and this is exactly what The NetBSD
                    513: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    514: to handle binary packages, so that not every user has to build the
                    515: packages for himself, which is a time-costly task.</p>
1.75      rillig    516: <p>pkgsrc currently contains several thousand packages,
                    517:       including:</p>
                    518: <div class="itemizedlist"><ul type="disc">
1.91      rillig    519: <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    520:          web server</p></li>
1.91      rillig    521: <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    522:          web browser</p></li>
1.91      rillig    523: <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    524:          Desktop Environment</p></li>
1.91      rillig    525: <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    526:          Desktop Environment</p></li>
                    527: </ul></div>
                    528: <p>...just to name a few.</p>
                    529: <p>pkgsrc has built-in support for handling varying dependencies,
                    530:       such as pthreads and X11, and extended features such as IPv6 support on
                    531:       a range of platforms.</p>
1.82      rillig    532: <div class="sect2" lang="en">
                    533: <div class="titlepage"><div><div><h3 class="title">
                    534: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    535: <p>
                    536: pkgsrc provides the following key features:
                    537: </p>
                    538: <div class="itemizedlist"><ul type="disc">
                    539: <li><p>Easy building of software from source as well as the creation
                    540:   and installation of binary packages. The source and latest
                    541:   patches are retrieved from a master or mirror download site, checksum
                    542:   verified, then built on your system. Support for binary-only
                    543:   distributions is available for both native platforms and NetBSD
                    544:   emulated platforms.</p></li>
                    545: <li><p>All packages are installed in a consistent directory tree,
                    546:   including binaries, libraries, man pages and other
                    547:   documentation.</p></li>
                    548: <li><p>Package dependencies, including when performing package updates,
                    549:   are handled automatically. The configuration files of various
                    550:   packages are handled automatically during updates, so local changes
                    551:   are preserved.</p></li>
                    552: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    553:   consists of highly portable code. This allows the greatest speed of
                    554:   development when porting to new a platform. This portability also
                    555:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    556:   platforms</em></span>.</p></li>
                    557: <li><p>The installation prefix, acceptable software licenses,
                    558:   international encryption requirements and build-time options for a
                    559:   large number of packages are all set in a simple, central
                    560:   configuration file.</p></li>
                    561: <li><p>The entire source (not including the distribution files) is
                    562:   freely available under a BSD license, so you may extend and adapt
                    563:   pkgsrc to your needs. Support for local packages and patches is
                    564:   available right out of the box, so you can configure it specifically
                    565:   for your environment.</p></li>
                    566: </ul></div>
1.91      rillig    567: <p>The following principles are basic to pkgsrc:</p>
                    568: <div class="itemizedlist"><ul type="disc">
                    569: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
1.125   ! wiz       570: &#8212; That means, if a package contains bugs, it's better to find
1.91      rillig    571: them and to complain about them rather than to just install the package
                    572: and hope that it works. There are numerous checks in pkgsrc that try to
                    573: 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
                    574: of shell scripts), and post-installation checks (installed files,
                    575: references to shared libraries, script interpreters).</p></li>
                    576: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
1.125   ! wiz       577: &#8212; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    578: pkgsrc has been ported to many operating systems. Care is taken that
                    579: packages behave the same on all platforms.</p></li>
                    580: </ul></div>
1.82      rillig    581: </div>
                    582: <div class="sect2" lang="en">
                    583: <div class="titlepage"><div><div><h3 class="title">
                    584: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    585: <p>pkgsrc consists of both a source distribution and a binary
                    586: distribution for these operating systems. After retrieving the required
                    587: source or binaries, you can be up and running with pkgsrc in just
                    588: minutes!</p>
1.75      rillig    589: <p>pkgsrc was derived from FreeBSD's ports system, and
                    590:       initially developed for NetBSD only. Since then, pkgsrc has
                    591:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    592: <div class="table">
                    593: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.91      rillig    594: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    595: <colgroup>
                    596: <col>
                    597: <col>
                    598: </colgroup>
                    599: <thead><tr>
                    600: <th>Platform</th>
                    601: <th>Date Support Added</th>
                    602: </tr></thead>
                    603: <tbody>
                    604: <tr>
1.110     hubertf   605: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    606: <td align="center">Aug 1997</td>
                    607: </tr>
                    608: <tr>
1.110     hubertf   609: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    610: <td align="center">Mar 1999</td>
                    611: </tr>
                    612: <tr>
1.110     hubertf   613: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    614: <td align="center">Jun 1999</td>
                    615: </tr>
                    616: <tr>
                    617: <td>
1.110     hubertf   618:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    619:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82      rillig    620:         </td>
                    621: <td align="center">Oct 2001</td>
                    622: </tr>
                    623: <tr>
1.110     hubertf   624: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    625: <td align="center">Nov 2002</td>
                    626: </tr>
                    627: <tr>
1.110     hubertf   628: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    629: <td align="center">Nov 2002</td>
                    630: </tr>
                    631: <tr>
1.110     hubertf   632: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    633: <td align="center">Dec 2002</td>
                    634: </tr>
                    635: <tr>
                    636: <td>BSD/OS</td>
                    637: <td align="center">Dec 2003</td>
                    638: </tr>
                    639: <tr>
1.110     hubertf   640: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    641: <td align="center">Dec 2003</td>
                    642: </tr>
                    643: <tr>
                    644: <td>
1.110     hubertf   645:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    646:           (Microsoft Windows Services for Unix)
                    647:         </td>
                    648: <td align="center">Mar 2004</td>
                    649: </tr>
                    650: <tr>
1.110     hubertf   651: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    652: <td align="center">Oct 2004</td>
                    653: </tr>
                    654: <tr>
1.110     hubertf   655: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    656: <td align="center">Nov 2004</td>
                    657: </tr>
1.98      wiz       658: <tr>
1.110     hubertf   659: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       660: <td align="center">Apr 2007</td>
                    661: </tr>
1.82      rillig    662: </tbody>
1.91      rillig    663: </table></div>
1.82      rillig    664: </div>
1.91      rillig    665: <br class="table-break">
1.82      rillig    666: </div>
1.75      rillig    667: </div>
                    668: <div class="sect1" lang="en">
                    669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    670: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    671: <p>This document is divided into three parts. The first,
1.110     hubertf   672:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    673:        describes how one can use one of the packages in the Package
                    674:        Collection, either by installing a precompiled binary package,
1.93      rillig    675:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   676:        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    677:        package so it can be easily built by other NetBSD users without
                    678:        knowing about the package's building details. The third part,
1.110     hubertf   679:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    680:        is intended for those who want to understand how pkgsrc is
                    681:        implemented.</p>
                    682: <p>This document is available in various formats:
1.110     hubertf   683:        <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    684: </div>
                    685: <div class="sect1" lang="en">
                    686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    687: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    688: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    689:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    690:       terminology used within this document.</p>
                    691: <div class="variablelist"><dl>
                    692: <dt><span class="term">Package</span></dt>
                    693: <dd><p>A set of files and building instructions
                    694:            that describe what's necessary
                    695:            to build a certain piece of software using
                    696:             pkgsrc. Packages are traditionally stored under
1.76      rillig    697:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    698: <dt><span class="term">The NetBSD package system</span></dt>
1.87      wiz       699: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    700:          is part of the NetBSD operating system and can be bootstrapped
                    701:          to run on non-NetBSD operating systems as well.  It handles
                    702:          building (compiling), installing, and removing of
                    703:          packages.</p></dd>
1.75      rillig    704: <dt><span class="term">Distfile</span></dt>
                    705: <dd><p>This term describes the file or files that are
                    706:            provided by the author of the piece of software to
                    707:            distribute his work. All the changes necessary to build on
                    708:            NetBSD are reflected in the corresponding package. Usually
                    709:            the distfile is in the form of a compressed tar-archive,
                    710:            but other types are possible, too. Distfiles are usually
                    711:            stored below
1.76      rillig    712:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    713: <dt><span class="term">Port</span></dt>
                    714: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    715:            for what we call a package.
                    716:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    717:            architecture.</p></dd>
                    718: <dt><span class="term">Precompiled/binary package</span></dt>
                    719: <dd>
                    720: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    721:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    722:            file so it can be installed on machines of the same
                    723:            machine architecture without the need to
                    724:            recompile. Packages are usually generated in
1.76      rillig    725:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.110     hubertf   726:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.75      rillig    727: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    728:            especially in the context of precompiled packages.</p>
                    729: </dd>
                    730: <dt><span class="term">Program</span></dt>
1.88      wiz       731: <dd><p>The piece of software to be installed which will be
                    732:          constructed from all the files in the distfile by the
                    733:          actions defined in the corresponding package.</p></dd>
1.75      rillig    734: </dl></div>
                    735: <div class="sect2" lang="en">
                    736: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       737: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.75      rillig    738: <div class="variablelist"><dl>
                    739: <dt><span class="term">pkgsrc users</span></dt>
                    740: <dd>
                    741: <p>The
                    742:        pkgsrc users are people who use the packages provided by pkgsrc.
                    743:        Typically they are system administrators. The people using the
                    744:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    745:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    746: <p>There are two kinds of pkgsrc users: Some only want to
                    747:        install pre-built binary packages. Others build the pkgsrc
                    748:        packages from source, either for installing them directly or for
1.110     hubertf   749:        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    750:        documentation.</p>
                    751: </dd>
                    752: <dt><span class="term">package maintainers</span></dt>
                    753: <dd><p>A
1.110     hubertf   754:        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    755: <dt><span class="term">infrastructure developers</span></dt>
                    756: <dd><p>These people are involved in all those files
1.76      rillig    757:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   758:        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    759:        too.</p></dd>
                    760: </dl></div>
                    761: </div>
                    762: </div>
                    763: <div class="sect1" lang="en">
                    764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    765: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    766: <p>When giving examples for commands, shell prompts are used to
                    767:       show if the command should/can be issued as root, or if
                    768:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    769:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    770:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    771: </div>
                    772: </div>
                    773: <div class="part" lang="en">
                    774: <div class="titlepage"><div><div><h1 class="title">
                    775: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    776: <div class="toc">
                    777: <p><b>Table of Contents</b></p>
                    778: <dl>
                    779: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    780: <dd><dl>
                    781: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    782: <dd><dl>
                    783: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    784: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    785: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    786: </dl></dd>
                    787: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    788: <dd><dl>
                    789: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    790: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    791: </dl></dd>
                    792: </dl></dd>
                    793: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    794: <dd><dl>
1.82      rillig    795: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    796: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    797: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    798: <dd><dl>
                    799: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    800: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    801: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    802: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    803: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    804: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    805: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig    806: </dl></dd>
                    807: </dl></dd>
                    808: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    809: <dd><dl>
                    810: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    811: <dd><dl>
                    812: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    813: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    814: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    815: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    816: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    817: <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>
                    818: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    819: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig    820: </dl></dd>
                    821: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    822: <dd><dl>
                    823: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    824: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    825: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    826: </dl></dd>
                    827: </dl></dd>
                    828: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    829: <dd><dl>
                    830: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    831: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    832: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       833: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       834: <dd><dl>
1.103     wiz       835: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.123     snj       836: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
                    837: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88      wiz       838: </dl></dd>
1.103     wiz       839: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    840: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    841: </dl></dd>
                    842: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    843: <dd><dl>
                    844: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    845: <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    846: </dl></dd>
                    847: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    848: builds)</a></span></dt>
1.75      rillig    849: <dd><dl>
1.106     rillig    850: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    851: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    852: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    853: <dd><dl>
                    854: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    855: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    856: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    857: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    858: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    859: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    860: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    861: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    862: </dl></dd>
                    863: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig    864: <dd><dl>
                    865: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    866: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    867: </dl></dd>
1.106     rillig    868: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    869: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    870: </dl></dd>
                    871: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    872: <dd><dl>
1.123     snj       873: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
                    874: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.106     rillig    875: </dl></dd>
                    876: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    877: <dd><dl>
                    878: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    879: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    880: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    881: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    882: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    883: <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>
                    884: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.123     snj       885: <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    886: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.123     snj       887: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
                    888: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
                    889: <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    890: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    891: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    892: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.123     snj       893: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106     rillig    894: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.123     snj       895: <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    896: </dl></dd>
                    897: </dl>
                    898: </div>
                    899: <div class="chapter" lang="en">
                    900: <div class="titlepage"><div><div><h2 class="title">
                    901: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    902: <div class="toc">
                    903: <p><b>Table of Contents</b></p>
                    904: <dl>
                    905: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    906: <dd><dl>
                    907: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    908: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
1.97      rillig    909: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
1.75      rillig    910: </dl></dd>
                    911: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    912: <dd><dl>
                    913: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    914: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    915: </dl></dd>
                    916: </dl>
                    917: </div>
1.91      rillig    918: <p>Before you download and extract the files, you need to decide
                    919: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    920: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    921: free to install the sources and binary packages wherever you want in
                    922: your filesystem, provided that the pathname does not contain white-space
                    923: or other characters that are interpreted specially by the shell and some
                    924: other programs. A safe bet is to use only letters, digits, underscores
                    925: and dashes.</p>
1.75      rillig    926: <div class="sect1" lang="en">
                    927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    928: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    929: <p>Before you download any pkgsrc files, you should decide
                    930:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    931:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    932:        quarterly basis from the current branch and only gets modified
                    933:        for security updates. The names of the stable branches are built
                    934:        from the year and the quarter, for example
1.124     snj       935:        <code class="literal">2009Q1</code>.</p>
1.75      rillig    936: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    937:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    938:        or via CVS. All three ways are described here.</p>
                    939: <div class="sect2" lang="en">
                    940: <div class="titlepage"><div><div><h3 class="title">
                    941: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    942: <p>The primary download location for all pkgsrc files is
1.110     hubertf   943:        <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    944:        number of subdirectories for different purposes, which are
1.110     hubertf   945:        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    946: <p>The tar file for the current branch is in the directory
1.110     hubertf   947:        <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    948:        It is autogenerated daily.</p>
1.124     snj       949: <p>The tar file for the stable branch 2009Q1 is in the
                    950:        directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
1.112     weinem    951: <p>To download a pkgsrc stable tarball, run:</p>
                    952: <pre class="screen">
                    953: <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>
                    954: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the
                    955:        stable branch to be downloaded, for example, 
1.124     snj       956:        &#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;.</p>
1.112     weinem    957: <p>Then, extract it with:</p>
                    958: <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>
                    959: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    960:        in <code class="filename">/usr/</code> and all the package source will be 
                    961:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    962: <p>To download pkgsrc-current, run:</p>
                    963: <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    964: </div>
                    965: <div class="sect2" lang="en">
                    966: <div class="titlepage"><div><div><h3 class="title">
                    967: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    968: <p>As an alternative to the tar file, you can get pkgsrc via
                    969:        the Software Update Protocol, SUP. To do so, make sure your
                    970:        supfile has a line
1.1       grant     971: 
1.75      rillig    972: </p>
                    973: <pre class="programlisting">
1.100     rillig    974: release=pkgsrc
1.1       grant     975: </pre>
1.75      rillig    976: <p>
1.1       grant     977: 
1.75      rillig    978:        in it, see the examples in
1.76      rillig    979:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    980:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.113     weinem    981:        run:</p>
                    982: <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    983: </div>
                    984: <div class="sect2" lang="en">
                    985: <div class="titlepage"><div><div><h3 class="title">
1.97      rillig    986: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.112     weinem    987: <p>To do an initial (full) checkout of pkgsrc, you first
1.75      rillig    988:        have to set some environment variables. For the C-Shell,
                    989:        type:</p>
1.113     weinem    990: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    991: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
1.75      rillig    992: </pre>
                    993: <p>Or, the same for the bourne shell:</p>
1.113     weinem    994: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    995: <code class="prompt">$</code> <strong class="userinput"><code>export CVS_RSH="ssh"</code></strong>
1.75      rillig    996: </pre>
1.113     weinem    997: <p>By default, CVS doesn't do things like most people would
1.112     weinem    998:        expect it to do. But there is a
1.113     weinem    999:        way to convince CVS, by creating a file called
1.101     rillig   1000:        <code class="filename">.cvsrc</code> in your home directory and saving
                   1001:        the following lines to it. This file will save you lots of
                   1002:        headache and some bug reports, so we strongly recommend it. You
                   1003:        can find an explanation of this file in the CVS
                   1004:        documentation.</p>
                   1005: <pre class="programlisting">
                   1006: # recommended CVS configuration file from the pkgsrc guide
                   1007: checkout -P
1.103     wiz      1008: update -dP
1.101     rillig   1009: release -d
1.103     wiz      1010: diff -upN
1.101     rillig   1011: cvs -q -z3
                   1012: rdiff -u
                   1013: </pre>
1.112     weinem   1014: <p>To fetch a specific pkgsrc stable branch from scratch, run:</p>
                   1015: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113     weinem   1016: <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   1017: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the stable 
1.124     snj      1018:        branch to be checked out, for example, &#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</p>
1.112     weinem   1019: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1020:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1021:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1022: <p>To fetch the pkgsrc current branch, run:</p>
                   1023: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.113     weinem   1024: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -P pkgsrc</code></strong></pre>
1.75      rillig   1025: </div>
                   1026: </div>
                   1027: <div class="sect1" lang="en">
                   1028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1029: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1030: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1031:        (which also works if you have first installed it via a tar
                   1032:        file). It saves bandwidth and hard disk activity, compared to
                   1033:        downloading the tar file again.</p>
                   1034: <div class="sect2" lang="en">
                   1035: <div class="titlepage"><div><div><h3 class="title">
                   1036: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                   1037: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1038: <h3 class="title">Warning</h3>
1.77      rillig   1039: <p>When updating from a tar file, you first need to
                   1040:        completely remove the old pkgsrc directory. Otherwise those
                   1041:        files that have been removed from pkgsrc in the mean time will
                   1042:        not be removed on your local disk, resulting in inconsistencies.
                   1043:        When removing the old files, any changes that you have done to
                   1044:        the pkgsrc files will be lost after updating. Therefore updating
                   1045:        via CVS is strongly recommended.</p>
1.75      rillig   1046: </div>
1.82      rillig   1047: <p>Note that by default the distfiles and the binary packages
                   1048:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1049:        before updating. You can also configure pkgsrc to use other than
                   1050:        the default directories by setting the
                   1051:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1052:        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   1053: <p>To update pkgsrc from a tar file, download the tar file as
                   1054:        explained above. Then, make sure that you have not made any
                   1055:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1056:        directory and extract the new tar file. Done.</p>
                   1057: </div>
                   1058: <div class="sect2" lang="en">
                   1059: <div class="titlepage"><div><div><h3 class="title">
                   1060: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1061: <p>To update pkgsrc via CVS, make sure the environment
                   1062:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.113     weinem   1063:        change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1064: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   1065: <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.75      rillig   1066: <div class="sect3" lang="en">
                   1067: <div class="titlepage"><div><div><h4 class="title">
                   1068: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1069: <p>When updating pkgsrc, the CVS program keeps track of the
                   1070:        branch you selected. But if you, for whatever reason, want to
                   1071:        switch from the stable branch to the current one, you can do it
                   1072:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1073:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1074:        back to the stable branch, add the
1.124     snj      1075:        &#8220;<span class="quote">-rpkgsrc-2009Q1</span>&#8221; option.</p>
1.75      rillig   1076: </div>
                   1077: <div class="sect3" lang="en">
                   1078: <div class="titlepage"><div><div><h4 class="title">
                   1079: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1080: <p>When you update pkgsrc, the CVS program will only touch
                   1081:        those files that are registered in the CVS repository. That
                   1082:        means that any packages that you created on your own will stay
                   1083:        unmodified. If you change files that are managed by CVS, later
                   1084:        updates will try to merge your changes with those that have been
                   1085:        done by others. See the CVS manual, chapter
                   1086:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1087: </div>
                   1088: </div>
                   1089: </div>
                   1090: </div>
                   1091: <div class="chapter" lang="en">
                   1092: <div class="titlepage"><div><div><h2 class="title">
                   1093: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1094: <div class="toc">
                   1095: <p><b>Table of Contents</b></p>
                   1096: <dl>
1.82      rillig   1097: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1098: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1099: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1100: <dd><dl>
                   1101: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1102: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1103: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1104: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1105: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1106: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1107: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1.75      rillig   1108: </dl></dd>
                   1109: </dl>
                   1110: </div>
                   1111: <div class="sect1" lang="en">
                   1112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1113: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1114: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.82      rillig   1115: </div>
                   1116: <div class="sect1" lang="en">
                   1117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1118: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1119: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1120: <pre class="screen">
                   1121: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1122: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1123: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1124:     </pre>
1.110     hubertf  1125: <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      1126:     pkgsrc before bootstrapping. The given
1.110     hubertf  1127:     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.87      wiz      1128:     <code class="filename">/usr/pkg</code> for the
                   1129:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1130:     and <code class="filename">/var/db/pkg</code> for the package database
                   1131:     directory where pkgsrc will do its internal bookkeeping.
                   1132:     However, these can also be set using command-line
                   1133:     arguments.</p>
1.75      rillig   1134: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1135: <h3 class="title">Note</h3>
1.110     hubertf  1136: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1137:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1138:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.87      wiz      1139:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
1.75      rillig   1140: </div>
                   1141: </div>
                   1142: <div class="sect1" lang="en">
                   1143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1144: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.75      rillig   1145: <p>Here are some platform-specific notes you should be aware of.</p>
                   1146: <div class="sect2" lang="en">
                   1147: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1148: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1.85      jmmv     1149: <p>Darwin 5.x and up are supported. There are two methods of using
1.110     hubertf  1150:        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
                   1151:          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   1152:          partition</a>.</p>
                   1153: <p>Before you start, you will need to download and install the Mac OS X Developer
1.110     hubertf  1154:       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      1155:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
1.110     hubertf  1156:       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      1157:       if you intend to build packages that use the X11 Window System.</p>
1.89      rillig   1158: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1159:       that you can format as UFS or HFSX, it is recommended to use that instead of
1.87      wiz      1160:       the disk image. It'll be somewhat faster and will mount automatically
                   1161:       at boot time, where you must manually mount a disk image.</p>
1.75      rillig   1162: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1163: <h3 class="title">Note</h3>
1.85      jmmv     1164: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
1.89      rillig   1165:          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   1166: </div>
                   1167: <div class="sect3" lang="en">
                   1168: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1169: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
1.75      rillig   1170: <p>Create the disk image:</p>
                   1171: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.95      tron     1172: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
1.85      jmmv     1173: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
1.75      rillig   1174: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
1.85      jmmv     1175: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1176: <h3 class="title">Note</h3>
1.109     rillig   1177: <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     1178: </div>
1.89      rillig   1179: <p>Allow suid:</p>
                   1180: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.105     weinem   1181: <p>Changing the build directory:</p>
                   1182: <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>
                   1183: <pre class="programlisting">
                   1184:          WRKOBJDIR?=           /tmp/pkgsrc         # build here instead of in pkgsrc
                   1185:        </pre>
1.75      rillig   1186: </div>
                   1187: <div class="sect3" lang="en">
                   1188: <div class="titlepage"><div><div><h4 class="title">
1.89      rillig   1189: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
1.76      rillig   1190: <p>By default, <code class="filename">/usr</code> will be on your root file
1.87      wiz      1191:        system, normally HFS+. It is possible to use the default
                   1192:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1193:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
1.89      rillig   1194:        or HFSX file system. Obviously, another symlink is required if you want to
1.87      wiz      1195:        place the package database directory outside the
                   1196:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
1.75      rillig   1197: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1198: <p>If you created your partitions at the time of installing Mac OS X
1.89      rillig   1199:        and formatted the target partition as UFS or HFSX, it should automatically
1.87      wiz      1200:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
1.89      rillig   1201:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
1.87      wiz      1202:        to ensure that the partition map correctly reflects
1.89      rillig   1203:        &#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   1204: <p>The problem is that none of the disk tools will let you touch a
1.87      wiz      1205:        disk that is booted from. You can unmount the partition, but even if
                   1206:        you newfs it, the partition type will be incorrect and the
                   1207:        automounter won't mount it. It can be mounted manually, but it won't
                   1208:        appear in Finder.</p>
1.75      rillig   1209: <p>You'll need to boot off of the OS X Installation (User) CD.  When
1.87      wiz      1210:        the Installation program starts, go up to the menu and select Disk
                   1211:        Utility.  Now, you will be able to select the partition you want
1.89      rillig   1212:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1213:        installer which will reboot your machine. The new UFS or HFSX file system
1.87      wiz      1214:        will appear in Finder.</p>
1.75      rillig   1215: <p>Be aware that the permissions on the new file system will be writable
1.87      wiz      1216:        by root only.</p>
1.75      rillig   1217: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
1.87      wiz      1218:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
1.75      rillig   1219: </div>
                   1220: </div>
                   1221: <div class="sect2" lang="en">
                   1222: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1223: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1.87      wiz      1224: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1225:       other versions may work.</p>
1.75      rillig   1226: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1227:       with the FreeBSD userland tools. There are several steps:</p>
1.75      rillig   1228: <div class="orderedlist"><ol type="1">
                   1229: <li><p>FreeBSD stores its ports pkg database in
1.87      wiz      1230:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1231:          recommended that you choose a different location (e.g.
                   1232:          <code class="filename">/usr/pkgdb</code>) by
                   1233:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1234: <li>
                   1235: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1236:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1237: <pre class="screen">
                   1238: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1239: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1240: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1241: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1242: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1243:          </pre>
1.75      rillig   1244: </li>
1.110     hubertf  1245: <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      1246:          <code class="filename">/etc/mk.conf.example</code> file
                   1247:          when you use the bootstrap script.</p></li>
1.75      rillig   1248: </ol></div>
                   1249: </div>
                   1250: <div class="sect2" lang="en">
                   1251: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1252: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1.75      rillig   1253: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1254:       providing a Unix-like environment with a tighter kernel integration than
                   1255:       available with Cygwin.  It is part of the Windows Services for Unix
                   1256:       package, available for free for any licensed copy of Windows 2000, XP
1.110     hubertf  1257:       (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   1258: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1259:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1260:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1261: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1262:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
1.95      tron     1263:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
1.75      rillig   1264: <div class="sect3" lang="en">
                   1265: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1266: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1267: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1268:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.75      rillig   1269: <div class="itemizedlist"><ul type="disc">
                   1270: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1271: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1272: <li><p>Remote Connectivity</p></li>
                   1273: <li><p>Interix SDK</p></li>
                   1274: </ul></div>
                   1275: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1276:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1277:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1278:        pkgsrc (or from a binary package).</p>
1.75      rillig   1279: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1280:        not need to be installed, but Remote Connectivity itself should be
                   1281:        installed in order to have a working inetd.</p>
1.75      rillig   1282: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1283:        behavior for Interix programs, and whether to make pathnames default to
                   1284:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1285:        enabled.  (Without case-sensitivity, a large number of packages including
                   1286:        perl will not build.)</p>
1.75      rillig   1287: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1288:        works (via the Data Execution Prevention feature).  In order to use
                   1289:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1290:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1291:        must be installed.  Hotfixes are available from Microsoft through a
1.114     jmcneill 1292:        support contract; however, Debian Interix Port has made most Interix
                   1293:        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   1294: <p>In addition to the hotfix noted above, it may be necessary to
                   1295:        disable Data Execution Prevention entirely to make Interix functional.
                   1296:        This may happen only with certain types of CPUs; the cause is not fully
                   1297:        understood at this time.  If gcc or other applications still segfault
                   1298:        repeatedly after installing one of the hotfixes note above, the
                   1299:        following option can be added to the appropriate "boot.ini" line on the
                   1300:        Windows boot drive:  /NoExecute=AlwaysOff
                   1301:        (WARNING, this will disable DEP completely, which may be a security
                   1302:        risk if applications are often run as a user in the Administrators
                   1303:        group!)</p>
1.75      rillig   1304: </div>
                   1305: <div class="sect3" lang="en">
                   1306: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1307: <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   1308: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1309:        with pkgsrc, note the following things.</p>
1.75      rillig   1310: <div class="itemizedlist"><ul type="disc">
                   1311: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1312:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1313:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.75      rillig   1314: <li>
                   1315: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1316:            change the following registry key:</p>
1.75      rillig   1317: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1318: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1319: </li>
                   1320: <li>
                   1321: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1322:            following registry key:</p>
1.75      rillig   1323: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1324: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1325: </li>
                   1326: </ul></div>
                   1327: </div>
                   1328: <div class="sect3" lang="en">
                   1329: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1330: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1331: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1332:        running "pkg_add") must be a member of the local Administrators
                   1333:        group.  Such a user must also be used to run the bootstrap.  This is
                   1334:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1335: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1336:        automatically complain if this is not the case.  This ensures that
                   1337:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1338: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1339:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1340:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1341:        the same time as the pkgsrc packages, ensure that you use the proper
                   1342:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1343: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1344:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1345:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1346:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1347: <pre class="programlisting">
1.100     rillig   1348: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1349:        </pre>
1.75      rillig   1350: </div>
                   1351: <div class="sect3" lang="en">
                   1352: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1353: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1354: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1355:        for a full Unix-like platform, it has some drawbacks that should
                   1356:        be noted for those desiring to make the most of Interix.</p>
1.75      rillig   1357: <div class="itemizedlist"><ul type="disc">
                   1358: <li>
                   1359: <p><span class="strong"><strong>X11:</strong></span></p>
                   1360: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1361:          and can run X11 based applications, but it does
                   1362:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.110     hubertf  1363:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1364:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87      wiz      1365:          (available in a trimmed version for Interix from Interop Systems as the
1.110     hubertf  1366:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87      wiz      1367:          and the free X11 server included with
1.110     hubertf  1368:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1369: </li>
                   1370: <li>
                   1371: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1372: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1373:          Win32 applications, it does not currently support various X11
                   1374:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1375:          Most interactive applications to a local X server will run
                   1376:          reasonably fast, but full motion video and other graphics
                   1377:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1378: </li>
                   1379: <li>
                   1380: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1381: <p>Interix has no native support for audio output.  For audio
1.110     hubertf  1382:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87      wiz      1383:          audio system on Interix.  Unlike on most platforms, the
1.91      rillig   1384:          <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  1385:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87      wiz      1386:          server component.  To output audio via an Interix host, the
1.91      rillig   1387:          <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      1388:          must also be installed.</p>
1.75      rillig   1389: </li>
                   1390: <li>
                   1391: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1392: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1393:          is not currently possible to access CD/DVD drives, USB devices,
                   1394:          or SCSI devices through non-filesystem means.  Among other things,
                   1395:          this makes it impossible to use Interix directly for CD/DVD
                   1396:          burning.</p>
1.75      rillig   1397: </li>
                   1398: <li>
                   1399: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1400: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1401:          drives are also not directly accessible in Interix.  However,
                   1402:          support is in work to make tape drive access possible by using
                   1403:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1404:          esound server).</p>
1.75      rillig   1405: </li>
                   1406: </ul></div>
                   1407: </div>
                   1408: <div class="sect3" lang="en">
                   1409: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1410: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1411: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1412:        Windows system; any member of the local Administrators group will
                   1413:        suffice.  However, some packages currently assume that the user
                   1414:        named "root" is the privileged user.  To accommodate these, you
                   1415:        may create such a user; make sure it is in the local group
                   1416:        Administrators (or your language equivalent).</p>
1.110     hubertf  1417: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87      wiz      1418:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1419:        time being, install packages as the local Administrator (or
                   1420:        your language equivalent), or run the following command after
                   1421:        installing a package to work around the issue:</p>
1.75      rillig   1422: <pre class="screen">
1.87      wiz      1423: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1424:        </pre>
1.75      rillig   1425: </div>
                   1426: </div>
                   1427: <div class="sect2" lang="en">
                   1428: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1429: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1.75      rillig   1430: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1431:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1432:       according to your preference.  If you do not have a license for the MIPSpro
1.110     hubertf  1433:       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   1434: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.110     hubertf  1435:       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      1436:       etc.</p>
1.86      schwarz  1437: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1438:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1439:        you start out using "abi=n32", that's what all your packages will be built
                   1440:        with.</p>
                   1441: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1442:       <code class="varname">CFLAGS</code> in your environment or the
1.110     hubertf  1443:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.87      wiz      1444:       try to link n32 object files with lib64 or vice versa.  Check your
                   1445:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1446: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1447:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1448:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1449:       link over a network-mounted file system.</p>
1.75      rillig   1450: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1451:       as imake(1), but you may want to set some options depending on your local
                   1452:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1453:       course, your compiler's man pages for details.</p>
1.75      rillig   1454: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1455: 
1.87      wiz      1456:       </p>
1.75      rillig   1457: <pre class="programlisting">
1.100     rillig   1458: PKGSRC_COMPILER=        mipspro
1.87      wiz      1459:       </pre>
1.75      rillig   1460: <p>
1.1       grant    1461: 
1.110     hubertf  1462:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.87      wiz      1463:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1464:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1465:       default.</p>
1.75      rillig   1466: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1467:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1468:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1469:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1470:       '--preserve-path' flag.</p>
1.75      rillig   1471: </div>
                   1472: <div class="sect2" lang="en">
                   1473: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1474: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1.87      wiz      1475: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1476:       either libtermcap or libcurses (libncurses).  Installing the
                   1477:       distributions libncurses-dev package (or equivalent) should fix
                   1478:       the problem.</p>
                   1479: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1480:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1481:       i386 have been tested.</p>
1.75      rillig   1482: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1483:       directory:</p>
1.75      rillig   1484: <pre class="programlisting">
1.100     rillig   1485: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1486: ac_cv___attribute__=yes ./bootstrap
1.87      wiz      1487:       </pre>
1.75      rillig   1488: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1489: <h3 class="title">Note</h3>
                   1490: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1491: </div>
                   1492: <p>icc supports __attribute__, but the GNU configure test uses a nested
1.87      wiz      1493:       function, which icc does not support. #undef'ing __attribute__ has the
                   1494:       unfortunate side-effect of breaking many of the Linux header files, which
                   1495:       cannot be compiled properly without __attribute__. The test must be
                   1496:       overridden so that __attribute__ is assumed supported by the
                   1497:       compiler.</p>
1.75      rillig   1498: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.110     hubertf  1499:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1500: <pre class="programlisting">
1.100     rillig   1501: PKGSRC_COMPILER=        icc
1.87      wiz      1502:       </pre>
1.75      rillig   1503: <p>The default installation directory for icc is
1.87      wiz      1504:       <code class="filename">/opt/intel_cc_80</code>, which
                   1505:       is also the pkgsrc default. If you have installed it into a different
                   1506:       directory, set <code class="varname">ICCBASE</code> in
1.110     hubertf  1507:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   1508: <pre class="programlisting">
1.100     rillig   1509: ICCBASE=                /opt/icc
1.87      wiz      1510:       </pre>
1.75      rillig   1511: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1512:       provided by icc, so binaries can be run on other systems which do not
                   1513:       have the shared libraries installed.</p>
                   1514: <p>Libtool, however, extracts a list of libraries from the
1.110     hubertf  1515:       <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      1516:       records it, throwing away the -Bstatic and -Bdynamic options
                   1517:       interspersed between the libraries.  This means that
                   1518:       libtool-linked C++ shared libraries will have a runtime
                   1519:       dependency on the icc libraries until this is fixed in
                   1520:       libtool.</p>
1.75      rillig   1521: </div>
                   1522: <div class="sect2" lang="en">
                   1523: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1524: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1.75      rillig   1525: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1526: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1527:       with the OpenBSD userland tools. There are several steps:</p>
1.75      rillig   1528: <div class="orderedlist"><ol type="1">
                   1529: <li><p>OpenBSD stores its ports pkg database in
1.87      wiz      1530:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1531:          recommended that you choose a different location (e.g.
                   1532:          <code class="filename">/usr/pkgdb</code>) by
                   1533:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.75      rillig   1534: <li>
                   1535: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1536:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1537: <pre class="screen">
                   1538: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1539: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1540: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1541: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1542: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1543:          </pre>
1.75      rillig   1544: </li>
                   1545: <li>
1.110     hubertf  1546: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1547:          <code class="filename">/etc/mk.conf.example</code> file
                   1548:          when you use the bootstrap script. OpenBSD's make program uses
1.110     hubertf  1549:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87      wiz      1550:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1551:          of the file with:</p>
                   1552: <pre class="programlisting">
1.100     rillig   1553: .ifdef BSD_PKG_MK
                   1554: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1555: .else
                   1556: # OpenBSD stuff
                   1557: .endif
1.87      wiz      1558:          </pre>
1.75      rillig   1559: </li>
                   1560: </ol></div>
                   1561: </div>
                   1562: <div class="sect2" lang="en">
                   1563: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1564: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1.75      rillig   1565: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1.87      wiz      1566:       You will need a working C compiler. Both gcc 2.95.3 and
                   1567:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1568: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1569:       process and to build packages.</p>
1.75      rillig   1570: <div class="itemizedlist"><ul type="disc">
                   1571: <li><p>SUNWsprot</p></li>
                   1572: <li><p>SUNWarc</p></li>
                   1573: <li><p>SUNWbtool</p></li>
                   1574: <li><p>SUNWtoo</p></li>
                   1575: <li><p>SUNWlibm</p></li>
                   1576: </ul></div>
1.78      rillig   1577: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1578:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1579: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1580:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1581:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1582:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.75      rillig   1583: <div class="sect3" lang="en">
                   1584: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1585: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1586: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1587:        for building all packages.</p>
1.75      rillig   1588: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1589:        then either build gcc from
1.91      rillig   1590:        <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      1591:        package, then remove gcc used during bootstrapping.</p>
1.110     hubertf  1592: <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   1593: </div>
                   1594: <div class="sect3" lang="en">
                   1595: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1596: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1597: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1598:        5.0)</p>
1.75      rillig   1599: <div class="itemizedlist"><ul type="disc">
                   1600: <li><p>SPROcc
1.87      wiz      1601:          - Sun WorkShop Compiler C 5.0</p></li>
1.75      rillig   1602: <li><p>SPROcpl
1.87      wiz      1603:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.75      rillig   1604: <li><p>SPROild
1.87      wiz      1605:          - Sun WorkShop Incremental Linker</p></li>
1.75      rillig   1606: <li><p>SPROlang
1.87      wiz      1607:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1608: </ul></div>
1.96      rillig   1609: <p>You should set the following variables in your
1.110     hubertf  1610:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96      rillig   1611: <pre class="programlisting">
1.100     rillig   1612: CC=     cc
                   1613: CXX=    CC
                   1614: CPP=    cc -E
                   1615: CXXCPP= CC -E
1.96      rillig   1616: </pre>
                   1617: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1618: <h3 class="title">Note</h3>
                   1619: <p>The <code class="varname">CPP</code> setting might break some
                   1620:        packages that use the C preprocessor for processing things other
                   1621:        than C source code.</p>
                   1622: </div>
1.75      rillig   1623: </div>
                   1624: <div class="sect3" lang="en">
                   1625: <div class="titlepage"><div><div><h4 class="title">
1.93      rillig   1626: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1627: <p>To build 64-bit packages, you just need to have the
1.110     hubertf  1628:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75      rillig   1629: <pre class="programlisting">
1.100     rillig   1630: PKGSRC_COMPILER=        sunpro
                   1631: ABI=                    64
1.96      rillig   1632: </pre>
                   1633: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1634: <h3 class="title">Note</h3>
                   1635: <p>This setting has been tested for the SPARC
                   1636:        architecture. Intel and AMD machines need some more
                   1637:        work.</p>
                   1638: </div>
1.75      rillig   1639: </div>
                   1640: <div class="sect3" lang="en">
                   1641: <div class="titlepage"><div><div><h4 class="title">
1.82      rillig   1642: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.110     hubertf  1643: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87      wiz      1644:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1645:       The workaround is to use another shell for the configure
1.91      rillig   1646:       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  1647:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87      wiz      1648: <pre class="programlisting">
1.100     rillig   1649: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1650: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1651:       </pre>
1.91      rillig   1652: <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   1653: </div>
                   1654: </div>
                   1655: </div>
                   1656: </div>
                   1657: <div class="chapter" lang="en">
                   1658: <div class="titlepage"><div><div><h2 class="title">
                   1659: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1660: <div class="toc">
                   1661: <p><b>Table of Contents</b></p>
                   1662: <dl>
                   1663: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1664: <dd><dl>
                   1665: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1666: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1667: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1668: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1669: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1670: <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>
                   1671: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1672: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1.75      rillig   1673: </dl></dd>
                   1674: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1675: <dd><dl>
                   1676: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1677: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1678: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1679: </dl></dd>
                   1680: </dl>
                   1681: </div>
                   1682: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1683: is to only install the package tools and to use binary packages
                   1684: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1685: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1686: of pkgsrc, too. Then you are able to build your own packages,
                   1687: and you can still use binary packages from someone else.</p>
1.75      rillig   1688: <div class="sect1" lang="en">
                   1689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1690: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1691: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1692:   server and its mirrors, there are collections of binary packages,
                   1693:   ready to be installed. These binary packages have been built using the
                   1694:   default settings for the directories, that is:</p>
                   1695: <div class="itemizedlist"><ul type="disc">
                   1696: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1697: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1698: <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>
                   1699: </ul></div>
                   1700: <p>If you cannot use these directories for whatever reasons (maybe
                   1701:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1702:   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   1703: <div class="sect2" lang="en">
                   1704: <div class="titlepage"><div><div><h3 class="title">
                   1705: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1706: <p>To install binary packages, you first need to know from where
                   1707:     to get them. The first place where you should look is on the main
1.110     hubertf  1708:     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   1709: <p>This directory contains binary packages for multiple
                   1710:     platforms. First, select your operating system. (Ignore the
                   1711:     directories with version numbers attached to it, they just exist for
                   1712:     legacy reasons.) Then, select your hardware architecture, and in the
1.109     rillig   1713:     third step, the OS version and the &#8220;<span class="quote">version</span>&#8221; of pkgsrc.</p>
                   1714: <p>In this directory, you often find a file called
                   1715:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1716:     management tools. If the file is missing, it is likely that your
                   1717:     operating system already provides those tools. Download the file and
                   1718:     extract it in the <code class="filename">/</code> directory. It will create
                   1719:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1720:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1721:     (the database of installed packages).</p>
1.75      rillig   1722: </div>
                   1723: <div class="sect2" lang="en">
                   1724: <div class="titlepage"><div><div><h3 class="title">
                   1725: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1726: <p>In the directory from the last section, there is a
                   1727:     subdirectory called <code class="filename">All</code>, which contains all the
                   1728:     binary packages that are available for the platform, excluding those
                   1729:     that may not be distributed via FTP or CDROM (depending on which
                   1730:     medium you are using), and the ones that have vulnerabilities and
                   1731:     therefore are considered insecure to install without thinking
                   1732:     before.</p>
                   1733: <p>To install packages directly from an FTP or HTTP server, run
                   1734:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1735:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1736: <pre class="screen">
                   1737: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1738: <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>
                   1739: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1740: </pre>
                   1741: <p>Instead of URLs, you can also use local paths, for example if
                   1742:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1743:     repository. If you want to install packages from multiple sources,
                   1744:     you can separate them by a semicolon in
                   1745:     <code class="varname">PKG_PATH</code>.</p>
                   1746: <p>After these preparations, installing a package is very
                   1747:     easy:</p>
                   1748: <pre class="screen">
                   1749: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1750: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1751: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1752: </pre>
1.75      rillig   1753: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1754:     package in question will be installed, too, assuming they are
                   1755:     present where you install from.</p>
1.109     rillig   1756: <p>As mentioned above, packages for which vulnerabilities get
                   1757:     known are not stored in the <code class="filename">All</code> subdirectory.
                   1758:     They don't get deleted since that could be very frustrating if many
                   1759:     other packages depend on it. Instead, they are moved to the
                   1760:     <code class="filename">vulnerable</code> subdirectory. So you may need to add
                   1761:     this directory to the <code class="varname">PKG_PATH</code> variable. 
1.125   ! wiz      1762:     However, you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.114     jmcneill 1763:     regularly, especially after installing new packages, and verify
                   1764:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1765: <p>After you've installed packages, be sure to have
1.88      wiz      1766:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1767:     <code class="varname">PATH</code> so you can actually start the just
                   1768:     installed program.</p>
1.75      rillig   1769: </div>
                   1770: <div class="sect2" lang="en">
                   1771: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1772: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1773: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1774:     installed from source code or from a binary package. The
1.110     hubertf  1775:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1776:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1777:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1778:     name can be given with or without version number. Wildcards can
                   1779:     also be used to deinstall a set of packages, for example
                   1780:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1781:     so that the shell does not expand them before
                   1782:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1783: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1784:     removes all the packages that require the package in question
                   1785:     and then removes the package itself. For example:
1.82      rillig   1786: 
1.88      wiz      1787:     </p>
1.82      rillig   1788: <pre class="screen">
1.88      wiz      1789: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1790:     </pre>
1.82      rillig   1791: <p>
                   1792: 
1.88      wiz      1793:     will remove jpeg and all the packages that used it; this allows
                   1794:     upgrading the jpeg package.</p>
1.82      rillig   1795: </div>
                   1796: <div class="sect2" lang="en">
                   1797: <div class="titlepage"><div><div><h3 class="title">
                   1798: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1799: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1800:     installed packages or binary package files.</p>
1.82      rillig   1801: </div>
                   1802: <div class="sect2" lang="en">
                   1803: <div class="titlepage"><div><div><h3 class="title">
                   1804: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1805: <p>
1.88      wiz      1806:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1807:       known security vulnerabilities to packages which are (or have been)
                   1808:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1809:       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      1810:     </p>
1.82      rillig   1811: <p>
1.125   ! wiz      1812:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1813:       this list can be downloaded
                   1814:       automatically, and a security audit of all packages installed on a system
                   1815:       can take place.
                   1816:     </p>
1.82      rillig   1817: <p>
1.125   ! wiz      1818:       There are two components to auditing.  The first
        !          1819:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
        !          1820:       is for downloading
1.88      wiz      1821:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125   ! wiz      1822:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1823:       installed packages are vulnerable.  If a package is vulnerable, you
                   1824:       will see output similar to the following:
                   1825:     </p>
1.82      rillig   1826: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1827:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1828: <p>
1.125   ! wiz      1829:       You may wish to have the
1.110     hubertf  1830:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125   ! wiz      1831:       file downloaded daily so that
        !          1832:       it remains current.  This may be done by adding an appropriate entry
        !          1833:       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
        !          1834:       </p>
        !          1835: <pre class="screen">
        !          1836: # download vulnerabilities file
        !          1837: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
        !          1838:       </pre>
        !          1839: <p>
        !          1840:       will update the vulnerability list every day at 3AM. You may wish to do
        !          1841:       this more often than once a day.
        !          1842: 
        !          1843:       In addition, you may wish to run the package audit from the daily
        !          1844:       security script.  This may be accomplished by adding the following
        !          1845:       line to <code class="filename">/etc/security.local</code>:
        !          1846:       </p>
        !          1847: <pre class="screen">
        !          1848: /usr/sbin/pkg_admin audit
        !          1849:       </pre>
        !          1850: <p>
1.88      wiz      1851:     </p>
1.82      rillig   1852: </div>
                   1853: <div class="sect2" lang="en">
                   1854: <div class="titlepage"><div><div><h3 class="title">
                   1855: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1856: <p>
1.112     weinem   1857:       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  1858:       <span class="command"><strong>lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
1.88      wiz      1859:       argument to check if your packages are up-to-date, e.g.
                   1860:     </p>
                   1861: <pre class="screen">
                   1862: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1863: ...
1.88      wiz      1864: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1865:     </pre>
1.110     hubertf  1866: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1867:     package on your system and rebuild any dependencies.
                   1868:     </p>
1.82      rillig   1869: </div>
                   1870: <div class="sect2" lang="en">
                   1871: <div class="titlepage"><div><div><h3 class="title">
                   1872: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1873: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1874:     administrative functions on the package system.</p>
1.82      rillig   1875: </div>
                   1876: <div class="sect2" lang="en">
                   1877: <div class="titlepage"><div><div><h3 class="title">
                   1878: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1.75      rillig   1879: <p>Please pay very careful attention to the warnings
1.110     hubertf  1880:     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      1881:     inherent dangers of installing binary packages which you did
                   1882:     not create yourself, and the security holes that can be
                   1883:     introduced onto your system by indiscriminate adding of such
                   1884:     files.</p>
1.75      rillig   1885: <p>The same warning of course applies to every package you
1.88      wiz      1886:     install from source when you haven't completely read and
                   1887:     understood the source code of the package, the compiler that
                   1888:     is used to build the package and all the other tools that are
                   1889:     involved.</p>
1.75      rillig   1890: </div>
                   1891: </div>
                   1892: <div class="sect1" lang="en">
                   1893: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1894: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1895: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1896:   directory now contains a set of packages, organized into
                   1897:   categories. You can browse the online index of packages, or run
1.110     hubertf  1898:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1899:   directory to build local <code class="filename">README.html</code> files for
1.91      rillig   1900:   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      1901: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1902:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1903:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1904:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1905:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1906:   system (inside a chroot is an exception). </p>
                   1907: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1908:   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      1909:   instructions how to create your own packages.</p>
1.75      rillig   1910: <div class="sect2" lang="en">
                   1911: <div class="titlepage"><div><div><h3 class="title">
                   1912: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1913: <p>To build packages from source, you need a working C
1.88      wiz      1914:     compiler. On NetBSD, you need to install the
                   1915:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   1916:     sets. If you want to build X11-related packages, the
                   1917:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   1918:     sets are required, too.</p>
1.75      rillig   1919: </div>
                   1920: <div class="sect2" lang="en">
                   1921: <div class="titlepage"><div><div><h3 class="title">
                   1922: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1923: <p>The first step for building a package is downloading the
1.88      wiz      1924:     distfiles (i.e. the unmodified source). If they have not yet been
                   1925:     downloaded, pkgsrc will fetch them automatically.</p>
                   1926: <p>If you have all files that you need in the
                   1927:     <code class="filename">distfiles</code> directory,
                   1928:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1929:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1930:     </p>
1.82      rillig   1931: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1932: <p>
1.110     hubertf  1933:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1934: <p>By default a list of distribution sites will be randomly
                   1935:     intermixed to prevent huge load on servers which holding popular
                   1936:     packages (for example, SourceForge.net mirrors). Thus, every
                   1937:     time when you need to fetch yet another distfile all the mirrors
                   1938:     will be tried in new (random) order. You can turn this feature
                   1939:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1940:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1941: <p>You can overwrite some of the major distribution sites to
                   1942:     fit to sites that are close to your own.  By setting one or two
                   1943:     variables you can modify the order in which the master sites are
                   1944:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1945:     delimited list of domain suffixes.
                   1946:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1947:     contains a whitespace delimited list of regular expressions.  It
                   1948:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1949:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1950:     some examples.  This may save some of your bandwidth and
                   1951:     time.</p>
1.75      rillig   1952: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1953:     if you want to keep the settings, by editing the
1.110     hubertf  1954:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1955:     and adding the definitions there.</p>
1.82      rillig   1956: <p>
1.88      wiz      1957:       If a package depends on many other packages (such as
1.93      rillig   1958:       <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      1959:       alternate between periods of
                   1960:       downloading source, and compiling. To ensure you have all the source
                   1961:       downloaded initially you can run the command:
                   1962:       </p>
1.82      rillig   1963: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1964: <p>
1.88      wiz      1965:       which will output and run a set of shell commands to fetch the
                   1966:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1967:       also choose to download the files manually.
                   1968:     </p>
1.75      rillig   1969: </div>
                   1970: <div class="sect2" lang="en">
                   1971: <div class="titlepage"><div><div><h3 class="title">
                   1972: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1973: <p>
1.88      wiz      1974:       Once the software has downloaded, any patches will be applied, then it
                   1975:       will be compiled for you. This may take some time depending on your
                   1976:       computer, and how many other packages the software depends on and their
                   1977:       compile time.
                   1978:     </p>
1.75      rillig   1979: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1980: <h3 class="title">Note</h3>
                   1981: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1982:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.88      wiz      1983:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
1.75      rillig   1984: </div>
1.87      wiz      1985: <p>For example, type</p>
1.88      wiz      1986: <pre class="screen">
                   1987: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1988: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1989:     </pre>
1.75      rillig   1990: <p>at the shell prompt to build the various components of the
1.88      wiz      1991:     package.</p>
1.82      rillig   1992: <p>The next stage is to actually install the newly compiled
1.88      wiz      1993:     program onto your system. Do this by entering:
1.82      rillig   1994: 
1.88      wiz      1995:     </p>
1.82      rillig   1996: <pre class="screen">
1.88      wiz      1997: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1998:     </pre>
1.82      rillig   1999: <p>
                   2000: 
1.88      wiz      2001:     while you are still in the directory for whatever package you
                   2002:     are installing.</p>
1.82      rillig   2003: <p>Installing the package on your system may require you to
1.88      wiz      2004:     be root.  However, pkgsrc has a
                   2005:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   2006:     to only become root for the actual installation step.</p>
1.82      rillig   2007: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      2008:     You can now enter:
1.82      rillig   2009: 
1.88      wiz      2010:     </p>
1.82      rillig   2011: <pre class="screen">
1.88      wiz      2012: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   2013:     </pre>
1.82      rillig   2014: <p>
                   2015: 
1.88      wiz      2016:     to remove the compiled files in the work directory, as you shouldn't need
                   2017:     them any more. If other packages were also added to your system
                   2018:     (dependencies) to allow your program to compile, you can tidy these up
                   2019:     also with the command:</p>
1.82      rillig   2020: <pre class="screen">
1.88      wiz      2021: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2022:     </pre>
1.75      rillig   2023: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  2024:     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      2025: <p>The program is installed under the default root of the
                   2026:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2027:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2028:     variable in your environment, and it will use that value as the
                   2029:     root of your packages tree. So, to use
                   2030:     <code class="filename">/usr/local</code>, set
                   2031:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2032:     Please note that you should use a directory which is dedicated to
                   2033:     packages and not shared with other programs (i.e., do not try and
                   2034:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2035:     to add any of your own files or directories (such as
                   2036:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2037:     <code class="filename">pkgsrc/</code>) below the
                   2038:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2039:     conflicts between programs and other files installed by the
                   2040:     package system and whatever else may have been installed
                   2041:     there.</p>
1.110     hubertf  2042: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      2043:     alter some configuration options at build time.  Have a look at
                   2044:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2045:     of what will be set there by default.  Environment variables such
                   2046:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  2047:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      2048:     set them each time you want to use pkgsrc.</p>
                   2049: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2050:     covers</span>&#8221; to see what is going on when a package is building
                   2051:     or being installed. This may be for debugging purposes, or out of
                   2052:     simple curiosity. A number of utility values have been added to
                   2053:     help with this.</p>
1.75      rillig   2054: <div class="orderedlist"><ol type="1">
                   2055: <li>
1.110     hubertf  2056: <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      2057:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2058:        information will be displayed. For example,</p>
1.75      rillig   2059: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2060: <p>will show all the commands that are invoked, up to and
                   2061:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
1.75      rillig   2062: </li>
                   2063: <li>
1.110     hubertf  2064: <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      2065:        definition, then the <code class="varname">VARNAME</code> definition
                   2066:        should be used, in conjunction with the show-var
1.110     hubertf  2067:        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      2068:        variable <code class="varname">LOCALBASE</code>:</p>
                   2069: <pre class="screen">
                   2070: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2071: /usr/pkg
                   2072: <code class="prompt">%</code>
1.88      wiz      2073:        </pre>
1.75      rillig   2074: </li>
                   2075: </ol></div>
                   2076: <p>If you want to install a binary package that you've either
1.88      wiz      2077:     created yourself (see next section), that you put into
                   2078:     pkgsrc/packages manually or that is located on a remote FTP
                   2079:     server, you can use the "bin-install" target. This target will
1.110     hubertf  2080:     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>,
                   2081:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      2082:     sites searched is kept in the variable
                   2083:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.110     hubertf  2084:     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      2085:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2086:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2087:     details.</p>
                   2088: <p>A final word of warning: If you set up a system that has a
                   2089:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2090:     set that before any packages are installed, as you cannot use
                   2091:     several directories for the same purpose. Doing so will result in
                   2092:     pkgsrc not being able to properly detect your installed packages,
                   2093:     and fail miserably. Note also that precompiled binary packages are
                   2094:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2095:     <code class="filename">/usr/pkg</code>, and that you should
                   2096:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2097:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2098: </div>
                   2099: </div>
                   2100: </div>
                   2101: <div class="chapter" lang="en">
                   2102: <div class="titlepage"><div><div><h2 class="title">
                   2103: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2104: <div class="toc">
                   2105: <p><b>Table of Contents</b></p>
                   2106: <dl>
                   2107: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2108: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   2109: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      2110: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2111: <dd><dl>
1.103     wiz      2112: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.123     snj      2113: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
                   2114: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.88      wiz      2115: </dl></dd>
1.103     wiz      2116: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2117: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   2118: </dl>
                   2119: </div>
1.104     rillig   2120: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   2121: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2122: that file depends on the installation. On NetBSD, when you use
1.110     hubertf  2123: <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   2124: <code class="filename">/etc/</code>. In all other cases the default location is
                   2125: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2126: bootstrap program to install the binary packages.</p>
                   2127: <p>During the bootstrap, an example configuration file is created. To
                   2128: use that, you have to create the directory
                   2129: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2130: there.</p>
                   2131: <p>The format of the configuration file is that of the usual
                   2132: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2133: is done by setting variables in this file. Note that you can define all
                   2134: kinds of variables, and no special error checking (for example for
                   2135: spelling mistakes) takes place, so you have to try it out to see if it
                   2136: works.</p>
1.75      rillig   2137: <div class="sect1" lang="en">
                   2138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2139: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2140: <p>In this section, you can find some variables that apply to all
1.89      rillig   2141:     pkgsrc packages. A complete list of the variables that can be
                   2142:     configured by the user is available in
                   2143:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2144:     comments that describe each variable's intent.</p>
1.75      rillig   2145: <div class="itemizedlist"><ul type="disc">
                   2146: <li><p><code class="varname">LOCALBASE</code>: Where
                   2147:            packages will be installed. The default is
1.76      rillig   2148:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2149:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2150: <li><p><code class="varname">CROSSBASE</code>: Where
                   2151:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2152:            installed. The default is
1.76      rillig   2153:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.75      rillig   2154: <li><p><code class="varname">X11BASE</code>: Where
                   2155:            X11 is installed on the system. The default is
1.76      rillig   2156:            <code class="filename">/usr/X11R6</code>.</p></li>
1.75      rillig   2157: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2158:            downloaded copies of the original source distributions used
                   2159:            for building pkgsrc packages. The default is
1.76      rillig   2160:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.97      rillig   2161: <li><p><code class="varname">PKG_DBDIR</code>: Where the
                   2162:            database about installed packages is stored.  The default is
                   2163:            <code class="filename">/var/db/pkg</code>.</p></li>
1.75      rillig   2164: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2165:            If set, override the packages'
                   2166:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2167: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2168:            Backup location(s) for distribution files and patch files
                   2169:            if not found locally or in
1.76      rillig   2170:            <code class="filename">${MASTER_SITES}</code> or
                   2171:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2172:            The defaults are
1.76      rillig   2173:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2174:            and
1.76      rillig   2175:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.75      rillig   2176: <li><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2177:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2178:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2179:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2180:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
1.82      rillig   2181: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125   ! wiz      2182:            List of acceptable licenses. License names are case-sensitive.
        !          2183:            Whenever you try to build a package whose license is not in this
        !          2184:            list, you will get an error message. If the license condition is
        !          2185:            simple enough, the error message will include specific
        !          2186:            instructions on how to change this variable.</p></li>
1.75      rillig   2187: </ul></div>
                   2188: </div>
                   2189: <div class="sect1" lang="en">
                   2190: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2191: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2192: <p>XXX
                   2193:       </p>
                   2194: <div class="itemizedlist"><ul type="disc">
                   2195: <li><p><code class="varname">PACKAGES</code>: The top level
                   2196:            directory for the binary packages. The default is
1.76      rillig   2197:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.75      rillig   2198: <li><p><code class="varname">WRKOBJDIR</code>:
                   2199:            The top level directory where, if defined, the separate
                   2200:            working directories will get created, and symbolically
1.76      rillig   2201:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2202:            This is useful for building packages on several
1.76      rillig   2203:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2204:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2205:            is local to every architecture. (It should be noted that
                   2206:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.125   ! wiz      2207:            &#8212; it is an internal definition which refers to the
1.75      rillig   2208:            root of the pkgsrc tree. It is possible to have many
                   2209:            pkgsrc tree instances.)</p></li>
                   2210: <li><p><code class="varname">LOCALPATCHES</code>:
                   2211:            Directory for local patches that aren't part of pkgsrc.
1.110     hubertf  2212:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.93      rillig   2213:            information.</p></li>
1.75      rillig   2214: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  2215:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   2216:            BSD-style Makefile. If this is not set,
                   2217:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2218:            <code class="filename">/dev/null</code> to avoid picking up
                   2219:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.82      rillig   2220: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2221:            By default, dependencies are only installed, and no binary
                   2222:            package is created for them. You can set this variable to
                   2223:            <code class="literal">package</code> to automatically create binary
                   2224:            packages after installing dependencies.</p></li>
1.75      rillig   2225: </ul></div>
                   2226: </div>
                   2227: <div class="sect1" lang="en">
                   2228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   2229: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.103     wiz      2230: <p>A growing number of packages support installation into a
                   2231:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2232:     to be built, before the actual filesystem is touched. DESTDIR
                   2233:     support exists in two variations:</p>
                   2234: <div class="itemizedlist"><ul type="disc">
                   2235: <li><p>Basic DESTDIR support means that the package
                   2236:       installation and packaging is still run as
                   2237:       root.</p></li>
                   2238: <li><p>Full DESTDIR support can run the complete build,
                   2239:       installation and packaging as normal user. Root privileges are
                   2240:       only needed to add packages.</p></li>
                   2241: </ul></div>
1.123     snj      2242: <p>To use the DESTDIR support, set
                   2243:     <code class="varname">USE_DESTDIR=yes</code> to get the full support for packages
                   2244:     that support it and with fallback to basic support. </p>
1.103     wiz      2245: <p>DESTDIR support changes the behaviour of various targets
                   2246:     slightly. To install a package after building it, use
                   2247:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2248:     <code class="literal">install</code> don't do that any
                   2249:     longer. <code class="literal">package-install</code> can be used as
                   2250:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2251:     will ask for the root password to install the package and fail,
                   2252:     <code class="literal">package-install</code> will ask again.</p>
                   2253: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2254:     clean</code></strong> needs to be run as root.</p>
1.118     imil     2255: <p>Considering the <code class="filename">foo/bar</code> package,
                   2256:     DESTDIR full support can be tested using the following commands
                   2257: 
                   2258: </p>
                   2259: <pre class="programlisting">
                   2260: <code class="prompt">$</code> id
                   2261: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2262: <code class="prompt">$</code> mkdir $HOME/packages
                   2263: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2264: </pre>
                   2265: <p>
                   2266: 
                   2267:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2268:     should be needed
                   2269: 
                   2270: </p>
                   2271: <pre class="programlisting">
1.123     snj      2272: <code class="prompt">$</code> make USE_DESTDIR=yes install
1.118     imil     2273: </pre>
                   2274: <p>
                   2275: 
                   2276:     Create a package without root privileges
                   2277: 
                   2278: </p>
                   2279: <pre class="programlisting">
1.123     snj      2280: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
1.118     imil     2281: </pre>
                   2282: <p>
                   2283: 
                   2284:     For the following command, you must be able to gain root
                   2285:     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>
                   2286: 
                   2287: </p>
                   2288: <pre class="programlisting">
1.123     snj      2289: <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
1.118     imil     2290: </pre>
                   2291: <p>
                   2292: 
                   2293:     Then, as a simple user
                   2294: 
                   2295: </p>
                   2296: <pre class="programlisting">
                   2297: <code class="prompt">$</code> make clean
                   2298: </pre>
                   2299: <p>
                   2300: 
                   2301:     </p>
1.103     wiz      2302: </div>
                   2303: <div class="sect1" lang="en">
                   2304: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2305: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.78      rillig   2306: <div class="sect2" lang="en">
                   2307: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2308: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   2309: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2310:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2311: <div class="variablelist"><dl>
                   2312: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2313: <dd>
                   2314: <p>This is a list of values specifying the chain of
                   2315:          compilers to invoke when building packages.  Valid values
                   2316:          are:</p>
                   2317: <div class="itemizedlist"><ul type="disc">
                   2318: <li><p><code class="varname">distcc</code>:
                   2319:            distributed C/C++ (chainable)</p></li>
                   2320: <li><p><code class="varname">ccache</code>:
                   2321:            compiler cache (chainable)</p></li>
                   2322: <li><p><code class="varname">gcc</code>:
                   2323:            GNU C/C++ Compiler</p></li>
                   2324: <li><p><code class="varname">mipspro</code>:
                   2325:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2326: <li><p><code class="varname">mipspro</code>:
                   2327:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2328: <li><p><code class="varname">sunpro</code>:
                   2329:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2330: </ul></div>
                   2331: <p>The default is
                   2332:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2333:          <code class="varname">ccache</code> and/or
                   2334:          <code class="varname">distcc</code> with an appropriate
                   2335:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2336:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
1.94      dmcmahil 2337:          variable should always be terminated with a value for
                   2338:          a real compiler.  Note that only one real compiler
                   2339:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2340:          is not allowed).</p>
1.89      rillig   2341: </dd>
                   2342: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2343: <dd><p>This specifies the minimum version of GCC to use
                   2344:          when building packages.  If the system GCC doesn't
                   2345:          satisfy this requirement, then pkgsrc will build and
                   2346:          install one of the GCC packages to use instead.</p></dd>
                   2347: </dl></div>
                   2348: </div>
                   2349: <div class="sect2" lang="en">
                   2350: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2351: <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   2352: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2353:        please make sure to use the <code class="literal">+=</code> operator
                   2354:        instead of the <code class="literal">=</code> operator:</p>
                   2355: <pre class="programlisting">
1.100     rillig   2356: CFLAGS+=        -your -flags
1.78      rillig   2357: </pre>
                   2358: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.117     jnemeth  2359:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that
                   2360:        need to add their own flags.  You may want to take a look
                   2361:        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>
                   2362:        package if you're interested in optimization for the current
                   2363:        CPU.  Setting <code class="varname">USE_CPUFLAGS</code> to yes in
                   2364:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use cpuflags.</p>
1.78      rillig   2365: </div>
1.88      wiz      2366: <div class="sect2" lang="en">
                   2367: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2368: <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      2369: <p>If you want to pass flags to the linker, both in the configure
                   2370: step and the build step, you can do this in two ways.  Either set
                   2371: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2372: between the two is that <code class="varname">LIBS</code> will be appended to
                   2373: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2374: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2375: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2376: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2377: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2378: settings, use the <code class="literal">+=</code> operator:</p>
                   2379: <pre class="programlisting">
1.100     rillig   2380: LDFLAGS+=        -your -linkerflags
1.88      wiz      2381: </pre>
                   2382: </div>
1.78      rillig   2383: </div>
                   2384: <div class="sect1" lang="en">
                   2385: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2386: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.75      rillig   2387: <p>XXX
                   2388:       </p>
                   2389: <div class="itemizedlist"><ul type="disc">
                   2390: <li>
                   2391: <p><code class="varname">PKG_DEVELOPER</code>:
                   2392:            Run some sanity checks that package developers want:
                   2393:            </p>
                   2394: <div class="itemizedlist"><ul type="circle">
1.88      wiz      2395: <li><p>make sure patches apply with zero
                   2396:              fuzz</p></li>
                   2397: <li><p>run check-shlibs to see that all
                   2398:              binaries will find their shared libs.</p></li>
1.75      rillig   2399: </ul></div>
                   2400: <p>
1.87      wiz      2401:        </p>
1.75      rillig   2402: </li>
1.88      wiz      2403: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2404:        of debugging output which is displayed whilst making and
                   2405:        installing the package.  The default value for this is 0,
                   2406:        which will not display the commands as they are executed
                   2407:        (normal, default, quiet operation); the value 1 will display
                   2408:        all shell commands before their invocation, and the value 2
                   2409:        will display both the shell commands before their invocation,
1.110     hubertf  2410:        and their actual execution progress with <span class="command"><strong>set
1.88      wiz      2411:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2412: </ul></div>
                   2413: <p>
                   2414:     </p>
                   2415: </div>
                   2416: <div class="sect1" lang="en">
                   2417: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2418: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      2419: <p>Some packages have build time options, usually to select
                   2420:     between different dependencies, enable optional support for big
                   2421:     dependencies or enable experimental features.</p>
1.75      rillig   2422: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2423:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2424:     show-options</strong></span>, for example:</p>
1.75      rillig   2425: <pre class="programlisting">
                   2426:     The following options are supported by this package:
                   2427:         ssl      Enable SSL support.
                   2428:     Exactly one of the following gecko options is required:
                   2429:         firefox  Use firefox as gecko rendering engine.
                   2430:         mozilla  Use mozilla as gecko rendering engine.
                   2431:     At most one of the following database options may be selected:
                   2432:         mysql    Enable support for MySQL database.
                   2433:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2434: 
1.75      rillig   2435:     These options are enabled by default: firefox
                   2436:     These options are currently enabled: mozilla ssl
1.1       grant    2437: </pre>
1.75      rillig   2438: <p>The following variables can be defined in
1.110     hubertf  2439:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2440:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2441:     which can be used to select or disable options for all packages
                   2442:     that support them, and
                   2443:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2444:     which can be used to select or disable options specifically for
                   2445:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2446:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2447:     are disabled. A few examples:</p>
1.75      rillig   2448: <pre class="screen">
1.110     hubertf  2449: <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   2450: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2451: PKG_OPTIONS.kdebase=    debug -sasl
                   2452: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2453: <p>It is important to note that options that were specifically
1.120     snj      2454:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2455:     you do not wish to include the option.  If you are unsure you can view
                   2456:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2457: <p>The following settings are consulted in the order given, and
                   2458:     the last setting that selects or disables an option is
                   2459:     used:</p>
1.75      rillig   2460: <div class="orderedlist"><ol type="1">
                   2461: <li><p>the default options as suggested by the package
1.88      wiz      2462:       maintainer</p></li>
1.75      rillig   2463: <li><p>the options implied by the settings of legacy
1.88      wiz      2464:       variables (see below)</p></li>
1.75      rillig   2465: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2466: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2467: </ol></div>
                   2468: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2469:     selected is used, all others are automatically disabled.  If an
                   2470:     option of the group is explicitly disabled, the previously
                   2471:     selected option, if any, is used.  It is an error if no option
                   2472:     from a required group of options is selected, and building the
                   2473:     package will fail.</p>
                   2474: <p>Before the options framework was introduced, build options
                   2475:     were selected by setting a variable (often named
                   2476:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2477:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2478:     transition to the options framework for the user, these legacy
                   2479:     variables are converted to the appropriate options setting
                   2480:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2481:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2482:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2483:     directly.  Support for the legacy variables will be removed
                   2484:     eventually.</p>
1.75      rillig   2485: </div>
                   2486: </div>
                   2487: <div class="chapter" lang="en">
                   2488: <div class="titlepage"><div><div><h2 class="title">
                   2489: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2490: <div class="toc">
                   2491: <p><b>Table of Contents</b></p>
                   2492: <dl>
                   2493: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2494: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2495: </dl>
                   2496: </div>
                   2497: <div class="sect1" lang="en">
                   2498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2499: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2500: <p>Once you have built and installed a package, you can create
                   2501:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.110     hubertf  2502:     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      2503:     the same package on a group of hosts and wasting CPU time. It also
                   2504:     provides a simple means for others to install your package, should
                   2505:     you distribute it.</p>
                   2506: <p>To create a binary package, change into the appropriate
1.110     hubertf  2507:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2508:     package</strong></span>:</p>
                   2509: <pre class="screen">
                   2510: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2511: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2512:     </pre>
                   2513: <p>This will build and install your package (if not already done),
                   2514:     and then build a binary package from what was installed. You can
1.110     hubertf  2515:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2516:     it. Binary packages are created by default in
                   2517:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2518:     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   2519:     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  2520: <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      2521:     such a binary package.</p>
1.75      rillig   2522: </div>
                   2523: <div class="sect1" lang="en">
                   2524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2525: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2526: <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   2527: </div>
                   2528: </div>
                   2529: <div class="chapter" lang="en">
                   2530: <div class="titlepage"><div><div><h2 class="title">
                   2531: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2532: builds)</h2></div></div></div>
                   2533: <div class="toc">
                   2534: <p><b>Table of Contents</b></p>
                   2535: <dl>
                   2536: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2537: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2538: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2539: <dd><dl>
                   2540: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2541: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2542: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2543: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2544: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2545: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2546: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2547: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2548: </dl></dd>
                   2549: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.116     rillig   2550: <dd><dl>
                   2551: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                   2552: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                   2553: </dl></dd>
1.106     rillig   2554: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2555: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2556: </dl>
                   2557: </div>
                   2558: <p>When you have multiple machines that should run the same packages,
                   2559: it is wasted time if they all build their packages themselves from
                   2560: source. There are two ways of getting a set of binary packages: The old
                   2561: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2562: system. This chapter describes how to set them up so that the packages
                   2563: are most likely to be usable later.</p>
                   2564: <div class="sect1" lang="en">
                   2565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2566: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2567: <p>Since a bulk build takes several days or even weeks to finish, you
                   2568: should think about the setup before you start everything. Pay attention
                   2569: to at least the following points:</p>
                   2570: <div class="itemizedlist"><ul type="disc">
                   2571: <li>
                   2572: <p>If you want to upload the binary packages to
                   2573: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2574: packages:</p>
                   2575: <div class="itemizedlist"><ul type="circle">
                   2576: <li><p>To end up on ftp.NetBSD.org, the packages must be built
                   2577: by a NetBSD developer on a trusted machine (that is, where you and only
                   2578: you have root access).</p></li>
                   2579: <li><p>Packages on ftp.NetBSD.org should only be created from
1.124     snj      2580: the stable branches (like 2009Q1), so that users browsing the available
1.106     rillig   2581: collections can see at a glance how old the packages
                   2582: are.</p></li>
                   2583: <li><p>The packages must be built as root, since some packages
                   2584: require set-uid binaries at runtime, and creating those packages as
                   2585: unprivileged user doesn't work well at the moment.</p></li>
                   2586: </ul></div>
                   2587: </li>
                   2588: <li><p>Make sure that the bulk build cannot break anything in
                   2589: your system. Most bulk builds run as root, so they should be run at least
                   2590: in a chroot environment or something even more restrictive, depending on
                   2591: what the operating system provides. There have been numerous cases where
                   2592: certain packages tried to install files outside the
                   2593: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2594: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2595: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2596: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2597: that you don't need any package during the build.</p></li>
                   2598: </ul></div>
                   2599: </div>
                   2600: <div class="sect1" lang="en">
                   2601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2602: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2603: <p>A complete bulk build requires lots of disk space. Some of the
                   2604: disk space can be read-only, some other must be writable. Some can be on
                   2605: remote filesystems (such as NFS) and some should be local. Some can be
                   2606: temporary filesystems, others must survive a sudden reboot.</p>
                   2607: <div class="itemizedlist"><ul type="disc">
                   2608: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2609: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2610: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2611: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2612: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2613: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2614: </ul></div>
1.75      rillig   2615: </div>
                   2616: <div class="sect1" lang="en">
                   2617: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2618: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.116     rillig   2619: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2620: <h3 class="title">Note</h3>
                   2621: <p>There are two ways of doing a bulk build. The old-style
                   2622: one and the new-style &#8220;<span class="quote">pbulk</span>&#8221;. The latter is the recommended
                   2623: way.</p>
1.106     rillig   2624: </div>
1.75      rillig   2625: <div class="sect2" lang="en">
                   2626: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2627: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.75      rillig   2628: <div class="sect3" lang="en">
                   2629: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2630: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.93      rillig   2631: </h4></div></div></div>
1.76      rillig   2632: <p>The <code class="filename">build.conf</code> file is the main
1.87      wiz      2633:        configuration file for bulk builds. You can configure how your
                   2634:        copy of pkgsrc is kept up to date, how the distfiles are
                   2635:        downloaded, how the packages are built and how the report is
                   2636:        generated. You can find an annotated example file in
                   2637:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2638:        it, copy <code class="filename">build.conf-example</code> to
                   2639:        <code class="filename">build.conf</code> and edit it, following the
                   2640:        comments in that file.</p>
1.75      rillig   2641: </div>
                   2642: <div class="sect3" lang="en">
                   2643: <div class="titlepage"><div><div><h4 class="title">
1.110     hubertf  2644: <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   2645: </h4></div></div></div>
1.110     hubertf  2646: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.87      wiz      2647:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2648:        details of the default settings. You will want to ensure that
                   2649:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
1.125   ! wiz      2650:        As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
1.104     rillig   2651:        completely bypasses the license check.</p>
1.87      wiz      2652: <pre class="programlisting">
1.100     rillig   2653: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2654: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2655: BSDSRCDIR=      /usr/src
                   2656: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2657: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2658: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2659: PKG_DEVELOPER?= yes
1.125   ! wiz      2660: SKIP_LICENSE_CHECK=    yes
1.100     rillig   2661: </pre>
1.75      rillig   2662: <p>Some options that are especially useful for bulk builds
                   2663:        can be found at the top lines of the file
1.76      rillig   2664:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
1.75      rillig   2665:        options of these are briefly described here.</p>
                   2666: <div class="itemizedlist"><ul type="disc">
                   2667: <li><p>If you are on a slow machine, you may want to
1.87      wiz      2668:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2669:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
1.75      rillig   2670: <li><p>If you are doing bulk builds from a read-only
1.87      wiz      2671:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2672:          to the directory where all log files are created. Otherwise the
                   2673:          log files are created in the pkgsrc directory.</p></li>
1.75      rillig   2674: <li><p>Another important variable is
1.87      wiz      2675:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2676:          should be always available while building other
                   2677:          packages.</p></li>
1.75      rillig   2678: </ul></div>
                   2679: <p>Some other options are scattered in the pkgsrc
                   2680:        infrastructure:</p>
                   2681: <div class="itemizedlist"><ul type="disc">
                   2682: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
1.87      wiz      2683:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2684:          builds is creating binary packages, no matter if they are
                   2685:          vulnerable or not. When uploading the packages to a public
                   2686:          server, the vulnerable packages will be put into a directory of
                   2687:          their own. Leaving this variable unset would prevent the bulk
                   2688:          build system from even trying to build them, so possible
                   2689:          building errors would not show up.</p></li>
1.75      rillig   2690: <li><p><code class="varname">CHECK_FILES</code>
1.93      rillig   2691:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
1.87      wiz      2692:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2693:          matches the <code class="filename">PLIST</code>.</p></li>
1.75      rillig   2694: <li><p><code class="varname">CHECK_INTERPRETER</code>
1.93      rillig   2695:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
1.87      wiz      2696:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2697:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2698:          interpreter.</p></li>
1.91      rillig   2699: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2700:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2701:          package's self-test before installing it. Note that some
                   2702:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2703:          numbers, so you need to assure that the machine on which you
                   2704:          are doing the bulk builds is not completely idle. Otherwise
                   2705:          some test programs will seem to hang, while they are just
                   2706:          waiting for new random data to be
                   2707:          available.</p></li>
1.75      rillig   2708: </ul></div>
                   2709: </div>
                   2710: <div class="sect3" lang="en">
                   2711: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   2712: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.93      rillig   2713: </h4></div></div></div>
1.75      rillig   2714: <p>It is possible to configure the bulk build to perform
1.87      wiz      2715:        certain site-specific tasks at the end of the pre-build
                   2716:        stage.  If the file
                   2717:        <code class="filename">pre-build.local</code> exists in
                   2718:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.110     hubertf  2719:        (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      2720:        stage.  An example use of
                   2721:        <code class="filename">pre-build.local</code> is to have the line:</p>
1.75      rillig   2722: <pre class="screen">echo "I do not have enough disk space to build this pig." \
1.87      wiz      2723:        &gt; misc/openoffice/$BROKENF</pre>
1.75      rillig   2724: <p>to prevent the system from trying to build a particular package
1.87      wiz      2725:        which requires nearly 3 GB of disk space.</p>
1.75      rillig   2726: </div>
                   2727: </div>
                   2728: <div class="sect2" lang="en">
                   2729: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2730: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.76      rillig   2731: <p>As <code class="filename">/usr/pkg</code> will be completely
1.87      wiz      2732:       deleted at the start of bulk builds, make sure your login
                   2733:       shell is placed somewhere else. Either drop it into
                   2734:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2735:       shell in the passwd file), or (re-)install it via
1.110     hubertf  2736:       <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      2737:       you can login after a reboot (remember that your current
                   2738:       process won't die if the package is removed, you just can't
                   2739:       start any new instances of the shell any more).  Also, if you
                   2740:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2741:       version of ssh for some reason, be sure to install ssh before
                   2742:       starting it from <code class="filename">rc.local</code>:</p>
                   2743: <pre class="programlisting">
1.100     rillig   2744: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2745: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2746:   /usr/pkg/etc/rc.d/sshd
                   2747: fi
                   2748: </pre>
1.75      rillig   2749: <p>Not doing so will result in you being not able to log in
1.87      wiz      2750:       via ssh after the bulk build is finished or if the machine
                   2751:       gets rebooted or crashes. You have been warned! :)</p>
1.75      rillig   2752: </div>
                   2753: <div class="sect2" lang="en">
                   2754: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2755: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.75      rillig   2756: <p>Make sure you don't need any of the packages still
1.87      wiz      2757:       installed.</p>
1.75      rillig   2758: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2759: <h3 class="title">Warning</h3>
1.99      rillig   2760: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2761:        configuration files and some more files from
                   2762:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2763:        possibly other locations will be removed! So don't run a bulk
                   2764:        build with privileges that might harm your
                   2765:        system.</em></span></p>
1.75      rillig   2766: </div>
                   2767: <p>Be sure to remove all other things that might
1.87      wiz      2768:       interfere with builds, like some libs installed in
                   2769:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2770: <pre class="screen">
                   2771: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2772: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2773:       </pre>
1.75      rillig   2774: <p>If for some reason your last build didn't complete (power
1.87      wiz      2775:       failure, system panic, ...), you can continue it by
                   2776:       running:</p>
1.75      rillig   2777: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
1.87      wiz      2778: <p>At the end of the bulk build, you will get a summary via mail,
                   2779:       and find build logs in the directory specified by
                   2780:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2781:       file.</p>
1.75      rillig   2782: </div>
                   2783: <div class="sect2" lang="en">
                   2784: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2785: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.75      rillig   2786: <p>The bulk builds consist of three steps:</p>
                   2787: <div class="variablelist"><dl>
                   2788: <dt><span class="term">1. pre-build</span></dt>
1.87      wiz      2789: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2790:            cleans out any broken distfiles, and removes all
                   2791:            packages installed.</p></dd>
1.75      rillig   2792: <dt><span class="term">2. the bulk build</span></dt>
1.87      wiz      2793: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2794:            an optimised order in which packages will be
                   2795:            built. Packages that don't require other packages will
                   2796:            be built first, and packages with many dependencies will
                   2797:            be built later.</p></dd>
1.75      rillig   2798: <dt><span class="term">3. post-build</span></dt>
1.87      wiz      2799: <dd><p>Generates a report that's placed in the directory
                   2800:            specified in the <code class="filename">build.conf</code> file
                   2801:            named <code class="filename">broken.html</code>, a short version
                   2802:            of that report will also be mailed to the build's
                   2803:            admin.</p></dd>
1.75      rillig   2804: </dl></div>
1.87      wiz      2805: <p>During the build, a list of broken packages will be compiled
                   2806:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2807:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2808:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2809:       of broken builds can be found in the package's
                   2810:       directory. These files are used by the bulk-targets to mark
                   2811:       broken builds to not waste time trying to rebuild them, and
                   2812:       they can be used to debug these broken package builds
                   2813:       later.</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="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.75      rillig   2818: <p>Currently, roughly the following requirements are valid for
1.87      wiz      2819:       NetBSD 2.0/i386:</p>
1.75      rillig   2820: <div class="itemizedlist"><ul type="disc">
1.87      wiz      2821: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2822: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2823: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2824: </ul></div>
                   2825: <p>Note that all pkgs will be de-installed as soon as they are
                   2826:       turned into a binary package, and that sources are removed,
                   2827:       so there is no excessively huge demand to disk
                   2828:       space. Afterwards, if the package is needed again, it will
1.110     hubertf  2829:       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      2830:       there are no cycles wasted by recompiling.</p>
1.75      rillig   2831: </div>
                   2832: <div class="sect2" lang="en">
                   2833: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2834: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.87      wiz      2835: <p>If you don't want all the packages nuked from a machine
                   2836:       (rendering it useless for anything but pkg compiling), there
                   2837:       is the possibility of doing the package bulk build inside a
                   2838:       chroot environment.</p>
                   2839: <p>The first step is to set up a chroot sandbox,
                   2840:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2841:       using null mounts, or manually.</p>
                   2842: <p>There is a shell script called
                   2843:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2844:       up the sandbox environment using null mounts. It will also
                   2845:       create a script called <code class="filename">sandbox</code> in the
                   2846:       root of the sandbox environment, which will allow the null
1.110     hubertf  2847:       mounts to be activated using the <span class="command"><strong>sandbox
1.87      wiz      2848:       mount</strong></span> command and deactivated using the
1.110     hubertf  2849:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.87      wiz      2850: <p>To set up a sandbox environment by hand, after extracting all
1.110     hubertf  2851:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.87      wiz      2852:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2853:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2854:       are present and properly configured:</p>
1.75      rillig   2855: <div class="procedure"><ol type="1">
                   2856: <li>
                   2857: <p>Kernel</p>
                   2858: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2859: </li>
                   2860: <li>
1.76      rillig   2861: <p><code class="filename">/dev/*</code></p>
1.75      rillig   2862: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2863: </li>
                   2864: <li>
1.91      rillig   2865: <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   2866: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2867: </li>
                   2868: <li>
                   2869: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2870: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2871: </li>
                   2872: <li>
1.91      rillig   2873: <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   2874: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2875: </li>
                   2876: <li>
1.76      rillig   2877: <p><code class="filename">/usr/src</code> (system sources,
1.125   ! wiz      2878:          e. 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   2879: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
1.87      wiz      2880:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
1.75      rillig   2881: </li>
                   2882: <li>
1.76      rillig   2883: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
1.75      rillig   2884: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2885: </li>
                   2886: <li>
1.76      rillig   2887: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
1.75      rillig   2888: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2889: </li>
                   2890: <li>
                   2891: <p>Checkout pkgsrc via cvs into
1.87      wiz      2892:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2893: <pre class="screen">
                   2894: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2895: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2896:          </pre>
1.75      rillig   2897: <p>Do not mount/link this to the copy of your pkgsrc tree
1.87      wiz      2898:          you do development in, as this will likely cause problems!</p>
1.75      rillig   2899: </li>
                   2900: <li><p>Make
1.87      wiz      2901:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2902:          <code class="filename">.../distfiles</code> point somewhere
                   2903:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.123     snj      2904: <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   2905: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
1.75      rillig   2906: </ol></div>
                   2907: <p>When the chroot sandbox is set up, you can start
1.87      wiz      2908:       the build with the following steps:</p>
                   2909: <pre class="screen">
                   2910: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2911: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2912:       </pre>
                   2913: <p>This will just jump inside the sandbox and start building.  At
                   2914:        the end of the build, mail will be sent with the results of
                   2915:        the build. Created binary pkgs will be in
                   2916:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2917:       (wherever that points/mounts to/from).</p>
1.75      rillig   2918: </div>
                   2919: <div class="sect2" lang="en">
                   2920: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2921: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.87      wiz      2922: <p>In addition to building a complete set of all packages in
                   2923:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2924:       may be used to build a subset of the packages contained in
                   2925:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.110     hubertf  2926:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.75      rillig   2927: <div class="itemizedlist"><ul type="disc">
                   2928: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2929: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2930: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2931: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2932: </ul></div>
1.87      wiz      2933: <p>will define the set of packages which should be built.
                   2934:       The bulk build code will also include any packages which are
                   2935:       needed as dependencies for the explicitly listed packages.</p>
                   2936: <p>One use of this is to do a bulk build with
                   2937:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2938:       periodically to have a complete set of the binary packages
                   2939:       needed for your site available without the overhead of
                   2940:       building extra packages that are not needed.</p>
1.75      rillig   2941: </div>
                   2942: <div class="sect2" lang="en">
                   2943: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   2944: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.87      wiz      2945: <p>This section describes how pkgsrc developers can upload binary
                   2946:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2947: <p>If you would like to automatically create checksum files for the
                   2948:       binary packages you intend to upload, remember to set
                   2949:       <code class="varname">MKSUMS=yes</code> in your
                   2950:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2951: <p>If you would like to PGP sign the checksum files (highly
                   2952:       recommended!), remember to set
                   2953:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2954:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2955:       your GPG password to sign the files before uploading everything.</p>
                   2956: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2957:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2958:       file, i.e. adjust it to something like one of the following:</p>
1.93      rillig   2959: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2960: <p>Please use appropriate values for "packages-200xQy",
1.87      wiz      2961:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2962:       is different from your local login, write your login directly
                   2963:       into the variable, e.g. my local account is "feyrer", but for my
                   2964:       login "hubertf", I use:</p>
1.93      rillig   2965: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
1.87      wiz      2966: <p>A separate <code class="filename">upload</code> directory is used
                   2967:       here to allow "closing" the directory during upload. To do
                   2968:       so, run the following command on ftp.NetBSD.org next:</p>
1.93      rillig   2969: <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      2970: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   2971:       only appropriate for packages for the NetBSD operating
                   2972:       system. Binary packages for other operating systems should go
                   2973:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   2974: <p>Before uploading the binary pkgs, ssh authentication needs
                   2975:       to be set up. This example shows how to set up temporary keys
                   2976:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2977:       (assuming that no keys should be present there usually):</p>
                   2978: <pre class="screen">
                   2979: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
1.75      rillig   2980: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   2981: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
1.87      wiz      2982: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   2983:       </pre>
                   2984: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   2985:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   2986:       file on ftp.NetBSD.org. You can remove the key after the
                   2987:       upload is done!</p>
                   2988: <p>Next, test if your ssh connection really works:</p>
1.75      rillig   2989: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
1.87      wiz      2990: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2991: <p>Now after all this works, you can exit the sandbox and start
                   2992:       the upload:</p>
                   2993: <pre class="screen">
                   2994: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
1.75      rillig   2995: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
1.87      wiz      2996: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2997:       </pre>
1.110     hubertf  2998: <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
                   2999:       <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      3000:       upload. The upload script will take care of not uploading
                   3001:       restricted packages and putting vulnerable packages into the
                   3002:       <code class="filename">vulnerable</code> subdirectory.</p>
                   3003: <p>After the upload has ended, first thing is to revoke ssh access:</p>
1.75      rillig   3004: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
1.87      wiz      3005:       Gdd:x! </pre>
                   3006: <p>Use whatever is needed to remove the key you've entered
                   3007:       before! Last, move the uploaded packages out of the
                   3008:       <code class="filename">upload</code> directory to have them accessible
                   3009:       to everyone:</p>
                   3010: <pre class="screen">
1.93      rillig   3011: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
1.75      rillig   3012: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   3013: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
1.87      wiz      3014: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   3015:       </pre>
1.75      rillig   3016: </div>
                   3017: </div>
                   3018: <div class="sect1" lang="en">
                   3019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3020: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   3021: <p>Running a pbulk-style bulk build works roughly as follows:</p>
                   3022: <div class="itemizedlist"><ul type="disc">
                   3023: <li><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   3024: <li><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
                   3025: </ul></div>
                   3026: <div class="sect2" lang="en">
                   3027: <div class="titlepage"><div><div><h3 class="title">
                   3028: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
1.117     jnemeth  3029: <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   3030: <pre class="screen">
                   3031: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3032: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
                   3033: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
                   3034: </pre>
                   3035: <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>
                   3036: <div class="itemizedlist"><ul type="disc">
                   3037: <li><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
                   3038: <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>
                   3039: <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>
                   3040: <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>
1.125   ! wiz      3041: <li><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
1.116     rillig   3042: </ul></div>
                   3043: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
                   3044: <pre class="screen">
                   3045: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
                   3046: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
                   3047: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
                   3048: </pre>
                   3049: <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>
                   3050: </div>
1.106     rillig   3051: <div class="sect2" lang="en">
                   3052: <div class="titlepage"><div><div><h3 class="title">
1.116     rillig   3053: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.114     jmcneill 3054: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.116     rillig   3055: <p>TODO: continue writing</p>
1.106     rillig   3056: </div>
                   3057: </div>
                   3058: <div class="sect1" lang="en">
                   3059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3060: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      3061: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3062:     create a CD-ROM set of the resulting binary packages to assist
                   3063:     in installing packages on other machines.  The
1.91      rillig   3064:     <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      3065:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  3066:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      3067:     way that keeps all the dependencies for a given package on the same
                   3068:     CD as that package.</p>
1.75      rillig   3069: <div class="sect2" lang="en">
                   3070: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3071: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      3072: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3073:       man page. The following short example assumes that the binary
                   3074:       packages are left in
                   3075:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3076:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3077:       hold the ISO 9660 images.</p>
                   3078: <pre class="screen">
                   3079: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   3080: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      3081: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3082:       </pre>
                   3083: <p>If you wish to include a common set of files
                   3084:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3085:       etc.) on each CD in the collection, then you need to create a
                   3086:       directory which contains these files. e.g.</p>
                   3087: <pre class="screen">
                   3088: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   3089: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3090: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3091: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3092: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3093: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      3094: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3095:       </pre>
1.75      rillig   3096: <p>Now create the images:</p>
                   3097: <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   3098: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      3099:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3100:       in their root directories.</p>
1.75      rillig   3101: </div>
                   3102: </div>
                   3103: </div>
                   3104: <div class="chapter" lang="en">
                   3105: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3106: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   3107: <div class="toc">
                   3108: <p><b>Table of Contents</b></p>
                   3109: <dl>
1.123     snj      3110: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
                   3111: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.90      rillig   3112: </dl>
                   3113: </div>
                   3114: <p>The files that are installed by pkgsrc are organized in a way that
                   3115: is similar to what you find in the <code class="filename">/usr</code> directory
                   3116: of the base system. But some details are different. This is because
                   3117: pkgsrc initially came from FreeBSD and had adopted its file system
                   3118: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3119: which operating system you are using pkgsrc with, you can expect the
                   3120: same layout for pkgsrc.</p>
1.91      rillig   3121: <p>There are mainly four root directories for pkgsrc, which are all
                   3122: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3123: When pkgsrc has been installed as root, the default locations
                   3124: are:</p>
                   3125: <pre class="programlisting">
1.100     rillig   3126: LOCALBASE=              /usr/pkg
                   3127: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3128: VARBASE=                /var
                   3129: PKG_DBDIR=              /var/db/pkg
1.91      rillig   3130: </pre>
                   3131: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3132: user), the default locations are:</p>
                   3133: <pre class="programlisting">
1.100     rillig   3134: LOCALBASE=              ${HOME}/pkg
                   3135: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3136: VARBASE=                ${HOME}/pkg/var
                   3137: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   3138: </pre>
                   3139: <p>What these four directories are for, and what they look like is
                   3140: explained below.</p>
1.90      rillig   3141: <div class="itemizedlist"><ul type="disc">
                   3142: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3143: <code class="filename">/usr</code> directory in the base system. It is the
                   3144: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3145: the well-known subdirectories like <code class="filename">bin</code>,
                   3146: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3147: <code class="filename">share</code> and
                   3148: <code class="filename">sbin</code>.</p></li>
                   3149: <li><p><code class="varname">VARBASE</code> corresponds to
                   3150: <code class="filename">/var</code> in the base system. Some programs (especially
                   3151: games, network daemons) need write access to it during normal
                   3152: operation.</p></li>
                   3153: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3154: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  3155: 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   3156: itself.</p></li>
                   3157: </ul></div>
                   3158: <div class="sect1" lang="en">
                   3159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3160: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   3161: </h2></div></div></div>
1.90      rillig   3162: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   3163: in <code class="filename">${LOCALBASE}</code>.</p>
1.90      rillig   3164: <div class="variablelist"><dl>
                   3165: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3166: <dd><p>Contains executable programs that are intended to be
                   3167: directly used by the end user.</p></dd>
                   3168: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3169: <dd><p>Contains files for the emulation layers of various other
                   3170: operating systems, especially for
                   3171: NetBSD.</p></dd>
                   3172: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3173: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3174: <dd><p>Contains
                   3175: the configuration files.</p></dd>
                   3176: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3177: <dd><p>Contains headers for the C and C++ programming
                   3178: languages.</p></dd>
                   3179: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3180: <dd><p>Contains GNU info files of various
                   3181: packages.</p></dd>
                   3182: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3183: <dd><p>Contains shared and static
                   3184: libraries.</p></dd>
                   3185: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3186: <dd><p>Contains data files that don't change after
                   3187: installation. Other data files belong into
                   3188: <code class="filename">${VARBASE}</code>.</p></dd>
                   3189: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3190: <dd><p>Contains programs that are not intended to be used by
                   3191: end users, such as helper programs or network
                   3192: daemons.</p></dd>
                   3193: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3194: <dd><p>Contains programs that are intended to be executed as
                   3195: CGI scripts by a web server.</p></dd>
                   3196: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3197: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3198: <dd><p>Contains brief
                   3199: documentation in form of manual pages.</p></dd>
                   3200: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3201: <dd><p>Contains programs that are intended to be used only by
                   3202: the super-user.</p></dd>
                   3203: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3204: <dd><p>Contains platform-independent data files that don't
                   3205: change after installation.</p></dd>
                   3206: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3207: <dd><p>Contains documentation files provided by the
                   3208: packages.</p></dd>
                   3209: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3210: <dd><p>Contains example files provided by the packages. Among
                   3211: others, the original configuration files are saved here and copied to
                   3212: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3213: installation.</p></dd>
                   3214: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3215: <dd><p>Contains the original files for rc.d
                   3216: scripts.</p></dd>
                   3217: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3218: <code class="filename">${VARBASE}</code>)</span></dt>
                   3219: <dd><p>Contains files
                   3220: that may be modified after
                   3221: installation.</p></dd>
                   3222: </dl></div>
                   3223: </div>
                   3224: <div class="sect1" lang="en">
                   3225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3226: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   3227: </h2></div></div></div>
1.90      rillig   3228: <div class="variablelist"><dl>
                   3229: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3230: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3231: <dd><p>Contains
                   3232: information about the currently installed
                   3233: packages.</p></dd>
                   3234: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3235: <dd><p>Contains highscore
                   3236: files.</p></dd>
                   3237: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3238: <dd><p>Contains log files.</p></dd>
                   3239: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3240: <dd><p>Contains informational files about daemons that are
                   3241: currently running.</p></dd>
                   3242: </dl></div>
                   3243: </div>
                   3244: </div>
                   3245: <div class="chapter" lang="en">
                   3246: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3247: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   3248: <div class="toc">
                   3249: <p><b>Table of Contents</b></p>
                   3250: <dl>
1.106     rillig   3251: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3252: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3253: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3254: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3255: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3256: <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>
                   3257: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.123     snj      3258: <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   3259: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.123     snj      3260: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
                   3261: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
                   3262: <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   3263: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3264: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3265: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.123     snj      3266: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.106     rillig   3267: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.123     snj      3268: <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   3269: </dl>
                   3270: </div>
                   3271: <p>This section contains hints, tips &amp; tricks on special things in
                   3272: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3273: it contains items for both pkgsrc users and developers.</p>
                   3274: <div class="sect1" lang="en">
                   3275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3276: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   3277: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3278: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  3279: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   3280:          This is a general purpose list for most issues regarding
                   3281:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3282:          for pkgsrc configuration, unexpected build failures, using
                   3283:          particular packages, upgrading pkgsrc installations,
                   3284:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3285:          proposals for changes that impact the pkgsrc user community,
                   3286:          e.g. major infrastructure changes, new features, package
                   3287:          removals, etc., may also be posted.</p></li>
1.110     hubertf  3288: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   3289:          A list where the results of pkgsrc bulk builds are sent and
                   3290:          discussed.</p></li>
1.110     hubertf  3291: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   3292:          This list is for those who are interested in getting a
                   3293:          commit message for every change committed to pkgsrc. It is
                   3294:          also available in digest form, meaning one daily message
                   3295:          containing all commit messages for changes to the package
                   3296:          source tree in that 24 hour period.</p></li>
                   3297: </ul></div>
                   3298: <p>To subscribe, do:</p>
                   3299: <pre class="programlisting">
1.100     rillig   3300: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   3301: </pre>
                   3302: <p>Archives for all these mailing lists are available from
1.110     hubertf  3303: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   3304: </div>
                   3305: <div class="sect1" lang="en">
                   3306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3307: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.75      rillig   3308: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3309: pkgviews User's guide in
1.76      rillig   3310: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
1.75      rillig   3311: </div>
                   3312: <div class="sect1" lang="en">
                   3313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3314: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   3315: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   3316: a number of useful utilities for both users and developers of pkgsrc.  This
                   3317: section attempts only to make the reader aware of the utilities and when
                   3318: they might be useful, and not to duplicate the documentation that comes
                   3319: with each package.</p>
                   3320: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.91      rillig   3321: <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   3322:       Symlinks for use by buildlink.</p></li></ul></div>
                   3323: <p>OS tool augmentation (automatically installed when needed):</p>
                   3324: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3325: <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   3326:       Calculates various kinds of checksums (including SHA1).</p></li>
1.91      rillig   3327: <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   3328:       Compatibility library for pkgsrc tools.</p></li>
1.91      rillig   3329: <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      3330:       non-BSD systems due to lack of native mtree.</p></li>
1.91      rillig   3331: <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   3332:       Up-to-date replacement for
1.76      rillig   3333:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   3334:       systems where pkg_install is not present.</p></li>
                   3335: </ul></div>
                   3336: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3337: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3338: <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   3339:       Create a binary package from an
1.110     hubertf  3340:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   3341:       save the old package.</p></li>
1.91      rillig   3342: <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   3343:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3344:       from multiple locations. It currently supports the following
                   3345:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.91      rillig   3346: <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   3347:       packages someplace else (enabled by default).</p></li>
1.117     jnemeth  3348: <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
                   3349:       the best compiler flags to optimise code for your current
                   3350:       CPU and compiler. Setting <code class="varname">USE_CPUFLAGS</code> to
                   3351:       yes in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use
                   3352:       cpuflags. </p></li>
1.75      rillig   3353: </ul></div>
                   3354: <p>Utilities for keeping track of installed packages, being up to date,
                   3355: etc:</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/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   3358:       packages whose installed versions do not match the latest pkgsrc
                   3359:       entries.</p></li>
1.91      rillig   3360: <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   3361:       dependency graphs of packages, to aid in choosing a strategy for
                   3362:       updating.</p></li>
1.91      rillig   3363: <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
                   3364:       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>
                   3365: <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   3366:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
                   3367: <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   3368:       does various checks on the complete pkgsrc system.</p></li>
1.91      rillig   3369: <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   3370:       packages you have installed.</p></li>
                   3371: </ul></div>
                   3372: <p>Utilities for people maintaining or creating individual packages:</p>
                   3373: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3374: <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   3375:       making and maintaining patches for a package (includes pkgdiff,
                   3376:       pkgvi, mkpatches, etc.).</p></li>
1.91      rillig   3377: <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>,
                   3378:       <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   3379:       converting to pkgsrc.</p></li>
1.91      rillig   3380: <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   3381:       pkgsrc to a Solaris package.</p></li>
                   3382: </ul></div>
                   3383: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3384: utilities)</p>
                   3385: <div class="itemizedlist"><ul type="disc">
1.91      rillig   3386: <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   3387:       packages in a chrooted area.</p></li>
1.91      rillig   3388: <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   3389:       kernel version for chrooted cross builds.</p></li>
                   3390: </ul></div>
                   3391: </div>
                   3392: <div class="sect1" lang="en">
                   3393: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3394: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.75      rillig   3395: <p>If you want to use pkgsrc as non-root user, you can set some
                   3396: variables to make pkgsrc work under these conditions.  At the very least,
                   3397: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3398: will turn on unprivileged mode and set multiple related variables to allow
                   3399: installation of packages as non-root.</p>
                   3400: <p>In case the defaults are not enough, you may want to tune some other
                   3401: variables used.  For example, if the automatic user/group detection leads
                   3402: to incorrect values (or not the ones you would like to use), you can change
                   3403: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3404: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3405: <p>As regards bootstrapping, please note that the
1.110     hubertf  3406: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.75      rillig   3407: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
1.76      rillig   3408: use multiple default directories under <code class="filename">~/pkg</code> as the
1.93      rillig   3409: installation targets.  These directories can be overridden by the
1.75      rillig   3410: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3411: that allow finer tuning of the tree layout.</p>
                   3412: </div>
                   3413: <div class="sect1" lang="en">
                   3414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3415: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3416: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3417: enable this feature by adding the option
                   3418: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  3419: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   3420: distfile is found, pkgsrc will try to resume it.</p>
                   3421: <p>You can also
1.110     hubertf  3422: 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  3423: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3424: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3425: by using the value manual.  A value of custom disables the system defaults
                   3426: and dependency tracking for the fetch program.  In that case you have to
                   3427: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3428: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3429: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   3430: <p>For example, if you want to use
1.117     jnemeth  3431: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   3432: like:</p>
                   3433: <pre class="programlisting">
1.117     jnemeth  3434: FETCH_USING=   wget
1.1       grant    3435: </pre>
1.75      rillig   3436: </div>
                   3437: <div class="sect1" lang="en">
                   3438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3439: <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      3440: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3441: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3442: you will have to add the following line into
1.110     hubertf  3443: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3444: <pre class="programlisting">
1.103     wiz      3445: X11_TYPE=modular
1.1       grant    3446: </pre>
1.75      rillig   3447: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3448: <h3 class="title">Note</h3>
1.103     wiz      3449: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3450: </p>
1.75      rillig   3451: </div>
                   3452: </div>
                   3453: <div class="sect1" lang="en">
                   3454: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3455: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3456: <p>If you are sitting behind a firewall which does not allow direct
                   3457: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3458: relevant proxy hosts.  This is done using an environment variable in the
                   3459: form of a URL, e.g. in Amdahl, the machine
                   3460: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3461: port 80 as the proxy port number.  So the proxy environment variables
                   3462: are:</p>
                   3463: <pre class="programlisting">
1.100     rillig   3464: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3465: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3466: </pre>
1.75      rillig   3467: </div>
                   3468: <div class="sect1" lang="en">
                   3469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  3470: <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   3471: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3472: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3473: the first available command from the following list:</p>
                   3474: <div class="itemizedlist"><ul type="disc">
1.76      rillig   3475: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3476: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3477: </ul></div>
                   3478: <p>On a default NetBSD installation, this will be
1.76      rillig   3479: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3480: connections first, and falls back to active connections if the server
                   3481: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3482: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3483: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3484: <p>Having that option present will prevent
1.76      rillig   3485: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3486: transfers.</p>
                   3487: </div>
                   3488: <div class="sect1" lang="en">
                   3489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3490: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3491: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3492: from work or university, where you can't run a <span class="command"><strong>make
                   3493: 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   3494: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3495: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3496: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3497: resulting list to your machine at work/school and use it there.  If you
1.110     hubertf  3498: 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   3499: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3500: URL:</p>
                   3501: <p>At home:</p>
                   3502: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3503: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3504: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3505: <p>At work:</p>
                   3506: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3507: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3508: home.</p>
                   3509: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3510: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3511: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3512: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3513: directly by running:</p>
1.75      rillig   3514: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3515: <p>If you even decide to ignore
                   3516: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3517: by running:</p>
                   3518: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3519: </div>
                   3520: <div class="sect1" lang="en">
                   3521: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3522: <a name="tmac.andoc-missing"></a>9.10. What does &#8220;<span class="quote">Don't know how to make
1.75      rillig   3523: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
1.91      rillig   3524: <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   3525: package, you get the error from make that it doesn't know how to make
1.76      rillig   3526: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.75      rillig   3527: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3528: the NetBSD base distribution on your machine.  It is recommended to do
                   3529: that to format man pages.</p>
1.91      rillig   3530: <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   3531: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3532: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3533: </div>
                   3534: <div class="sect1" lang="en">
                   3535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3536: <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      3537: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3538: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3539: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3540: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3541: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3542: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3543: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3544: -r</strong></span>).</p>
                   3545: </div>
                   3546: <div class="sect1" lang="en">
                   3547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3548: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3549: <p>When installing packages as non-root user and using the just-in-time
1.110     hubertf  3550: <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   3551: password for each required package installed.  To avoid this, the sudo
                   3552: package can be used, which does password caching over a limited time.  To
                   3553: use it, install sudo (either as binary package or from
1.98      wiz      3554: <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  3555: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3556: <span class="emphasis"><em>after</em></span> the definition of the
                   3557: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3558: <pre class="programlisting">
1.100     rillig   3559: .if exists(${LOCALBASE}/bin/sudo)
                   3560: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3561: .endif
1.1       grant    3562: </pre>
1.75      rillig   3563: </div>
                   3564: <div class="sect1" lang="en">
                   3565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3566: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3567: <p>As the system administrator, you can choose where configuration files
                   3568: are installed.  The default settings make all these files go into
1.76      rillig   3569: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3570: be suboptimal depending on your expectations (e.g., a read-only,
                   3571: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3572: configuration of the provided packages).</p>
                   3573: <p>In order to change the defaults, you can modify the
                   3574: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3575: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3576: directory; some common examples include <code class="filename">/etc</code> or
                   3577: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3578: <p>Furthermore, you can change this value on a per-package basis by
                   3579: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3580: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3581: package you would like to modify, that is, the contents of
                   3582: <code class="varname">PKGBASE</code>.</p>
                   3583: <p>Note that after changing these settings, you must rebuild and
                   3584: reinstall any affected packages.</p>
                   3585: </div>
                   3586: <div class="sect1" lang="en">
                   3587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3588: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   3589: <p>Please be aware that there can often be bugs in third-party software,
                   3590: and some of these bugs can leave a machine vulnerable to exploitation by
                   3591: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3592: maintains a database of known-exploits to packages which have at one time
                   3593: been included in pkgsrc.  The database can be downloaded automatically, and
                   3594: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3595: do this, refer to the following two tools (installed as part of the
                   3596: <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   3597: <div class="orderedlist"><ol type="1">
                   3598: <li>
1.122     reed     3599: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3600:     download a list of the security vulnerabilities information.  This list
                   3601:     is kept up to date by the NetBSD security officer and the NetBSD
                   3602:     packages team, and is distributed from the NetBSD ftp server:</p>
1.110     hubertf  3603: <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   3604: </li>
1.122     reed     3605: <li><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
1.75      rillig   3606:     current machine, checking each vulnerability which is known.  If a
                   3607:     vulnerable package is installed, it will be shown by output to stdout,
                   3608:     including a description of the type of vulnerability, and a URL
                   3609:     containing more information.</p></li>
                   3610: </ol></div>
1.114     jmcneill 3611: <p>Use of these tools is strongly recommended!  After
                   3612: &#8220;<span class="quote">pkg_install</span>&#8221; is installed, please read
1.75      rillig   3613: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114     jmcneill 3614: pkg_install</code></strong>.</p>
1.87      wiz      3615: <p>If this package is installed, pkgsrc builds will use it to
1.110     hubertf  3616: 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      3617: check.</p>
1.75      rillig   3618: </div>
                   3619: <div class="sect1" lang="en">
                   3620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3621: <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   3622: <p>When you add your own preferences to the
                   3623:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3624:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3625:        environment variables to the <code class="filename">./configure</code>
1.110     hubertf  3626:        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   3627:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3628:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3629:        package.</p>
                   3630: <p>Currently there is no solution to this problem. If you
                   3631:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3632:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3633:        directory and then inspect any <code class="filename">Makefile</code> and
                   3634:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3635:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3636:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3637:        programmers write so bad code that it only works for the
                   3638:        specific combination of <code class="varname">CFLAGS</code> they have
                   3639:        chosen.</p>
                   3640: </div>
1.80      rillig   3641: <div class="sect1" lang="en">
                   3642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3643: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.80      rillig   3644: <div class="procedure"><ol type="1">
                   3645: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3646:        case that occurs often is that people only update pkgsrc in
                   3647:        parts, because of performance reasons. Since pkgsrc is one large
                   3648:        system, not a collection of many small systems, there are
                   3649:        sometimes changes that only work when the whole pkgsrc tree is
                   3650:        updated.</p></li>
                   3651: <li><p>Make sure that you don't have any CVS conflicts.
                   3652:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3653:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3654:        files.</p></li>
                   3655: <li><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3656:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3657:        verify this.</p></li>
                   3658: <li><p>If the problem still exists, write a mail to the
                   3659:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3660: </ol></div>
                   3661: </div>
1.88      wiz      3662: <div class="sect1" lang="en">
                   3663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3664: <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   3665: <p>You have modified a file from pkgsrc, and someone else has
                   3666: modified that same file afterwards in the CVS repository. Both changes
                   3667: are in the same region of the file, so when you updated pkgsrc, the
                   3668: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3669: file. Because of these markers, the file is no longer a valid
                   3670: <code class="filename">Makefile</code>.</p>
                   3671: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3672: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3673: -dP</strong></span> in that directory to download the current version.</p>
                   3674: </div>
1.75      rillig   3675: </div>
                   3676: </div>
                   3677: <div class="part" lang="en">
                   3678: <div class="titlepage"><div><div><h1 class="title">
                   3679: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.77      rillig   3680: <div class="partintro" lang="en">
                   3681: <div></div>
                   3682: <p>This part of the book deals with creating and
                   3683:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3684:        guide on creating a new package. The remaining chapters are more
                   3685:        like a reference manual for pkgsrc.</p>
1.75      rillig   3686: <div class="toc">
                   3687: <p><b>Table of Contents</b></p>
                   3688: <dl>
1.106     rillig   3689: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3690: <dd><dl>
1.106     rillig   3691: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3692: <dd><dl>
1.106     rillig   3693: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3694: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil     3695: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3696: </dl></dd>
1.106     rillig   3697: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3698: <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>
                   3699: </dl></dd>
                   3700: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3701: <dd><dl>
1.123     snj      3702: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
                   3703: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106     rillig   3704: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3705: <dd><dl>
                   3706: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3707: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3708: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3709: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3710: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3711: </dl></dd>
                   3712: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3713: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3714: <dd><dl>
                   3715: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3716: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3717: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3718: </dl></dd>
1.123     snj      3719: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
                   3720: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.106     rillig   3721: </dl></dd>
1.123     snj      3722: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.106     rillig   3723: <dd><dl>
                   3724: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.123     snj      3725: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106     rillig   3726: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3727: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3728: <dd><dl>
                   3729: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3730: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3731: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3732: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3733: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3734: </dl></dd>
                   3735: </dl></dd>
                   3736: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3737: <dd><dl>
                   3738: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.123     snj      3739: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
                   3740: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106     rillig   3741: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3742: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.123     snj      3743: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106     rillig   3744: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3745: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3746: </dl></dd>
                   3747: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3748: <dd><dl>
                   3749: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.123     snj      3750: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.106     rillig   3751: <dd><dl>
                   3752: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.123     snj      3753: <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   3754: </dl></dd>
1.123     snj      3755: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.106     rillig   3756: <dd><dl>
1.123     snj      3757: <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   3758: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3759: </dl></dd>
                   3760: </dl></dd>
                   3761: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3762: <dd><dl>
                   3763: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3764: <dd><dl>
                   3765: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3766: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3767: </dl></dd>
                   3768: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3769: <dd><dl>
1.123     snj      3770: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106     rillig   3771: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3772: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3773: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3774: </dl></dd>
                   3775: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3776: <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>
                   3777: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3778: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3779: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3780: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3781: <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>
                   3782: </dl></dd>
                   3783: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3784: <dd><dl>
                   3785: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.123     snj      3786: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106     rillig   3787: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   3788: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3789: </dl></dd>
                   3790: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3791: <dd><dl>
                   3792: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3793: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3794: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3795: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.123     snj      3796: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106     rillig   3797: <dd><dl>
                   3798: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3799: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3800: </dl></dd>
1.123     snj      3801: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
                   3802: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
                   3803: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
                   3804: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
                   3805: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
                   3806: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
                   3807: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
                   3808: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
                   3809: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
                   3810: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106     rillig   3811: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3812: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3813: </dl></dd>
                   3814: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3815: <dd><dl>
                   3816: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3817: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3818: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3819: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3820: </dl></dd>
                   3821: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3822: <dd><dl>
                   3823: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3824: <dd><dl>
                   3825: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.123     snj      3826: <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   3827: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3828: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3829: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3830: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3831: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3832: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3833: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3834: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3835: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3836: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3837: </dl></dd>
1.123     snj      3838: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106     rillig   3839: <dd><dl>
                   3840: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3841: <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>
                   3842: </dl></dd>
1.123     snj      3843: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106     rillig   3844: <dd><dl>
                   3845: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3846: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3847: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3848: </dl></dd>
                   3849: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3850: <dd><dl>
                   3851: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3852: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3853: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   3854: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   3855: </dl></dd>
1.123     snj      3856: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106     rillig   3857: <dd><dl>
                   3858: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3859: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.123     snj      3860: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106     rillig   3861: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3862: </dl></dd>
1.123     snj      3863: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106     rillig   3864: <dd><dl>
                   3865: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3866: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3867: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3868: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3869: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3870: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3871: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3872: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   3873: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   3874: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   3875: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3876: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3877: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3878: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3879: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3880: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3881: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3882: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      3883:     emulation</a></span></dt>
1.106     rillig   3884: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3885: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3886: </dl></dd>
1.106     rillig   3887: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3888: </dl></dd>
1.106     rillig   3889: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3890: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   3891: <dd><dl>
1.106     rillig   3892: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3893: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3894: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3895: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   3896: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     3897: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   3898: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig   3899: </dl></dd>
                   3900: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3901: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3902: <dd><dl>
                   3903: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3904: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3905: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3906: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     3907: </dl></dd>
1.75      rillig   3908: </dl>
                   3909: </div>
1.77      rillig   3910: </div>
                   3911: <div class="chapter" lang="en">
                   3912: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3913: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3914: <div class="toc">
                   3915: <p><b>Table of Contents</b></p>
                   3916: <dl>
1.106     rillig   3917: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3918: <dd><dl>
1.106     rillig   3919: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3920: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.118     imil     3921: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3922: </dl></dd>
1.106     rillig   3923: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3924: <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   3925: </dl>
                   3926: </div>
1.77      rillig   3927: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3928: most likely have a URL from where you can download the source
                   3929: code. Starting with this URL, creating a package involves only a
                   3930: few steps.</p>
1.77      rillig   3931: <div class="procedure"><ol type="1">
1.91      rillig   3932: <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   3933: <li><p>Then, choose one of the top-level directories as the
1.91      rillig   3934: category in which you want to place your package. You can also create a
                   3935: directory of your own (maybe called <code class="filename">local</code>). In that
                   3936: category directory, create another directory for your package and change
                   3937: into it.</p></li>
1.110     hubertf  3938: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3939: you for a URL. Enter the URL of the distribution file (in most cases a
                   3940: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3941: of your package are created automatically. The distribution file is
                   3942: extracted automatically to fill in some details in the
                   3943: <code class="filename">Makefile</code> that would otherwise have to be done
                   3944: manually.</p></li>
                   3945: <li>
                   3946: <p>Examine the extracted files to determine the dependencies of
                   3947: your package. Ideally, this is mentioned in some
                   3948: <code class="filename">README</code> file, but things may differ. For each of
                   3949: these dependencies, look where it exists in pkgsrc, and if there is a
                   3950: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3951: line to your package <code class="filename">Makefile</code> which includes that
                   3952: file just before the last line. If the
                   3953: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3954: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3955: version of the dependency and where it can be found in pkgsrc. This line
                   3956: should be placed in the third paragraph. If the dependency is only
                   3957: needed for building the package, but not when using it, use
                   3958: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3959: Your package may then look like this:</p>
1.77      rillig   3960: <pre class="programlisting">
1.100     rillig   3961: [...]
1.77      rillig   3962: 
1.100     rillig   3963: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3964: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3965: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3966: 
1.100     rillig   3967: [...]
1.77      rillig   3968: 
1.100     rillig   3969: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3970: .include "../../devel/glib2/buildlink3.mk"
                   3971: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3972: </pre>
                   3973: </li>
1.110     hubertf  3974: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.91      rillig   3975: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
1.110     hubertf  3976: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3977: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3978: -e</strong></span>, which outputs additional
                   3979: explanations.</p></li>
                   3980: <li><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3981: 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   3982: over there, you can hopefully continue here.</p></li>
1.110     hubertf  3983: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3984: directory from the extracted files. Besides these files, a lot of cache
                   3985: files and other system information has been saved in the working
                   3986: directory, which may become wrong after you edited the
                   3987: <code class="filename">Makefile</code>.</p></li>
1.110     hubertf  3988: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   3989: 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   3990: <li><p>When the package builds fine, the next step is to install
1.110     hubertf  3991: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3992: everything works.</p></li>
                   3993: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3994: contains a list of the files that are installed by the package, is
1.110     hubertf  3995: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3996: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3997: the file using your preferred text editor to see if the list of
                   3998: files looks plausible.</p></li>
1.110     hubertf  3999: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   4000: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.110     hubertf  4001: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   4002: has been registered in the database of installed files, but with an
1.110     hubertf  4003: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   4004: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   4005: registered with the list of files from
                   4006: <code class="filename">PLIST</code>.</p></li>
1.110     hubertf  4007: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   4008: package from the set of installed files.</p></li>
1.77      rillig   4009: </ol></div>
1.91      rillig   4010: <div class="sect1" lang="en">
                   4011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4012: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.91      rillig   4013: <div class="sect2" lang="en">
                   4014: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4015: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   4016: <p>Simple Perl modules are handled automatically by
1.110     hubertf  4017: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   4018: </div>
                   4019: <div class="sect2" lang="en">
                   4020: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4021: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.91      rillig   4022: <p>KDE applications should always include
                   4023: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   4024: settings that are typical of KDE packages.</p>
                   4025: </div>
1.118     imil     4026: <div class="sect2" lang="en">
                   4027: <div class="titlepage"><div><div><h3 class="title">
                   4028: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   4029: <p>Python modules and programs packages are easily created using a
                   4030: set of predefined variables.</p>
                   4031: <p>Most Python packages use either &#8220;<span class="quote">distutils</span>&#8221; or
                   4032: easy-setup (&#8220;<span class="quote">eggs</span>&#8221;).
                   4033: If the software uses &#8220;<span class="quote">distutils</span>&#8221;, set the
                   4034: <code class="varname">PYDISTUTILSPKG</code> variable to &#8220;<span class="quote">yes</span>&#8221; so
                   4035: pkgsrc will make use of this framework.
                   4036: &#8220;<span class="quote">distutils</span>&#8221; uses a script called <code class="filename">setup.py</code>,
                   4037: if the &#8220;<span class="quote">distutils</span>&#8221; driver is not called
                   4038: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   4039: to the name of the script.</p>
                   4040: <p>
                   4041: If the default Python versions are not supported by the software, set the
                   4042: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
                   4043: the software is known to work with, from the most recent to the older
                   4044: one, e.g.
                   4045: </p>
                   4046: <pre class="programlisting">
                   4047: PYTHON_VERSIONS_ACCEPTED=       25 24 23
                   4048: </pre>
                   4049: <p>
                   4050: If the packaged software is a Python module, include
                   4051: &#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;.
                   4052: In this case, the package directory should be called
                   4053: &#8220;<span class="quote">py-software</span>&#8221; and <code class="varname">PKGNAME</code> should be set to
                   4054: &#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;, e.g.
                   4055: </p>
                   4056: <pre class="programlisting">
                   4057: DISTNAME=   foopymodule-1.2.10
                   4058: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   4059: </pre>
                   4060: <p>If it is an application, also include
                   4061: &#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;
                   4062: before &#8220;<span class="quote">extension.mk</span>&#8221;.</p>
                   4063: <p>If the packaged software, either it is an application or a module, is
                   4064: egg-aware, you only need to include
                   4065: &#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;.</p>
                   4066: <p>In order to correctly set the path to the Python interpreter, use the
                   4067: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   4068: that must be corrected. For example :
                   4069: </p>
                   4070: <pre class="programlisting">
                   4071: REPLACE_PYTHON=   ${WRKSRC}/*.py
                   4072: </pre>
                   4073: </div>
1.91      rillig   4074: </div>
                   4075: <div class="sect1" lang="en">
                   4076: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4077: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.91      rillig   4078: <div class="sect2" lang="en">
                   4079: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4080: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.91      rillig   4081: <div class="sect3" lang="en">
                   4082: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4083: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   4084: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   4085: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   4086: pkgsrc. As the description says it has to do with the web, the obvious
                   4087: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   4088: <pre class="programlisting">
1.100     rillig   4089: <code class="prompt">$</code> mkdir www/nvu
                   4090: <code class="prompt">$</code> cd www/nvu
1.91      rillig   4091: </pre>
                   4092: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  4093: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   4094: <pre class="programlisting">
1.100     rillig   4095: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   4096: </pre>
                   4097: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4098: below the <code class="varname">DISTNAME</code> line, as the package name should
                   4099: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   4100: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4101: <code class="varname">COMMENT</code> fields. Then the package
                   4102: <code class="filename">Makefile</code> looked like that:</p>
                   4103: <pre class="programlisting">
1.100     rillig   4104: # $NetBSD$
                   4105: #
1.91      rillig   4106: 
1.100     rillig   4107: DISTNAME=       nvu-1.0-sources
                   4108: PKGNAME=        nvu-1.0
                   4109: CATEGORIES=     www
                   4110: MASTER_SITES=   http://cvs.nvu.com/download/
                   4111: EXTRACT_SUFX=   .tar.bz2
                   4112: 
                   4113: MAINTAINER=     rillig@NetBSD.org
                   4114: HOMEPAGE=       http://cvs.nvu.com/
                   4115: COMMENT=        Web Authoring System
1.91      rillig   4116: 
1.100     rillig   4117: # url2pkg-marker (please do not remove this line.)
                   4118: .include "../../mk/bsd.pkg.mk"
1.91      rillig   4119: </pre>
                   4120: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4121: source archive:</p>
                   4122: <pre class="programlisting">
1.100     rillig   4123: url2pkg&gt; Running "make makesum" ...
                   4124: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4125: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4126: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4127: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4128: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4129: url2pkg&gt; Running "make extract" ...
                   4130: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4131: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4132: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4133: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4134: ===&gt; Installing dependencies for nvu-1.0
                   4135: ===&gt; Overriding tools for nvu-1.0
                   4136: ===&gt; Extracting for nvu-1.0
                   4137: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   4138: 
1.100     rillig   4139: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   4140: 
1.100     rillig   4141: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   4142: </pre>
                   4143: </div>
                   4144: <div class="sect3" lang="en">
                   4145: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4146: <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   4147: <p>Now that the package has been extracted, let's see what's inside
                   4148: it. The package has a <code class="filename">README.txt</code>, but that only
                   4149: says something about mozilla, so it's probably useless for seeing what
                   4150: dependencies this package has. But since there is a GNU configure script
                   4151: in the package, let's hope that it will complain about everything it
                   4152: needs.</p>
                   4153: <pre class="programlisting">
1.100     rillig   4154: <code class="prompt">$</code> bmake
                   4155: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4156: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4157: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4158: ===&gt; Patching for nvu-1.0
                   4159: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4160: ===&gt; Configuring for nvu-1.0
                   4161: [...]
                   4162: configure: error: Perl 5.004 or higher is required.
                   4163: [...]
                   4164: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4165: [...]
1.91      rillig   4166: </pre>
                   4167: <p>That worked quite well. So I opened the package Makefile in my
                   4168: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4169: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4170: package have changed now, and since a perl wrapper is automatically
                   4171: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4172: from scratch.</p>
                   4173: <pre class="programlisting">
1.100     rillig   4174: <code class="prompt">$</code> bmake clean
                   4175: ===&gt; Cleaning for nvu-1.0
                   4176: <code class="prompt">$</code> bmake
                   4177: [...]
                   4178: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4179: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4180: [...]
1.91      rillig   4181: </pre>
                   4182: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4183: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4184: <pre class="programlisting">
1.100     rillig   4185: [...]
                   4186: checking for GTK - version &gt;= 1.2.0... no
                   4187: *** Could not run GTK test program, checking why...
                   4188: [...]
1.91      rillig   4189: </pre>
                   4190: <p>Now to the other dependencies. The first question is: Where is the
                   4191: GTK package hidden in pkgsrc?</p>
                   4192: <pre class="programlisting">
1.100     rillig   4193: <code class="prompt">$</code> echo ../../*/gtk*
                   4194: [many packages ...]
                   4195: <code class="prompt">$</code> echo ../../*/gtk
                   4196: ../../x11/gtk
                   4197: <code class="prompt">$</code> echo ../../*/gtk2
                   4198: ../../x11/gtk2
                   4199: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4200: ../../x11/gtk2/buildlink3.mk
1.91      rillig   4201: </pre>
                   4202: <p>The first try was definitely too broad. The second one had exactly
                   4203: one result, which is very good. But there is one pitfall with GNOME
                   4204: packages. Before GNOME 2 had been released, there were already many
                   4205: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4206: packages, the GNOME 2 packages were imported as separate packages, and
                   4207: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4208: whether this was the case here, and indeed it was.</p>
                   4209: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4210: file, adding the dependency is very easy. I just inserted an
                   4211: <code class="literal">.include</code> line before the last line of the package
                   4212: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4213: <pre class="programlisting">
1.100     rillig   4214: [...]
                   4215: .include "../../x11/gtk2/buildlink3.mk"
                   4216: .include "../../mk/bsd.pkg.mk
1.91      rillig   4217: </pre>
1.110     hubertf  4218: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   4219: was:</p>
                   4220: <pre class="programlisting">
1.100     rillig   4221: [...]
                   4222: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4223: checking for GTK - version &gt;= 1.2.0... no
                   4224: *** Could not run GTK test program, checking why...
                   4225: *** The test program failed to compile or link. See the file config.log for the
                   4226: *** exact error that occured. This usually means GTK was incorrectly installed
                   4227: *** or that you have moved GTK since it was installed. In the latter case, you
                   4228: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4229: configure: error: Test for GTK failed.
                   4230: [...]
1.91      rillig   4231: </pre>
                   4232: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4233: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4234: told me that this package really wanted to have the GNOME 1 version of
                   4235: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  4236: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   4237: So I changed the <code class="literal">x11/gtk2</code> to
                   4238: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4239: and tried again.</p>
                   4240: <pre class="programlisting">
1.100     rillig   4241: [...]
                   4242: 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
                   4243: In file included from xpidl.c:42:
                   4244: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4245: In file included from xpidl.c:42:
                   4246: xpidl.h:132: error: parse error before "IDL_ns"
                   4247: [...]
1.91      rillig   4248: </pre>
                   4249: <p>The package still does not find all of its dependencies. Now the
                   4250: question is: Which package provides the
                   4251: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4252: <pre class="programlisting">
1.100     rillig   4253: <code class="prompt">$</code> echo ../../*/*idl*
                   4254: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4255: <code class="prompt">$</code> echo ../../*/*IDL*
                   4256: ../../net/libIDL
1.91      rillig   4257: </pre>
                   4258: <p>Let's take the one from the second try. So I included the
                   4259: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4260: again. But the error didn't change. After digging through some of the
                   4261: code, I concluded that the build process of the package was broken and
                   4262: couldn't have ever worked, but since the Mozilla source tree is quite
                   4263: large, I didn't want to fix it. So I added the following to the package
                   4264: <code class="filename">Makefile</code> and tried again:</p>
                   4265: <pre class="programlisting">
1.100     rillig   4266: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4267: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   4268: </pre>
                   4269: <p>The latter line is needed because the package expects the library
                   4270: <code class="filename">libIDL.so</code>, but only
                   4271: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4272: wrapper to rewrite that on the fly.</p>
                   4273: <p>The next problem was related to a recent change of the FreeType
                   4274: 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>
                   4275: which patch files were relevant for this issue and copied them to the
                   4276: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4277: patches so that they applied cleanly and retried again. This time,
                   4278: everything worked.</p>
                   4279: </div>
                   4280: <div class="sect3" lang="en">
                   4281: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   4282: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   4283: <pre class="programlisting">
1.100     rillig   4284: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4285: [...]
                   4286: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4287: <code class="prompt">$</code> bmake deinstall
                   4288: <code class="prompt">$</code> bmake install
1.91      rillig   4289: </pre>
                   4290: </div>
                   4291: </div>
                   4292: </div>
1.77      rillig   4293: </div>
1.75      rillig   4294: <div class="chapter" lang="en">
                   4295: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4296: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   4297: <div class="toc">
                   4298: <p><b>Table of Contents</b></p>
                   4299: <dl>
1.123     snj      4300: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
                   4301: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.106     rillig   4302: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4303: <dd><dl>
                   4304: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4305: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4306: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4307: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4308: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4309: </dl></dd>
                   4310: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4311: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4312: <dd><dl>
                   4313: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4314: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4315: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   4316: </dl></dd>
1.123     snj      4317: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
                   4318: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.75      rillig   4319: </dl>
                   4320: </div>
1.87      wiz      4321: <p>Whenever you're preparing a package, there are a number of
                   4322: files involved which are described in the following
                   4323: sections.</p>
1.75      rillig   4324: <div class="sect1" lang="en">
                   4325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4326: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   4327: </h2></div></div></div>
1.75      rillig   4328: <p>Building, installation and creation of a binary package are all
1.87      wiz      4329:   controlled by the package's <code class="filename">Makefile</code>.
                   4330:   The <code class="filename">Makefile</code> describes various things about
                   4331:   a package, for example from where to get it, how to configure,
                   4332:   build, and install it.</p>
1.76      rillig   4333: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      4334:   sections that describe the package.</p>
1.75      rillig   4335: <p>In the first section there are the following variables, which
1.87      wiz      4336:   should appear exactly in the order given here.  The order and
                   4337:   grouping of the variables is mostly historical and has no further
                   4338:   meaning.</p>
1.75      rillig   4339: <div class="itemizedlist"><ul type="disc">
                   4340: <li><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      4341:     distribution file to be downloaded from the package's
                   4342:     website.</p></li>
1.75      rillig   4343: <li><p><code class="varname">PKGNAME</code> is the name of the
1.87      wiz      4344:     package, as used by pkgsrc. You only need to provide it if
                   4345:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4346:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4347:     directory name together with the version number. It must match the
                   4348:     regular expression
                   4349:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4350:     starts with a letter or digit, and contains only letters, digits,
                   4351:     dashes, underscores, dots and plus signs.</p></li>
                   4352: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4353:     the package file to create if the <code class="varname">PKGNAME</code>
                   4354:     isn't unique on a SVR4 system. The default is
                   4355:     <code class="varname">PKGNAME</code>, which may be shortened when you use
1.91      rillig   4356:     <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      4357:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4358:     does not produce an unique package name on a SVR4 system.
                   4359:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4360:     characters.</p></li>
1.75      rillig   4361: <li>
                   4362: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      4363:     which the package fits in. You can choose any of the top-level
                   4364:     directories of pkgsrc for it.</p>
1.75      rillig   4365: <p>Currently the following values are available for
1.87      wiz      4366:     <code class="varname">CATEGORIES</code>. If more than
                   4367:     one is used, they need to be separated by spaces:</p>
1.75      rillig   4368: <pre class="programlisting">
1.100     rillig   4369: archivers     cross         geography     meta-pkgs     security
                   4370: audio         databases     graphics      misc          shells
                   4371: benchmarks    devel         ham           multimedia    sysutils
                   4372: biology       editors       inputmethod   net           textproc
                   4373: cad           emulators     lang          news          time
                   4374: chat          finance       mail          parallel      wm
                   4375: comms         fonts         math          pkgtools      www
                   4376: converters    games         mbone         print         x11
                   4377: </pre>
1.75      rillig   4378: </li>
1.81      rillig   4379: <li><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4380:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4381:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4382:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.123     snj      4383:     <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   4384: </ul></div>
                   4385: <p>The second section contains information about separately
1.87      wiz      4386:   downloaded patches, if any.
                   4387:   </p>
1.75      rillig   4388: <div class="itemizedlist"><ul type="disc">
                   4389: <li><p><code class="varname">PATCHFILES:</code>
1.87      wiz      4390:     Name(s) of additional files that contain distribution patches.
                   4391:     There is no default. pkgsrc will look for them at
                   4392:     <code class="varname">PATCH_SITES</code>.
                   4393:     They will automatically be uncompressed before patching if
                   4394:     the names end with <code class="filename">.gz</code> or
                   4395:     <code class="filename">.Z</code>.</p></li>
1.75      rillig   4396: <li><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4397:     Primary location(s) for distribution patch files (see
                   4398:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
1.75      rillig   4399: </ul></div>
                   4400: <p>The third section contains the following variables.
1.87      wiz      4401:   </p>
1.75      rillig   4402: <div class="itemizedlist"><ul type="disc">
1.114     jmcneill 4403: <li><p><code class="varname">MAINTAINER</code> is the email
                   4404:     address of the person who feels responsible for this package,
                   4405:     and who is most likely to look at problems or questions regarding
                   4406:     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>.
                   4407:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4408:     before making changes to the package, but are not required to
                   4409:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4410:     to yourself. If you really can't maintain the package for future
                   4411:     updates, set it to
1.110     hubertf  4412:     <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 4413: <li><p><code class="varname">OWNER</code> should be used instead
                   4414:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4415:     developers to update or change the package without contacting
                   4416:     you first. A package Makefile should contain one of
                   4417:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4418:     not both.  </p></li>
1.75      rillig   4419: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4420:     find more information about the package.</p></li>
1.75      rillig   4421: <li><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4422:     description of the package (should not include the package
                   4423:     name).</p></li>
1.75      rillig   4424: </ul></div>
                   4425: <p>Other variables that affect the build:
1.87      wiz      4426:   </p>
1.75      rillig   4427: <div class="itemizedlist"><ul type="disc"><li>
                   4428: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4429:       interesting distribution files of the package are found. The
                   4430:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4431:       works for most packages.</p>
1.75      rillig   4432: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4433:       (most GNU software does, for instance), but extracts itself in
                   4434:       the current directory, you should set
                   4435:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4436: <p>If a package doesn't create a subdirectory with the
                   4437:       name of <code class="varname">DISTNAME</code> but some different name,
                   4438:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4439:       <code class="filename">${WRKDIR}</code>, for example
                   4440:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.91      rillig   4441:       <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   4442: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4443:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4444:       variable. By default, its value is
                   4445:       <code class="filename">work</code>. If you want to use the same
                   4446:       pkgsrc tree for building different kinds of binary packages,
                   4447:       you can change the variable according to your needs. Two
                   4448:       other variables handle common cases of setting
                   4449:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4450:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  4451:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      4452:       the host's name is attached to the directory name. If
                   4453:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4454:       is attached, which might look like
                   4455:       <code class="filename">work.i386</code> or
                   4456:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4457: </li></ul></div>
                   4458: <p>Please pay attention to the following gotchas:</p>
                   4459: <div class="itemizedlist"><ul type="disc">
1.87      wiz      4460: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4461:       installed in compressed form by the package.  For packages using
                   4462:       BSD-style makefiles which honor MANZ, there is
                   4463:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.76      rillig   4464: <li><p>Replace <code class="filename">/usr/local</code> with
1.88      wiz      4465:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4466:       below).</p></li>
1.110     hubertf  4467: <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   4468: </ul></div>
                   4469: </div>
                   4470: <div class="sect1" lang="en">
                   4471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4472: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   4473: </h2></div></div></div>
1.76      rillig   4474: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4475:   digest, or checksum, of each distfile needed for the package. This
                   4476:   ensures that the distfiles retrieved from the Internet have not been
                   4477:   corrupted during transfer or altered by a malign force to introduce
                   4478:   a security hole. Due to recent rumor about weaknesses of digest
                   4479:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4480:   message digests, as well as the file size.</p>
1.76      rillig   4481: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4482:   checksums for all the patches found in the
1.110     hubertf  4483:   <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   4484: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.110     hubertf  4485:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.87      wiz      4486:   command.</p>
1.75      rillig   4487: <p>Some packages have different sets of distfiles depending on
1.91      rillig   4488:   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      4489:   <code class="filename">distinfo</code> file and care should be taken when
                   4490:   upgrading such a package to ensure distfile information is not
                   4491:   lost.</p>
1.75      rillig   4492: </div>
                   4493: <div class="sect1" lang="en">
                   4494: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4495: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.93      rillig   4496: <p>Many packages still don't work out-of-the box on the various
                   4497:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4498:   patch files are needed to make the package work. These patch files are
                   4499:   found in the <code class="filename">patches/</code> directory.</p>
                   4500: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4501:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.110     hubertf  4502:   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   4503:   order</a>, so <code class="filename">patch-aa</code> is applied before
1.87      wiz      4504:   <code class="filename">patch-ab</code>, etc.</p>
1.93      rillig   4505: <div class="sect2" lang="en">
                   4506: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4507: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4508: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  4509:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4510:   problems. (To force patches to apply with fuzz you can set
                   4511:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4512:   should contain only changes for a single file, and no file should be
1.93      rillig   4513:   patched by more than one patch file. This helps to keep future
                   4514:   modifications simple.</p>
                   4515: <p>Each patch file is structured as follows: In the first line,
                   4516:   there is the RCS Id of the patch itself. The second line should be
                   4517:   empty for aesthetic reasons. After that, there should be a comment for
                   4518:   each change that the patch does. There are a number of standard
                   4519:   cases:</p>
                   4520: <div class="itemizedlist"><ul type="disc">
                   4521: <li><p>Patches that replace the <code class="literal">==</code>
1.110     hubertf  4522:   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   4523:   are so common that they don't need a comment at all.</p></li>
1.93      rillig   4524: <li><p>Patches for commonly known vulnerabilities should
                   4525:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4526: <li><p>Patches that change source code should mention the
                   4527:   platform and other environment (for example, the compiler) that the
                   4528:   patch is needed for.</p></li>
                   4529: </ul></div>
                   4530: <p>In all other cases, the patch should be commented so that any
                   4531:   developer who knows the code of the application can make some use of
                   4532:   the patch. Special care should be taken for the upstream developers,
                   4533:   since we generally want that they accept our patches, so we have less
                   4534:   work in the future.</p>
                   4535: </div>
                   4536: <div class="sect2" lang="en">
                   4537: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4538: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   4539: <p>One important thing to mention is to pay attention that no RCS
                   4540:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4541:   later checked into the NetBSD CVS tree. Use the
1.110     hubertf  4542:   <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   4543:   problems.</p>
1.87      wiz      4544: <p>For even more automation, we recommend using
1.110     hubertf  4545:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      4546:   whole set of patches. You just have to backup files before you
                   4547:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  4548:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4549:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      4550:   you upgrade a package this way, you can easily compare the new
                   4551:   set of patches with the previously existing one with
1.110     hubertf  4552:   <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.87      wiz      4553:   or update from the <code class="filename">work/.newpatches</code>
                   4554:   directory to <code class="filename">patches/</code>.</p>
                   4555: <p>When you have finished a package, remember to generate
1.110     hubertf  4556:   the checksums for the patch files by using the <span class="command"><strong>make
1.123     snj      4557:   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      4558: <p>When adding a patch that corrects a problem in the
                   4559:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4560:   man pages should go), send the patch as a bug report to the
                   4561:   maintainer.  This benefits non-pkgsrc users of the package,
                   4562:   and usually makes it possible to remove the patch in future
                   4563:   version.</p>
1.101     rillig   4564: <p>The file names of the patch files are usually of the form
                   4565:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.93      rillig   4566: </div>
                   4567: <div class="sect2" lang="en">
                   4568: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4569: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4570: <p>If you want to share patches between multiple packages
                   4571:   in pkgsrc, e.g. because they use the same distfiles, set
                   4572:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4573:   can be found, e.g.:</p>
                   4574: <pre class="programlisting">
1.100     rillig   4575: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4576: </pre>
1.75      rillig   4577: <p>Patch files that are distributed by the author or other
1.87      wiz      4578:     maintainers can be listed in
                   4579:     <code class="varname">PATCHFILES</code>.</p>
                   4580: <p>If it is desired to store any patches that should not be
                   4581:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4582:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4583:     directory tree there is expected to have the same
                   4584:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4585:     patches are expected to be stored inside these dirs (also
                   4586:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4587:     example, if you want to keep a private patch for
                   4588:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4589:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4590:     files in the named directory are expected to be patch files,
                   4591:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4592:     applied</em></span>.</p>
1.93      rillig   4593: </div>
1.85      jmmv     4594: <div class="sect2" lang="en">
                   4595: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4596: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4597: <p>When fixing a portability issue in the code do not use
                   4598:       preprocessor magic to check for the current operating system nor
                   4599:       platform.  Doing so hurts portability to other platforms because
                   4600:       the OS-specific details are not abstracted appropriately.</p>
                   4601: <p>The general rule to follow is: instead of checking for the
                   4602:       operating system the application is being built on, check for the
                   4603:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4604:       instead of assuming that kqueue is available under NetBSD and
                   4605:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.125   ! wiz      4606:       kqueue support, add a check that detects kqueue itself &#8212;
1.85      jmmv     4607:       yes, this generally involves patching the
1.110     hubertf  4608:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     4609:       that prevents some OSes from adopting interfaces from other OSes
                   4610:       (e.g. Linux implementing kqueue), something that the above checks
                   4611:       cannot take into account.</p>
                   4612: <p>Of course, checking for features generally involves more
                   4613:       work on the developer's side, but the resulting changes are
1.87      wiz      4614:       cleaner and there are chances they will work on many other
1.85      jmmv     4615:       platforms.  Not to mention that there are higher chances of being
                   4616:       later integrated into the mainstream sources.  Remember:
                   4617:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4618: <p>Some typical examples:</p>
                   4619: <div class="table">
1.106     rillig   4620: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.91      rillig   4621: <div class="table-contents"><table summary="Patching examples" border="1">
1.85      jmmv     4622: <colgroup>
                   4623: <col>
                   4624: <col>
                   4625: <col>
                   4626: </colgroup>
                   4627: <thead><tr>
                   4628: <th>Where</th>
                   4629: <th>Incorrect</th>
                   4630: <th>Correct</th>
                   4631: </tr></thead>
                   4632: <tbody>
                   4633: <tr>
                   4634: <td>configure script</td>
                   4635: <td>
1.100     rillig   4636: <pre class="programlisting">
                   4637: case ${target_os} in
                   4638: netbsd*) have_kvm=yes ;;
                   4639: *)       have_kvm=no  ;;
                   4640: esac
                   4641: </pre>
1.85      jmmv     4642:              </td>
                   4643: <td>
1.100     rillig   4644: <pre class="programlisting">
                   4645: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4646: </pre>
1.85      jmmv     4647:              </td>
                   4648: </tr>
                   4649: <tr>
                   4650: <td>C source file</td>
                   4651: <td>
1.100     rillig   4652: <pre class="programlisting">
                   4653: #if defined(__NetBSD__)
                   4654: #  include &lt;sys/event.h&gt;
                   4655: #endif
                   4656: </pre>
1.85      jmmv     4657:              </td>
                   4658: <td>
1.100     rillig   4659: <pre class="programlisting">
                   4660: #if defined(HAVE_SYS_EVENT_H)
                   4661: #  include &lt;sys/event.h&gt;
                   4662: #endif
                   4663: </pre>
1.85      jmmv     4664:              </td>
                   4665: </tr>
                   4666: <tr>
                   4667: <td>C source file</td>
                   4668: <td>
1.100     rillig   4669: <pre class="programlisting">
                   4670: int
                   4671: monitor_file(...)
                   4672: {
                   4673: #if defined(__NetBSD__)
                   4674:         int fd = kqueue();
                   4675:         ...
                   4676: #else
                   4677:         ...
                   4678: #endif
                   4679: }
                   4680: </pre>
1.85      jmmv     4681:              </td>
                   4682: <td>
1.100     rillig   4683: <pre class="programlisting">
                   4684: int
                   4685: monitor_file(...)
                   4686: {
                   4687: #if defined(HAVE_KQUEUE)
                   4688:         int fd = kqueue();
                   4689:         ...
                   4690: #else
                   4691:        ...
                   4692: #endif
                   4693: }
                   4694: </pre>
1.85      jmmv     4695:              </td>
                   4696: </tr>
                   4697: </tbody>
1.91      rillig   4698: </table></div>
1.85      jmmv     4699: </div>
1.91      rillig   4700: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  4701:       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
                   4702:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     4703:       2</a>).  It summarizes multiple details on how to make
                   4704:       software easier to package; all the suggestions in it were
                   4705:       collected from our experience in pkgsrc work, so they are possibly
                   4706:       helpful when creating patches too.</p>
                   4707: </div>
                   4708: <div class="sect2" lang="en">
                   4709: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4710: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4711: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4712:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4713:       improvements you do to a package to the mainstream developers.
                   4714:       This is the only way to get their attention on portability issues
                   4715:       and to ensure that future versions can be built out-of-the box on
                   4716:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4717:       the fixes straight from the packaged code.</p>
1.93      rillig   4718: <p>This generally involves cleaning up the patches
                   4719:       (because sometimes the patches that are
1.85      jmmv     4720:       added to pkgsrc are quick hacks), filling bug reports in the
                   4721:       appropriate trackers for the projects and working with the
                   4722:       mainstream authors to accept your changes.  It is
                   4723:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4724:       the packages in pkgsrc are kept simple and thus further changes
                   4725:       can be done without much hassle.</p>
                   4726: <p>Support the idea of free software!</p>
                   4727: </div>
1.75      rillig   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="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.75      rillig   4732: <div class="variablelist"><dl>
1.76      rillig   4733: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4734: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4735:          any credits where they are due.  Please bear in mind that others do not
                   4736:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4737:          will read everything that you write here.</p></dd>
1.76      rillig   4738: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4739: <dd><p>This file governs the files that are installed on your
                   4740:          system: all the binaries, manual pages, etc. There are other
                   4741:          directives which may be entered in this file, to control the
                   4742:          creation and deletion of directories, and the location of
1.110     hubertf  4743:          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      4744:          information.</p></dd>
1.75      rillig   4745: </dl></div>
                   4746: </div>
                   4747: <div class="sect1" lang="en">
                   4748: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4749: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.78      rillig   4750: <div class="sect2" lang="en">
                   4751: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4752: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.75      rillig   4753: <div class="variablelist"><dl>
1.76      rillig   4754: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.110     hubertf  4755: <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      4756:            First time after package extraction and before files are
                   4757:            moved in place, the second time after the files to install
                   4758:            are moved in place. This can be used to do any custom
                   4759:            procedures not possible with @exec commands in
1.110     hubertf  4760:            <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
                   4761:            <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   4762: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4763: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4764:            this script's responsibility to clean up any additional messy details
                   4765:            around the package's installation, since all pkg_delete knows is how to
                   4766:            delete the files created in the original distribution.
1.110     hubertf  4767:            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>
                   4768:            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   4769: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4770: <dd>
                   4771: <p>This file is displayed after installation of the package.
1.87      wiz      4772:            Useful for things like legal notices on almost-free
                   4773:            software and hints for updating config files after
                   4774:            installing modules for apache, PHP etc.
                   4775:            Please note that you can modify variables in it easily by using
                   4776:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4777:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4778: <pre class="programlisting">
1.100     rillig   4779: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4780: </pre>
1.75      rillig   4781: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
1.87      wiz      4782:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4783:            performed for <code class="varname">PKGNAME</code>,
                   4784:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4785:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4786:            <code class="varname">X11BASE</code>,
                   4787:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4788:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  4789:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      4790: <p>You can display a different or additional files by
                   4791:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4792:            default is <code class="filename">MESSAGE</code>, if the file
                   4793:            exists.</p>
1.75      rillig   4794: </dd>
1.78      rillig   4795: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4796: <dd><p>FIXME: There is no documentation on the
                   4797:        alternatives framework.</p></dd>
                   4798: </dl></div>
                   4799: </div>
                   4800: <div class="sect2" lang="en">
                   4801: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4802: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.78      rillig   4803: <div class="variablelist"><dl>
                   4804: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4805: <dd><p>This file contains arbitrary things that could
                   4806:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4807:        to be used by more than one package. This file should only be
                   4808:        used when the packages that will use the file are known in
                   4809:        advance. For other purposes it is often better to write a
                   4810:        <code class="filename">*.mk</code> file and give it a good name that
                   4811:        describes what it does.</p></dd>
                   4812: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4813: <dd><p>This file contains the dependency information
1.110     hubertf  4814:        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   4815: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4816: <dd><p>This file contains workarounds for compiler bugs
                   4817:        and similar things. It is included automatically by the pkgsrc
                   4818:        infrastructure, so you don't need an extra
                   4819:        <code class="literal">.include</code> line for
                   4820:        it.</p></dd>
                   4821: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4822: <dd><p>This file contains the code for the
1.110     hubertf  4823:        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   4824:        selected by the user. If a package has only one or two options,
                   4825:        it is equally acceptable to put the code directly into the
                   4826:        <code class="filename">Makefile</code>.</p></dd>
                   4827: </dl></div>
                   4828: </div>
                   4829: <div class="sect2" lang="en">
                   4830: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4831: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.78      rillig   4832: <div class="variablelist"><dl>
                   4833: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4834: <dd><p>These files do not take place in the creation of
                   4835:        a package and thus are purely informative to the package
                   4836:        developer.</p></dd>
                   4837: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4838: <dd><p>This file contains things that need to be done
                   4839:        to make the package even
                   4840:        better.</p></dd>
1.75      rillig   4841: </dl></div>
                   4842: </div>
1.78      rillig   4843: </div>
1.75      rillig   4844: <div class="sect1" lang="en">
                   4845: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4846: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   4847: </h2></div></div></div>
1.110     hubertf  4848: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4849:     unpacked into the directory denoted by
                   4850:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4851:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4852:     directory is also used to keep various timestamp files.
                   4853:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4854:     The default is <code class="filename">${.CURDIR}/work</code>
                   4855:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4856:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4857: </div>
                   4858: <div class="sect1" lang="en">
                   4859: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4860: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   4861: </h2></div></div></div>
1.75      rillig   4862: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4863:     to configuration or building, you could place these files here and use
1.110     hubertf  4864:     a <span class="command"><strong>${CP}</strong></span> command in the
1.87      wiz      4865:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4866:     this. Alternatively, you could simply diff the file against
                   4867:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4868:     the creation of this file.</p>
                   4869: <p>If you want to share files in this way with other
                   4870:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4871:     to the other package's <code class="filename">files</code> directory,
                   4872:     e.g.:</p>
                   4873: <pre class="programlisting">
1.100     rillig   4874: FILESDIR=${.CURDIR}/../xemacs/files
                   4875: </pre>
1.75      rillig   4876: </div>
                   4877: </div>
                   4878: <div class="chapter" lang="en">
                   4879: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4880: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4881: <div class="toc">
                   4882: <p><b>Table of Contents</b></p>
                   4883: <dl>
1.106     rillig   4884: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.123     snj      4885: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.106     rillig   4886: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4887: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4888: <dd><dl>
                   4889: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4890: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4891: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4892: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4893: <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   4894: </dl></dd>
                   4895: </dl>
                   4896: </div>
1.76      rillig   4897: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4898:   each of which forms a well-defined part of the pkgsrc system. Using
1.110     hubertf  4899:   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   4900:   like pkgsrc requires some discipline to keep the code correct and
                   4901:   understandable.</p>
1.76      rillig   4902: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4903:   programming are variables (which are actually macros) and shell
                   4904:   commands. Among these shell commands may even be more complex ones
1.110     hubertf  4905:   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   4906:   as intended it is necessary to quote all variables correctly when they
                   4907:   are used.</p>
                   4908: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4909:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4910:   with them.</p>
                   4911: <div class="sect1" lang="en">
                   4912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4913: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.97      rillig   4914: <div class="itemizedlist"><ul type="disc"><li>
                   4915: <p>When you are creating a file as a
                   4916:     target of a rule, always write the data to a temporary file first
                   4917:     and finally rename that file. Otherwise there might occur an error
                   4918:     in the middle of generating the file, and when the user runs
1.110     hubertf  4919:     <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   4920:     regenerated properly. Example:</p>
                   4921: <pre class="programlisting">
1.100     rillig   4922: wrong:
                   4923:         @echo "line 1" &gt; ${.TARGET}
                   4924:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4925:         @false
                   4926: 
                   4927: correct:
                   4928:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4929:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4930:         @false
                   4931:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4932: </pre>
1.110     hubertf  4933: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4934:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4935:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4936:     correct</strong></span> gives an error message twice, as expected.</p>
1.110     hubertf  4937: <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   4938:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4939:     happens when it is interrupted, for example by pressing
                   4940:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.110     hubertf  4941:     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   4942: </li></ul></div>
                   4943: </div>
                   4944: <div class="sect1" lang="en">
                   4945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4946: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4947: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4948:     can be processed using the five operators ``='', ``+='', ``?='',
1.110     hubertf  4949:     ``:='', 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   4950:     page.</p>
                   4951: <p>When a variable's value is parsed from a
1.76      rillig   4952:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4953:     backslash character ``\'' are handled specially. If a backslash is
                   4954:     followed by a newline, any whitespace immediately in front of the
                   4955:     backslash, the backslash, the newline, and any whitespace
                   4956:     immediately behind the newline are replaced with a single space. A
                   4957:     backslash character and an immediately following hash character are
                   4958:     replaced with a single hash character. Otherwise, the backslash is
                   4959:     passed as is. In a variable assignment, any hash character that is
                   4960:     not preceded by a backslash starts a comment that continues upto the
                   4961:     end of the logical line.</p>
                   4962: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4963:     the only way to create a variable consisting of a single backslash
                   4964:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4965: <p>So far for defining variables. The other thing you can do with
                   4966:     variables is evaluating them. A variable is evaluated when it is
                   4967:     part of the right side of the ``:='' or the ``!='' operator, or
                   4968:     directly before executing a shell command which the variable is part
1.110     hubertf  4969:     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   4970:     is, variables are not evaluated until there's no other way. The
                   4971:     ``modifiers'' mentioned in the man page also evaluate the
                   4972:     variable.</p>
                   4973: <p>Some of the modifiers split the string into words and then
                   4974:     operate on the words, others operate on the string as a whole. When
                   4975:     a string is split into words, it is split as you would expect
1.110     hubertf  4976:     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.125   ! wiz      4977: <p>No rule without exception&#8212;the <span class="command"><strong>.for</strong></span>
1.75      rillig   4978:     loop does not follow the shell quoting rules but splits at sequences
                   4979:     of whitespace.</p>
                   4980: <p>There are several types of variables that should be handled
                   4981:     differently. Strings and two types of lists.</p>
                   4982: <div class="itemizedlist"><ul type="disc">
                   4983: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4984:       characters. Nevertheless, you should restrict yourself to only
                   4985:       using printable characters. Examples are
                   4986:       <code class="varname">PREFIX</code> and
                   4987:       <code class="varname">COMMENT</code>.</p></li>
                   4988: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4989:       are never exported to any shell command. Their elements are
                   4990:       separated by whitespace. Therefore, the elements themselves cannot
                   4991:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4992:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4993:       Examples are <code class="varname">DEPENDS</code> and
                   4994:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4995: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4996:       may be exported to a shell command. Their elements can contain any
                   4997:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4998:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4999:       <code class="varname">DISTFILES</code> and
                   5000:       <code class="varname">MASTER_SITES</code>.</p></li>
                   5001: </ul></div>
                   5002: <div class="sect2" lang="en">
                   5003: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5004: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.75      rillig   5005: <div class="itemizedlist"><ul type="disc">
                   5006: <li><p>All variable names starting with an underscore
                   5007:        are reserved for use by the pkgsrc infrastructure. They shall
                   5008:        not be used by package
1.76      rillig   5009:        <code class="filename">Makefile</code>s.</p></li>
1.110     hubertf  5010: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   5011:        lowercase variable names for the iteration
                   5012:        variables.</p></li>
                   5013: <li><p>All list variables should have a ``plural''
                   5014:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   5015:        <code class="varname">DISTFILES</code>.</p></li>
                   5016: </ul></div>
                   5017: </div>
                   5018: </div>
                   5019: <div class="sect1" lang="en">
                   5020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5021: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75      rillig   5022: <p>This section presents you with some code snippets you should
                   5023:     use in your own code. If you don't find anything appropriate here,
                   5024:     you should test your code and add it here.</p>
                   5025: <div class="sect2" lang="en">
                   5026: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5027: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   5028: <pre class="programlisting">
1.100     rillig   5029: STRING=                 foo * bar `date`
                   5030: INT_LIST=               # empty
                   5031: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   5032: EXT_LIST=               # empty
                   5033: ANOTHER_EXT_LIST=       a=b c=d
                   5034: 
                   5035: INT_LIST+=              ${STRING}               # 1
                   5036: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   5037: EXT_LIST+=              ${STRING:Q}             # 3
                   5038: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    5039: </pre>
1.75      rillig   5040: <p>When you add a string to an external list (example 3), it
                   5041:       must be quoted. In all other cases, you must not add a quoting
                   5042:       level. You must not merge internal and external lists, unless you
                   5043:       are sure that all entries are correctly interpreted in both
                   5044:       lists.</p>
                   5045: </div>
                   5046: <div class="sect2" lang="en">
                   5047: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5048: <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   5049: <pre class="programlisting">
1.100     rillig   5050: EXT_LIST=       # empty
                   5051: .for i in ${INT_LIST}
                   5052: EXT_LIST+=      ${i:Q}""
                   5053: .endfor
1.1       grant    5054: </pre>
1.75      rillig   5055: <p>This code converts the internal list
                   5056:       <code class="varname">INT_LIST</code> into the external list
                   5057:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   5058:       are unquoted they must be quoted here. The reason for appending
                   5059:       <code class="varname">""</code> is explained below.</p>
                   5060: </div>
                   5061: <div class="sect2" lang="en">
                   5062: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5063: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   5064: <p>Sometimes you may want to print an arbitrary string. There
                   5065:        are many ways to get it wrong and only few that can handle every
                   5066:        nastiness.</p>
1.75      rillig   5067: <pre class="programlisting">
1.100     rillig   5068: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5069: EXT_LIST=       string=${STRING:Q} x=second\ item
1.1       grant    5070: 
1.100     rillig   5071: all:
                   5072:         echo ${STRING}                  # 1
                   5073:         echo "${STRING}"                # 2
                   5074:         echo "${STRING:Q}"              # 3
                   5075:         echo ${STRING:Q}                # 4
                   5076:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5077:         printf "%s\\n" ${STRING:Q}""    # 6
                   5078:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
1.1       grant    5079: </pre>
1.75      rillig   5080: <p>Example 1 leads to a syntax error in the shell, as the
                   5081:       characters are just copied.</p>
                   5082: <p>Example 2 leads to a syntax error too, and if you leave out
                   5083:       the last " character from <code class="varname">${STRING}</code>,
1.110     hubertf  5084:       <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   5085:       variable would be evaluated, too.</p>
                   5086: <p>Example 3 outputs each space character preceded by a
                   5087:       backslash (or not), depending on the implementation of the
1.110     hubertf  5088:       <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   5089: <p>Example 4 handles correctly every string that does not start
                   5090:       with a dash. In that case, the result depends on the
1.110     hubertf  5091:       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   5092:       guarantee that your input does not start with a dash, this form is
                   5093:       appropriate.</p>
                   5094: <p>Example 5 handles even the case of a leading dash
                   5095:       correctly.</p>
1.79      rillig   5096: <p>Example 6 also works with every string and is the
                   5097:       light-weight solution, since it does not involve a pipe, which has
                   5098:       its own problems.</p>
1.75      rillig   5099: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5100:       because the quoting has already been done when adding elements to
                   5101:       the list.</p>
                   5102: <p>As internal lists shall not be passed to the shell, there is
                   5103:       no example for it.</p>
                   5104: </div>
                   5105: <div class="sect2" lang="en">
                   5106: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5107: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.75      rillig   5108: <p>There are many possible sources of wrongly quoted variables.
                   5109:       This section lists some of the commonly known ones.</p>
                   5110: <div class="itemizedlist"><ul type="disc">
                   5111: <li>
                   5112: <p>Whenever you use the value of a list, think
                   5113:        about what happens to leading or trailing whitespace. If the
                   5114:        list is a well-formed shell expression, you can apply the
                   5115:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5116:        whitespace from each word. The <code class="varname">:M</code> operator
                   5117:        first splits its argument according to the rules of the shell,
                   5118:        and then creates a new list consisting of all words that match
                   5119:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5120:        One class of situations where this is needed is when adding a
                   5121:        variable like <code class="varname">CPPFLAGS</code> to
                   5122:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5123:        invokes other configure scripts, it strips the leading and
                   5124:        trailing whitespace from the variable and then passes it to the
                   5125:        other configure scripts. But these configure scripts expect the
                   5126:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5127:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5128:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5129:        here is how we do it:</p>
                   5130: <pre class="programlisting">
1.100     rillig   5131: CPPFLAGS=               # empty
                   5132: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5133: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5134: 
                   5135: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5136: 
                   5137: all:
                   5138:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5139:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    5140: </pre>
1.75      rillig   5141: </li>
                   5142: <li><p>The example above contains one bug: The
                   5143:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5144:        expression, but there is the C compiler after it, which also
                   5145:        expects a properly quoted string (this time in C syntax). The
                   5146:        version above is therefore only correct if
                   5147:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5148:        or double quotes. If you want to allow these, you have to add
                   5149:        another layer of quoting to each variable that is used as a C
                   5150:        string literal. You cannot use the <code class="varname">:Q</code>
                   5151:        operator for it, as this operator only works for the
                   5152:        shell.</p></li>
                   5153: <li>
                   5154: <p>Whenever a variable can be empty, the
                   5155:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5156:        are two completely different cases which can be solved with the
                   5157:        same trick.</p>
                   5158: <pre class="programlisting">
1.100     rillig   5159: EMPTY=                  # empty
                   5160: empty_test:
                   5161:         for i in a ${EMPTY:Q} c; do \
                   5162:             echo "$$i"; \
                   5163:         done
                   5164: 
                   5165: for_test:
                   5166: .for i in a:\ a:\test.txt
                   5167:         echo ${i:Q}
                   5168:         echo "foo"
                   5169: .endfor
1.1       grant    5170: </pre>
1.75      rillig   5171: <p>The first example will only print two of the three lines
                   5172:        we might have expected. This is because
                   5173:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5174:        the shell cannot see. The workaround is to write
                   5175:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5176:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5177:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5178: <p>The second example will only print three lines instead of
                   5179:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5180:        This is because the backslash of the value
                   5181:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.110     hubertf  5182:        <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
                   5183:        <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   5184:        <code class="varname">${i:Q}""</code>.</p>
                   5185: </li>
                   5186: </ul></div>
                   5187: </div>
                   5188: <div class="sect2" lang="en">
                   5189: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5190: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.75      rillig   5191: <p>The pkgsrc bmake program does not handle the following
                   5192:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5193:       contains a ``-'' character, one of the closing braces is included
                   5194:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5195: <pre class="programlisting">
1.100     rillig   5196: VAR:=   ${VAR:N${_othervar_:C/-//}}
1.1       grant    5197: </pre>
1.75      rillig   5198: <p>For a more complex code snippet and a workaround, see the
1.91      rillig   5199:       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   5200:       <code class="varname">bug1</code>.</p>
                   5201: </div>
                   5202: </div>
                   5203: </div>
                   5204: <div class="chapter" lang="en">
                   5205: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5206: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   5207: <div class="toc">
                   5208: <p><b>Table of Contents</b></p>
                   5209: <dl>
1.106     rillig   5210: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.123     snj      5211: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
                   5212: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.106     rillig   5213: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5214: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.123     snj      5215: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.106     rillig   5216: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5217: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.75      rillig   5218: </dl>
                   5219: </div>
1.87      wiz      5220: <p>The <code class="filename">PLIST</code> file contains a package's
                   5221:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5222:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5223:   directory it's been installed in) plus some additional statements
1.110     hubertf  5224:   - 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      5225:   This chapter addresses some issues that need attention when
                   5226:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5227:   below!).</p>
1.75      rillig   5228: <div class="sect1" lang="en">
                   5229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5230: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      5231: <p>Be sure to add a RCS ID line as the first thing in any
                   5232:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   5233: <pre class="programlisting">
1.100     rillig   5234: @comment $NetBSD$
1.87      wiz      5235:     </pre>
1.75      rillig   5236: </div>
                   5237: <div class="sect1" lang="en">
                   5238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5239: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  5240: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      5241:     to output a PLIST that matches any new files since the package
1.110     hubertf  5242:     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      5243:     more information on this target.</p>
1.75      rillig   5244: </div>
                   5245: <div class="sect1" lang="en">
                   5246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  5247: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   5248: </h2></div></div></div>
1.87      wiz      5249: <p>If you have used any of the *-dirs packages, as explained in
1.110     hubertf  5250:     <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
                   5251:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.87      wiz      5252:     <code class="varname">@comment</code>s instead of real
                   5253:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5254:     specific directories and files, so that the results of that
                   5255:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5256:     lot</em></span> during the update of packages.</p>
                   5257: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5258:     of AWK patterns and actions that are used to filter the output of
                   5259:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5260:     scripting you like to it, but be careful with quoting.</p>
                   5261: <p>For example, to get all files inside the
                   5262:     <code class="filename">libdata/foo</code> directory removed from the
                   5263:     resulting PLIST:</p>
                   5264: <pre class="programlisting">
1.100     rillig   5265: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      5266:     </pre>
                   5267: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5268:     to a specific (shared) directory converted to
                   5269:     <code class="varname">@comment</code>s:</p>
1.75      rillig   5270: <pre class="programlisting">
1.100     rillig   5271: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
1.87      wiz      5272:     </pre>
1.75      rillig   5273: </div>
                   5274: <div class="sect1" lang="en">
                   5275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5276: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      5277: <p>A number of variables are substituted automatically in
                   5278:     PLISTs when a package is installed on a system. This includes the
                   5279:     following variables:</p>
1.75      rillig   5280: <div class="variablelist"><dl>
                   5281: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5282: <dd>
                   5283: <p>Some packages like emacs and perl embed information
1.87      wiz      5284:          about which architecture they were built on into the
                   5285:          pathnames where they install their files. To handle this
                   5286:          case, PLIST will be preprocessed before actually used, and
                   5287:          the symbol
                   5288:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
1.110     hubertf  5289:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      5290:          same is done if the string
                   5291:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5292:          PLIST somewhere - use this on packages that have GNU
                   5293:          autoconf-created configure scripts.</p>
1.75      rillig   5294: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5295: <h3 class="title">Legacy note</h3>
                   5296: <p>There used to be a symbol
1.87      wiz      5297:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
1.110     hubertf  5298:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      5299:            -m</strong></span>, but that's no longer supported and has
                   5300:            been removed.</p>
1.75      rillig   5301: </div>
                   5302: </dd>
                   5303: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5304: <dd>
                   5305: <p>Some packages want to embed the OS name and version
1.87      wiz      5306:          into some paths.  To do this, use these variables in the
                   5307:          <code class="filename">PLIST</code>:
                   5308:          </p>
1.75      rillig   5309: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  5310: <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   5311: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
1.110     hubertf  5312: <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   5313: </ul></div>
                   5314: </dd>
                   5315: </dl></div>
1.87      wiz      5316: <p>For a complete list of values which are replaced by
                   5317:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5318:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5319: <p>If you want to change other variables not listed above, you
                   5320:     can add variables and their expansions to this variable in the
1.110     hubertf  5321:     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   5322: <pre class="programlisting">
1.100     rillig   5323: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      5324:     </pre>
1.75      rillig   5325: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
1.87      wiz      5326:     in the <code class="filename">PLIST</code> with
                   5327:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
1.120     snj      5328: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   5329:     the common case of conditionally including some
                   5330:     <code class="filename">PLIST</code> entries. It can be done by adding
                   5331:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      5332:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   5333:     to <code class="literal">yes</code> if the entry should be included.
1.119     mishka   5334:     This will substitute &#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;
                   5335:     in the <code class="filename">PLIST</code> with either
                   5336:     &#8220;<span class="quote"><code class="literal">""</code></span>&#8221; or
                   5337:     &#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;.
                   5338:     For example, in <code class="filename">Makefile</code>:</p>
                   5339: <pre class="programlisting">
                   5340: PLIST_VARS+=   foo
                   5341: .if <em class="replaceable"><code>condition</code></em>
                   5342: PLIST.foo=     yes
                   5343: .else
                   5344:     </pre>
                   5345: <p>And then in <code class="filename">PLIST</code>:</p>
                   5346: <pre class="programlisting">
                   5347: @comment $NetBSD$
                   5348: bin/bar
                   5349: man/man1/bar.1
                   5350: ${PLIST.foo}bin/foo
                   5351: ${PLIST.foo}man/man1/foo.1
                   5352: ${PLIST.foo}share/bar/foo.data
                   5353: ${PLIST.foo}@dirrm share/bar
                   5354:     </pre>
1.75      rillig   5355: </div>
                   5356: <div class="sect1" lang="en">
                   5357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5358: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   5359: <p>Man pages should be installed in compressed form if
1.87      wiz      5360:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5361:     and uncompressed otherwise. To handle this in the
                   5362:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5363:     appended/removed automatically for man pages according to
                   5364:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5365:     or not, see above for details. This modification of the
                   5366:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5367:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   5368: </div>
                   5369: <div class="sect1" lang="en">
                   5370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5371: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   5372: </h2></div></div></div>
1.76      rillig   5373: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      5374:     in generating the binary package, set the variable
                   5375:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.110     hubertf  5376:     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      5377:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5378:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   5379: </div>
                   5380: <div class="sect1" lang="en">
                   5381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5382: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   5383: <p>Some packages decide to install a different set of files based on
1.87      wiz      5384:     the operating system being used. These differences can be
                   5385:     automatically handled by using the following files:</p>
1.75      rillig   5386: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5387: <li><p><code class="filename">PLIST.common</code></p></li>
                   5388: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5389: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5390: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5391: <li><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   5392: </ul></div>
                   5393: </div>
                   5394: <div class="sect1" lang="en">
                   5395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5396: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.87      wiz      5397: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5398:     multiple (and unrelated) packages install files.  These
1.125   ! wiz      5399:     directories were problematic because you had to add special
        !          5400:     tricks in the PLIST to conditionally remove them, or have some
1.87      wiz      5401:     centralized package handle them.</p>
1.125   ! wiz      5402: <p>In pkgsrc, it is now easy: Each package should create
        !          5403:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
        !          5404:     will remove any directories left empty after uninstalling a
        !          5405:     package.</p>
        !          5406: <p>If a package needs an empty directory to work, create
        !          5407:     the directory during installation as usual, and also add an
        !          5408:     entry to the PLIST:
        !          5409:     </p>
1.87      wiz      5410: <pre class="programlisting">
1.125   ! wiz      5411: @pkgdir path/to/empty/directory
1.87      wiz      5412:     </pre>
1.125   ! wiz      5413: <p>
        !          5414:     </p>
1.75      rillig   5415: </div>
                   5416: </div>
                   5417: <div class="chapter" lang="en">
                   5418: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5419: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   5420: <div class="toc">
                   5421: <p><b>Table of Contents</b></p>
                   5422: <dl>
1.106     rillig   5423: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.123     snj      5424: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.75      rillig   5425: <dd><dl>
1.106     rillig   5426: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.123     snj      5427: <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   5428: </dl></dd>
1.123     snj      5429: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.75      rillig   5430: <dd><dl>
1.123     snj      5431: <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   5432: <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   5433: </dl></dd>
                   5434: </dl>
                   5435: </div>
                   5436: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5437:   are seen by a package's configure and build processes.  This is implemented
                   5438:   in a two step process:</p>
1.75      rillig   5439: <div class="orderedlist"><ol type="1">
                   5440: <li><p>Symlink headers and libraries for dependencies into
1.87      wiz      5441:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5442:       of <code class="varname">WRKDIR</code>.</p></li>
1.75      rillig   5443: <li><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5444:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5445:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5446:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5447:       native compiler on some operating systems look like GCC, so that
                   5448:       packages that expect GCC won't require modifications to build with
                   5449:       those native compilers.</p></li>
1.75      rillig   5450: </ol></div>
                   5451: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5452:   package may be built consistently despite what other software may be
                   5453:   installed. Please note that the normal system header and library paths,
                   5454:   e.g. <code class="filename">/usr/include</code>,
                   5455:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5456:   designed to insulate the package build from non-system-supplied
                   5457:   software.</p>
1.75      rillig   5458: <div class="sect1" lang="en">
                   5459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5460: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5461: <p>The process of converting packages to use the buildlink3
1.87      wiz      5462:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5463:     The things to keep in mind are:</p>
1.75      rillig   5464: <div class="orderedlist"><ol type="1">
1.87      wiz      5465: <li><p>Ensure that the build always calls the wrapper scripts
                   5466:        instead of the actual toolchain.  Some packages are tricky,
                   5467:        and the only way to know for sure is the check
                   5468:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5469:        wrappers are being invoked.</p></li>
                   5470: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5471:        the package Makefile, e.g. Java VMs, standalone shells,
                   5472:        etc., because the code to symlink files into
                   5473:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5474:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5475:        </p></li>
                   5476: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5477:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5478:        package's Makefile are added as dependencies for that package.
                   5479:        </p></li>
1.75      rillig   5480: </ol></div>
1.87      wiz      5481: <p>If a dependency on a particular package is required for its libraries and
                   5482:     headers, then we replace:</p>
1.75      rillig   5483: <pre class="programlisting">
1.100     rillig   5484: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5485: </pre>
1.75      rillig   5486: <p>with</p>
                   5487: <pre class="programlisting">
1.100     rillig   5488: .include "../../category/foo/buildlink3.mk"
                   5489: </pre>
1.75      rillig   5490: <p>The buildlink3.mk files usually define the required dependencies.
                   5491:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5492:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5493: <pre class="programlisting">
1.100     rillig   5494: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5495: .include "../../category/foo/buildlink3.mk"
                   5496: </pre>
1.76      rillig   5497: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5498:     files in <code class="filename">pkgsrc/mk</code>
                   5499:     that handle special package issues:</p>
1.75      rillig   5500: <div class="itemizedlist"><ul type="disc">
1.76      rillig   5501: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5502:        the native or a pkgsrc Berkeley DB implementation based on
                   5503:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5504:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.76      rillig   5505: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5506:        comes with neither Curses nor NCurses, this will take care
1.91      rillig   5507:        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   5508: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5509:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5510:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5511:        require a Kerberos 5 implementation.</p></li>
1.88      wiz      5512: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5513:        system-provided Motif installation or adds a dependency on
1.91      rillig   5514:        <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      5515:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5516:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5517:        which Motif version will be used.</p></li>
1.76      rillig   5518: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5519:        variables that may be used by packages that use the
                   5520:        Open Sound System (OSS) API.</p></li>
1.76      rillig   5521: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.93      rillig   5522:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
1.87      wiz      5523:        the file for more information.</p></li>
1.76      rillig   5524: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5525:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.91      rillig   5526:        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   5527: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5528:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5529:        library.</p></li>
1.75      rillig   5530: </ul></div>
1.76      rillig   5531: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5532:     files provide a more complete
                   5533:     description of how to use them properly.</p>
1.75      rillig   5534: </div>
                   5535: <div class="sect1" lang="en">
                   5536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5537: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   5538: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      5539:     included by Makefiles to indicate the need to compile and link
                   5540:     against header files and libraries provided by the package.  A
                   5541:     <code class="filename">buildlink3.mk</code> file should always provide
                   5542:     enough information to add the correct type of dependency
                   5543:     relationship and include any other
                   5544:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5545:     headers and libraries that it needs in turn.</p>
                   5546: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.91      rillig   5547:     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      5548:     package is highly recommended.  For most packages, the following
                   5549:     command will generate a good starting point for
                   5550:     <code class="filename">buildlink3.mk</code> files:</p>
                   5551: <pre class="screen">
                   5552: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5553: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5554:     </pre>
1.75      rillig   5555: <div class="sect2" lang="en">
                   5556: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5557: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5558: <p>The following real-life example
1.87      wiz      5559:       <code class="filename">buildlink3.mk</code> is taken
                   5560:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5561: <pre class="programlisting">
1.120     snj      5562: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    5563: 
1.120     snj      5564: BUILDLINK_TREE+=       tiff
1.1       grant    5565: 
1.120     snj      5566: .if !defined(TIFF_BUILDLINK3_MK)
                   5567: TIFF_BUILDLINK3_MK:=
1.87      wiz      5568: 
1.120     snj      5569: BUILDLINK_API_DEPENDS.tiff+=   tiff&gt;=3.6.1
                   5570: BUILDLINK_ABI_DEPENDS.tiff+=   tiff&gt;=3.7.2nb1
                   5571: BUILDLINK_PKGSRCDIR.tiff?=     ../../graphics/tiff
1.87      wiz      5572: 
1.100     rillig   5573: .include "../../devel/zlib/buildlink3.mk"
                   5574: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      5575: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      5576: 
1.120     snj      5577: BUILDLINK_TREE+=       -tiff
1.100     rillig   5578: </pre>
1.87      wiz      5579: <p>The header and footer manipulate
1.120     snj      5580:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      5581:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      5582:       the dependency tree.</p>
                   5583: <p>The main section is protected from multiple inclusion
1.87      wiz      5584:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5585:       added.  Several important variables are set in the section:</p>
                   5586: <div class="itemizedlist"><ul type="disc">
                   5587: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5588:          is the actual dependency recorded in the installed
                   5589:          package; this should always be set using
1.110     hubertf  5590:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      5591:          we're appending to any pre-existing list of values.  This
                   5592:          variable should be set to the first version of the
                   5593:          package that had an API change.
                   5594:          </p></li>
                   5595: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5596:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5597:          pkgsrc directory.</p></li>
                   5598: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5599:          (not shown above) controls whether we use
                   5600:          <code class="varname">BUILD_DEPENDS</code> or
                   5601:          <code class="varname">DEPENDS</code> to add the dependency on
                   5602:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5603:          selected by setting
                   5604:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5605:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5606:          used.</p></li>
                   5607: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5608:            and
                   5609:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5610:            (not shown above) are lists of subdirectories of
1.76      rillig   5611:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5612:            to add to the header and library search paths.  These
                   5613:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
1.87      wiz      5614:          respectively.</p></li>
                   5615: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5616:            (not shown above) is the list of preprocessor flags to add
                   5617:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5618:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5619:            should be avoided and instead be handled using
                   5620:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5621:          above.</p></li>
1.75      rillig   5622: </ul></div>
1.87      wiz      5623: <p>The following variables are all optionally defined within
                   5624:       this second section (protected against multiple inclusion) and
                   5625:       control which package files are symlinked into
                   5626:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5627:       transformed during the symlinking:</p>
1.75      rillig   5628: <div class="itemizedlist"><ul type="disc">
1.87      wiz      5629: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5630:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5631:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5632:            to be symlinked into
1.76      rillig   5633:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5634:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5635: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5636:            (not shown above) is a shell pipeline that
                   5637:            outputs to stdout a list of files relative to
                   5638:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5639:            The resulting files are to be symlinked
                   5640:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5641:            this takes the <code class="filename">+CONTENTS</code> of a
                   5642:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5643:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5644: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5645:            (not shown above) is a filter command that filters
1.76      rillig   5646:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5647:            relative to
1.76      rillig   5648:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5649:            on stdout.  By default for overwrite packages,
                   5650:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5651:            outputs the contents of the <code class="filename">include</code>
                   5652:            and <code class="filename">lib</code> directories in the package
                   5653:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
1.75      rillig   5654:            it outputs any libtool archives in
1.87      wiz      5655:            <code class="filename">lib</code> directories.</p></li>
1.95      tron     5656: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5657:            (not shown above) is a list of sed arguments used to
                   5658:            transform the name of the source filename into a
1.110     hubertf  5659:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      5660:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5661: </ul></div>
1.120     snj      5662: <p>This section can additionally include any
1.87      wiz      5663:       <code class="filename">buildlink3.mk</code> needed for
                   5664:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5665:       Including these <code class="filename">buildlink3.mk</code> files
                   5666:       means that the headers and libraries for these
                   5667:       dependencies are also symlinked into
                   5668:       <code class="filename">${BUILDLINK_DIR}</code>
                   5669:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5670:       <code class="filename">buildlink3.mk</code>
1.120     snj      5671:       file is included. Dependencies are only added for directly
                   5672:       include <code class="filename">buildlink3.mk</code> files.</p>
1.75      rillig   5673: </div>
                   5674: <div class="sect2" lang="en">
                   5675: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5676: <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      5677: <p>The situation that requires increasing the dependency listed in
1.75      rillig   5678:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5679:        after a package update is when the API or interface to the
1.87      wiz      5680:       header files change.</p>
                   5681: <p>In this case,
                   5682:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5683:       should be adjusted to require at least the new package
                   5684:       version.  In some cases, the packages that depend on this new
                   5685:       version may need their <code class="varname">PKGREVISION</code>s
                   5686:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5687:       files, their
                   5688:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5689:       adjusted, too.  This is needed so pkgsrc will require the
                   5690:       correct package dependency and not settle for an older one
                   5691:       when building the source.</p>
                   5692: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5693:        should be increased when the binary interface or sonames
                   5694:        (major number of the library version) of any installed
                   5695:        shared libraries change.  This is needed so that binary
                   5696:        packages made using it will require the correct package
                   5697:        dependency and not settle for an older one which will not
1.87      wiz      5698:       contain the necessary shared libraries.</p>
1.110     hubertf  5699: <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   5700:        more information about dependencies on other packages,
                   5701:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5702:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5703: <p>Please take careful consideration before adjusting
                   5704:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5705:       or
                   5706:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5707:       as we don't want to cause unneeded package deletions and
                   5708:       rebuilds.  In many cases, new versions of packages work just
                   5709:       fine with older dependencies.</p>
                   5710: <p>Also it is not needed to set
1.75      rillig   5711:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5712:        when it is identical to
1.87      wiz      5713:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5714: </div>
                   5715: </div>
                   5716: <div class="sect1" lang="en">
                   5717: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5718: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5719: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5720:       coincide with headers and libraries present in the base system.
1.76      rillig   5721:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5722:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5723:       file that includes the necessary checks to decide whether using
                   5724:       the built-in software or the pkgsrc software is
1.87      wiz      5725:     appropriate.</p>
                   5726: <p>The only requirements of a builtin.mk file for
                   5727:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.75      rillig   5728: <div class="orderedlist"><ol type="1">
1.87      wiz      5729: <li><p>It should set
                   5730:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5731:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5732:        after it is included.</p></li>
                   5733: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5734:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5735:        which is already set before the
                   5736:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5737: <li><p>It should be written to allow multiple inclusion.  This
                   5738:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5739:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5740: </ol></div>
                   5741: <div class="sect2" lang="en">
                   5742: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5743: <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   5744: <p>The following is the recommended template for builtin.mk
1.87      wiz      5745:       files:</p>
1.75      rillig   5746: <pre class="programlisting">
1.100     rillig   5747: .if !defined(IS_BUILTIN.foo)
                   5748: #
                   5749: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5750: # genuinely exists in the system or not.
                   5751: #
                   5752: IS_BUILTIN.foo?=        no
                   5753: 
                   5754: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5755: # version can be determined.
                   5756: #
                   5757: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5758: BUILTIN_PKG.foo?=       foo-1.0
                   5759: .  endif
                   5760: .endif  # IS_BUILTIN.foo
                   5761: 
                   5762: .if !defined(USE_BUILTIN.foo)
                   5763: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5764: .  if defined(BUILTIN_PKG.foo)
                   5765: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5766: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5767: USE_BUILTIN.foo!=                                                       \
                   5768:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5769:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5770: .      endif
                   5771: .    endfor
                   5772: .  endif
                   5773: .endif  # USE_BUILTIN.foo
                   5774: 
                   5775: CHECK_BUILTIN.foo?=     no
                   5776: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5777: #
                   5778: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5779: # "yes" or "no".
                   5780: #
                   5781: .endif  # CHECK_BUILTIN.foo
                   5782: </pre>
1.87      wiz      5783: <p>The first section sets
                   5784:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5785:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5786:       in the base system.  This should not be a base system software
                   5787:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5788:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5789:       included as part of the base system.  This variable is only
                   5790:       used internally within the <code class="filename">builtin.mk</code>
                   5791:       file.</p>
                   5792: <p>The second section sets
                   5793:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5794:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5795:       system if it exists (if
                   5796:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5797:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5798:       within the <code class="filename">builtin.mk</code> file.</p>
                   5799: <p>The third section sets
                   5800:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5801:       and is <span class="emphasis"><em>required</em></span> in all
                   5802:       <code class="filename">builtin.mk</code> files.  The code in this
                   5803:       section must make the determination whether the built-in
                   5804:       software is adequate to satisfy the dependencies listed in
                   5805:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5806:       This is typically done by comparing
                   5807:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5808:       against each of the dependencies in
                   5809:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5810:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5811:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5812:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5813:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5814:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5815:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5816:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5817:       that the built-in version of the software is similar enough to
                   5818:       be used as a replacement.</p>
                   5819: <p>The last section is guarded by
                   5820:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5821:       and includes code that uses the value of
                   5822:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5823:       set in the previous section.  This typically includes, e.g.,
                   5824:       adding additional dependency restrictions and listing additional
                   5825:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5826:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5827: </div>
                   5828: <div class="sect2" lang="en">
                   5829: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5830: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5831: <p>When building packages, it's possible to choose whether to set
                   5832:        a global preference for using either the built-in (native)
                   5833:        version or the pkgsrc version of software to satisfy a
                   5834:        dependency.  This is controlled by setting
                   5835:        <code class="varname">PREFER_PKGSRC</code> and
                   5836:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5837:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5838:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5839:        use the pkgsrc versions of software, while
                   5840:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5841:        built-in versions.  Preferences are determined by the most
                   5842:        specific instance of the package in either
                   5843:        <code class="varname">PREFER_PKGSRC</code> or
                   5844:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5845:        in neither or in both variables, then
                   5846:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5847:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5848:        using pkgsrc versions of software for all but the most basic
                   5849:       bits on a NetBSD system, you can set:</p>
                   5850: <pre class="programlisting">
1.100     rillig   5851: PREFER_PKGSRC=  yes
                   5852: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5853: </pre>
1.87      wiz      5854: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5855:       <code class="filename">builtin.mk</code>
                   5856:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5857:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5858: </div>
                   5859: </div>
                   5860: </div>
                   5861: <div class="chapter" lang="en">
                   5862: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5863: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   5864: <div class="toc">
                   5865: <p><b>Table of Contents</b></p>
                   5866: <dl>
1.106     rillig   5867: <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   5868: <dd><dl>
1.106     rillig   5869: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5870: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   5871: </dl></dd>
1.106     rillig   5872: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   5873: <dd><dl>
1.123     snj      5874: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.106     rillig   5875: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5876: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5877: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5878: </dl></dd>
                   5879: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5880: <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>
                   5881: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5882: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5883: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5884: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5885: <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   5886: </dl>
                   5887: </div>
                   5888: <p>This chapter describes the framework known as
                   5889: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5890: <div class="itemizedlist"><ul type="disc">
                   5891: <li><p>Generic installation and manipulation of directories and files
                   5892:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5893: <li><p>Automatic handling of configuration files during installation,
                   5894:     provided that packages are correctly designed.</p></li>
                   5895: <li><p>Generation and installation of system startup scripts.</p></li>
                   5896: <li><p>Registration of system users and groups.</p></li>
                   5897: <li><p>Registration of system shells.</p></li>
                   5898: <li><p>Automatic updating of fonts databases.</p></li>
                   5899: </ul></div>
                   5900: <p>The following sections inspect each of the above points in detail.</p>
                   5901: <p>You may be thinking that many of the things described here could be
                   5902: easily done with simple code in the package's post-installation target
                   5903: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5904: as the code in them is only executed when building from source.  Machines
                   5905: using binary packages could not benefit from it at all (as the code itself
                   5906: could be unavailable).  Therefore, the only way to achieve any of the items
                   5907: described above is by means of the installation scripts, which are
                   5908: automatically generated by pkginstall.</p>
                   5909: <div class="sect1" lang="en">
                   5910: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5911: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5912: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5913: of files and directories that belong to a package.  The names used in it
1.76      rillig   5914: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5915: which means that it cannot register files outside this directory (absolute
                   5916: path names are not allowed).  Despite this restriction, some packages need
                   5917: to install files outside this location; e.g., under
1.76      rillig   5918: <code class="filename">${VARBASE}</code> or
1.87      wiz      5919: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5920: is to create such files during installation time by using
                   5921: installation scripts.</p>
                   5922: <p>The generic installation scripts are shell scripts that can
                   5923: contain arbitrary code.  The list of scripts to execute is taken from
                   5924: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5925: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5926: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5927: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5928: commands, so they have the potential to create and manage files
                   5929: anywhere in the file system.</p>
                   5930: <p>Using these general installation files is not recommended, but
                   5931: may be needed in some special cases.  One reason for avoiding them is
                   5932: that the user has to trust the packager that there is no unwanted or
                   5933: simply erroneous code included in the installation script. Also,
                   5934: previously there were many similar scripts for the same functionality,
                   5935: and fixing a common error involved finding and changing all of
                   5936: them.</p>
                   5937: <p>The pkginstall framework offers another, standardized way.  It
                   5938: provides generic scripts to abstract the manipulation of such files
                   5939: and directories based on variables set in the package's
                   5940: <code class="filename">Makefile</code>.  The rest of this section describes
                   5941: these variables.</p>
1.75      rillig   5942: <div class="sect2" lang="en">
                   5943: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5944: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5945: <p>The following variables can be set to request the creation of
                   5946: directories anywhere in the file system:</p>
                   5947: <div class="itemizedlist"><ul type="disc">
                   5948: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5949:     contain a list of directories that should be created and should attempt
                   5950:     to be destroyed by the installation scripts.  The difference between
                   5951:     the two is that the latter prompts the administrator to remove any
                   5952:     directories that may be left after deinstallation (because they were
                   5953:     not empty), while the former does not.</p></li>
                   5954: <li>
                   5955: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5956:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5957:     which directories should be created and should attempt to be destroyed
                   5958:     by the installation scripts.  Each tuple holds the following values,
                   5959:     separated by spaces: the directory name, its owner, its group and its
                   5960:     numerical mode.  For example:</p>
                   5961: <pre class="programlisting">
1.100     rillig   5962: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    5963: </pre>
1.75      rillig   5964: <p>The difference between the two is exactly the same as their
                   5965:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5966: </li>
                   5967: </ul></div>
                   5968: </div>
                   5969: <div class="sect2" lang="en">
                   5970: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5971: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5972: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5973: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5974: To overcome this problem, the only solution is to extract the file in the
                   5975: known place (i.e., inside the installation prefix) and copy it to the
                   5976: appropriate location during installation (done by the installation scripts
                   5977: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5978: file</em></span> in the following paragraphs, which describe the variables
                   5979: that can be used to automatically and consistently handle files outside the
                   5980: installation prefix:</p>
                   5981: <div class="itemizedlist"><ul type="disc">
                   5982: <li>
                   5983: <p><code class="varname">CONF_FILES</code> and
                   5984:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   5985:     During installation time, the master file is copied to the target one
                   5986:     if and only if the latter does not exist.  Upon deinstallation, the
                   5987:     target file is removed provided that it was not modified by the
                   5988:     installation.</p>
                   5989: <p>The difference between the two is that the latter prompts the
                   5990:     administrator to remove any files that may be left after
                   5991:     deinstallation (because they were not empty), while the former does
                   5992:     not.</p>
                   5993: </li>
                   5994: <li>
                   5995: <p><code class="varname">CONF_FILES_PERMS</code> and
                   5996:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   5997:     files as well as their target locations.  For each of them, it also
                   5998:     specifies their owner, their group and their numeric permissions, in
                   5999:     this order.  For example:</p>
                   6000: <pre class="programlisting">
1.100     rillig   6001: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
1.1       grant    6002: </pre>
1.75      rillig   6003: <p>The difference between the two is exactly the same as their
                   6004:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6005: </li>
                   6006: </ul></div>
                   6007: </div>
                   6008: </div>
                   6009: <div class="sect1" lang="en">
                   6010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6011: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   6012: <p>Configuration files are special in the sense that they are installed
                   6013: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6014: need special treatment during installation (most of which is automated by
                   6015: pkginstall).  The main concept you must bear in mind is that files marked
                   6016: as configuration files are automatically copied to the right place (somewhere
                   6017: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6018: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6019: be removed if they have local modifications.  This ensures that
                   6020: administrators never lose any custom changes they may have made.</p>
                   6021: <div class="sect2" lang="en">
                   6022: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6023: <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   6024: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   6025: specifies where configuration files shall be installed.  Its contents are
                   6026: set based upon the following variables:</p>
                   6027: <div class="itemizedlist"><ul type="disc">
                   6028: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   6029:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   6030:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   6031:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   6032:     Packages must not use it directly.</p></li>
                   6033: <li>
                   6034: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   6035:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   6036:     for the package being built shall be installed.  The definition of this
                   6037:     variable only makes sense in the package's
1.76      rillig   6038:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   6039: <p>As an example, consider the Apache package,
1.91      rillig   6040:     <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   6041:     configuration files under the
1.76      rillig   6042:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   6043:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   6044:     Makefile.</p>
                   6045: </li>
                   6046: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   6047:     variable that holds this package's configuration directory (if
                   6048:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   6049:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   6050:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   6051: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   6052:     directory where the configuration files for the package identified by
                   6053:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   6054: </ul></div>
                   6055: <p>Based on the above variables, pkginstall determines the value of
                   6056: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6057: variable that can be used within a package to refer to its configuration
                   6058: directory.  The algorithm used to set its value is basically the
                   6059: following:</p>
                   6060: <div class="orderedlist"><ol type="1">
                   6061: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   6062:     its value is used.</p></li>
                   6063: <li><p>If the previous variable is not defined but
                   6064:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   6065:     <code class="filename">Makefile</code>, the resulting value is
                   6066:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.75      rillig   6067: <li><p>Otherwise, it is set to
1.76      rillig   6068:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   6069: </ol></div>
1.76      rillig   6070: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117     jnemeth  6071: 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
                   6072: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6073: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   6074: </div>
                   6075: <div class="sect2" lang="en">
                   6076: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6077: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   6078: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6079: known place, you need to teach each package where it shall install its
                   6080: files.  In some cases you will have to patch the package Makefiles to
                   6081: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6082: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6083: generated files:</p>
                   6084: <pre class="programlisting">
1.100     rillig   6085: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    6086: </pre>
1.75      rillig   6087: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6088: for</em></span> its configuration files, not where they will be originally
                   6089: installed (although the difference is never explicit,
                   6090: unfortunately).</p>
                   6091: </div>
                   6092: <div class="sect2" lang="en">
                   6093: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6094: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   6095: <p>As said before, pkginstall automatically handles configuration files.
                   6096: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   6097: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   6098: directly</strong></span>.  Bad news is that many software installation scripts
                   6099: will, out of the box, mess with the contents of that directory.  So what is
                   6100: the correct procedure to fix this issue?</p>
                   6101: <p>You must teach the package (usually by manually patching it) to
                   6102: install any configuration files under the examples hierarchy,
1.76      rillig   6103: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6104: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   6105: has the original copies available.</p>
                   6106: <p>Once the required configuration files are in place (i.e., under the
                   6107: examples hierarchy), the pkginstall framework can use them as master copies
                   6108: during the package installation to update what is in
1.76      rillig   6109: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   6110: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  6111: 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   6112: about their syntax and their purpose.  Here is an example, taken from the
1.91      rillig   6113: <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   6114: <pre class="programlisting">
1.100     rillig   6115: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6116: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    6117: </pre>
1.75      rillig   6118: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6119: package and has no meaning outside it.</p>
                   6120: </div>
                   6121: <div class="sect2" lang="en">
                   6122: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6123: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   6124: <p>The automatic copying of config files can be toggled by setting the
                   6125: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6126: installation.</p>
                   6127: </div>
                   6128: </div>
                   6129: <div class="sect1" lang="en">
                   6130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6131: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   6132: <p>System startup scripts are special files because they must be
                   6133: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  6134: 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   6135: can be used.  However, pkginstall provides a special mechanism to handle
                   6136: these files.</p>
                   6137: <p>In order to provide system startup scripts, the package has
                   6138: to:</p>
                   6139: <div class="orderedlist"><ol type="1">
1.76      rillig   6140: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   6141:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.91      rillig   6142:     <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   6143:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.75      rillig   6144: <li>
                   6145: <p>Tell pkginstall to handle it, appending the name of the script,
                   6146:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6147:     Continuing the previous example:</p>
                   6148: <pre class="programlisting">
1.100     rillig   6149: RCD_SCRIPTS+=   cupsd
1.1       grant    6150: </pre>
1.75      rillig   6151: </li>
                   6152: </ol></div>
                   6153: <p>Once this is done, pkginstall will do the following steps for each
                   6154: script in an automated fashion:</p>
                   6155: <div class="orderedlist"><ol type="1">
                   6156: <li><p>Process the file found in the files directory applying all the
1.76      rillig   6157:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   6158:     variable.</p></li>
                   6159: <li><p>Copy the script from the files directory to the examples
1.76      rillig   6160:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   6161:     that this master file must be explicitly registered in the
1.76      rillig   6162:     <code class="filename">PLIST</code>.</p></li>
1.75      rillig   6163: <li><p>Add code to the installation scripts to copy the startup script
                   6164:     from the examples hierarchy into the system-wide startup scripts
                   6165:     directory.</p></li>
                   6166: </ol></div>
                   6167: <div class="sect2" lang="en">
                   6168: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6169: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   6170: <p>The automatic copying of config files can be toggled by setting the
                   6171: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6172: installation.  Note that the scripts will be always copied inside the
1.76      rillig   6173: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   6174: matter what the value of this variable is.</p>
                   6175: </div>
                   6176: </div>
                   6177: <div class="sect1" lang="en">
                   6178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6179: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   6180: <p>If a package needs to create special users and/or groups during
                   6181: installation, it can do so by using the pkginstall framework.</p>
                   6182: <p>Users can be created by adding entries to the
                   6183: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6184: syntax:</p>
                   6185: <pre class="programlisting">
1.100     rillig   6186: user:group
1.1       grant    6187: </pre>
1.87      wiz      6188: <p>Further specification of user details may be done by setting
                   6189: per-user variables.
                   6190: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6191: numeric UID for the user.
                   6192: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6193: user's description or comment.
                   6194: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6195: user's home directory, and defaults to
                   6196: <code class="filename">/nonexistent</code> if not specified.
                   6197: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 6198: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      6199: not specified.</p>
1.75      rillig   6200: <p>Similarly, groups can be created by adding entries to the
                   6201: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6202: <pre class="programlisting">
1.100     rillig   6203: group
1.1       grant    6204: </pre>
1.93      rillig   6205: <p>The numeric GID of the group may be set by defining
1.75      rillig   6206: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6207: <p>If a package needs to create the users and groups at an earlier
                   6208: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6209: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6210: indicate the phase before which the users and groups are created.  In
                   6211: this case, the numeric UIDs and GIDs of the created users and groups
                   6212: are automatically hardcoded into the final installation scripts.</p>
                   6213: </div>
                   6214: <div class="sect1" lang="en">
                   6215: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6216: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   6217: <p>Packages that install system shells should register them in the shell
1.76      rillig   6218: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   6219: administrator.  This must be done from the installation scripts to keep
                   6220: binary packages working on any system.  pkginstall provides an easy way to
                   6221: accomplish this task.</p>
                   6222: <p>When a package provides a shell interpreter, it has to set the
                   6223: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6224: add some hooks to the installation scripts to handle it.  Consider the
1.91      rillig   6225: 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   6226: <pre class="programlisting">
1.100     rillig   6227: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    6228: </pre>
1.75      rillig   6229: <div class="sect2" lang="en">
                   6230: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6231: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   6232: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   6233: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   6234: environment variable to <code class="literal">NO</code>.</p>
                   6235: </div>
                   6236: </div>
                   6237: <div class="sect1" lang="en">
                   6238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6239: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   6240: <p>Packages that install X11 fonts should update the database files
                   6241: that index the fonts within each fonts directory.  This can easily be
                   6242: accomplished within the pkginstall framework.</p>
                   6243: <p>When a package installs X11 fonts, it must list the directories in
                   6244: which fonts are installed in the
                   6245: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6246: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6247: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6248: installation scripts to run the appropriate commands to update the fonts
                   6249: database files within each of those directories.  For convenience, if the
                   6250: directory path is relative, it is taken to be relative to the package's
1.91      rillig   6251: 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   6252: <pre class="programlisting">
1.100     rillig   6253: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
1.1       grant    6254: </pre>
1.75      rillig   6255: <div class="sect2" lang="en">
                   6256: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6257: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   6258: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   6259: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   6260: environment variable to <code class="literal">NO</code>.</p>
                   6261: </div>
                   6262: </div>
                   6263: </div>
                   6264: <div class="chapter" lang="en">
                   6265: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6266: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   6267: <div class="toc">
                   6268: <p><b>Table of Contents</b></p>
                   6269: <dl>
1.106     rillig   6270: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.123     snj      6271: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.106     rillig   6272: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   6273: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   6274: </dl>
                   6275: </div>
                   6276: <p>Many packages have the ability to be built to support different
1.76      rillig   6277: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   6278: in pkgsrc that provides generic handling of those options that
                   6279: determine different ways in which the packages can be built.  It's
                   6280: possible for the user to specify exactly which sets of options will be
                   6281: built into a package or to allow a set of global default options
                   6282: apply.</p>
1.107     rillig   6283: <p>There are two broad classes of behaviors that one might want to
                   6284: control via options.  One is whether some particular feature is
                   6285: enabled in a program that will be built anyway, often by including or
                   6286: not including a dependency on some other package.  The other is
                   6287: whether or not an additional program will be built as part of the
                   6288: package.  Generally, it is better to make a split package for such
                   6289: additional programs instead of using options, because it enables
                   6290: binary packages to be built which can then be added separately.  For
                   6291: example, the foo package might have minimal dependencies (those
                   6292: packages without which foo doesn't make sense), and then the foo-gfoo
                   6293: package might include the GTK frontend program gfoo.  This is better
                   6294: than including a gtk option to foo that adds gfoo, because either that
                   6295: option is default, in which case binary users can't get foo without
                   6296: gfoo, or not default, in which case they can't get gfoo.  With split
                   6297: packages, they can install foo without having GTK, and later decide to
                   6298: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6299: source users too, avoiding the need for rebuilds.</p>
                   6300: <p>Plugins with widely varying dependencies should usually be split
                   6301: instead of options.</p>
                   6302: <p>It is often more work to maintain split packages, especially if
                   6303: the upstream package does not support this.  The decision of split
                   6304: vs. option should be made based on the likelihood that users will want
                   6305: or object to the various pieces, the size of the dependencies that are
                   6306: included, and the amount of work.</p>
                   6307: <p>A further consideration is licensing.  Non-free parts, or parts
                   6308: that depend on non-free dependencies (especially plugins) should
                   6309: almost always be split if feasible.</p>
1.75      rillig   6310: <div class="sect1" lang="en">
                   6311: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6312: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   6313: <p>Global default options are listed in
                   6314: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6315: that should be built into every package if that option is supported.
1.110     hubertf  6316: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   6317: </div>
                   6318: <div class="sect1" lang="en">
                   6319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6320: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   6321: </h2></div></div></div>
1.75      rillig   6322: <p>The following example shows how
1.76      rillig   6323: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   6324: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   6325: <code class="filename">Makefile</code>, or in a file,
                   6326: e.g. <code class="filename">options.mk</code>, that is included by the
                   6327: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   6328: <pre class="programlisting">
1.100     rillig   6329: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6330: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6331: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6332: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6333: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6334: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6335: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6336: 
                   6337: .include "../../mk/bsd.prefs.mk"
                   6338: 
                   6339: # this package was previously named wibble2
                   6340: .if defined(PKG_OPTIONS.wibble2)
                   6341: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6342: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6343:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6344: .endif
                   6345: 
                   6346: .include "../../mk/bsd.options.mk"
                   6347: 
                   6348: # Package-specific option-handling
                   6349: 
                   6350: ###
                   6351: ### FOO support
                   6352: ###
                   6353: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6354: CONFIGURE_ARGS+=    --enable-foo
                   6355: .endif
                   6356: 
                   6357: ###
                   6358: ### LDAP support
                   6359: ###
                   6360: .if !empty(PKG_OPTIONS:Mldap)
                   6361: .  include "../../databases/openldap-client/buildlink3.mk"
                   6362: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6363: .endif
                   6364: 
                   6365: ###
                   6366: ### database support
                   6367: ###
                   6368: .if !empty(PKG_OPTIONS:Mmysql)
                   6369: .  include "../../mk/mysql.buildlink3.mk"
                   6370: .endif
                   6371: .if !empty(PKG_OPTIONS:Mpgsql)
                   6372: .  include "../../mk/pgsql.buildlink3.mk"
                   6373: .endif
1.75      rillig   6374: </pre>
                   6375: <p>The first section contains the information about which build
                   6376: options are supported by the package, and any default options settings
                   6377: if needed.</p>
                   6378: <div class="orderedlist"><ol type="1">
                   6379: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.110     hubertf  6380: <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   6381: options.  It should be set to
1.78      rillig   6382: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6383: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6384: at the point where the options are processed.</p></li>
1.75      rillig   6385: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6386: build options supported by the package.</p></li>
                   6387: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6388: list of names of groups of mutually exclusive options.  The options in
                   6389: each group are listed in
                   6390: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6391: The most specific setting of any option from the group takes
                   6392: precedence over all other options in the group.  Options from the
                   6393: groups will be automatically added to
                   6394: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6395: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6396: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6397: packages will fail if no option from the group is
                   6398: selected.</p></li>
                   6399: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6400: of names of sets of options.  At least one option from each set must
                   6401: be selected.  The options in each set are listed in
                   6402: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6403: Options from the sets will be automatically added to
                   6404: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6405: fail if no option from the set is selected.</p></li>
                   6406: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6407: build options which are enabled by default.</p></li>
                   6408: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6409: of
                   6410: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.110     hubertf  6411: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   6412: their option counterparts.  Pairs should be added with
                   6413: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6414: warning will be issued if the user uses a legacy
                   6415: variable.</p></li>
                   6416: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6417: of
                   6418: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6419: pairs that map options that have been renamed to their new
                   6420: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6421: the listing of global legacy options.  A warning will be issued if
                   6422: the user uses a legacy option.</p></li>
                   6423: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6424: options implied by deprecated variables used.  This can be used for
                   6425: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6426: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6427: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6428: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6429: a list of warnings about deprecated variables or options used, and
                   6430: what to use instead.</p></li>
                   6431: </ol></div>
                   6432: <p>A package should never modify
                   6433: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6434: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6435: To suggest a default set of options, use
                   6436: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6437: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6438: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6439: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6440: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6441: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6442: happen with platform-specific options if none of them is supported on
                   6443: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6444: empty list and the package is otherwise treated as not using the
                   6445: options framework.</p>
1.76      rillig   6446: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6447: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6448: build options, properly filtered to remove unsupported and duplicate
                   6449: options.</p>
                   6450: <p>The remaining sections contain the logic that is specific to
                   6451: each option.  The correct way to check for an option is to check
                   6452: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6453: <pre class="programlisting">
1.100     rillig   6454: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6455: </pre>
                   6456: </div>
                   6457: <div class="sect1" lang="en">
                   6458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6459: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   6460: <p>Options that enable similar features in different packages (like
                   6461: optional support for a library) should use a common name in all
                   6462: packages that support it (like the name of the library).  If another
                   6463: package already has an option with the same meaning, use the same
                   6464: name.</p>
                   6465: <p>Options that enable features specific to one package, where it's
                   6466: unlikely that another (unrelated) package has the same (or a similar)
                   6467: optional feature, should use a name prefixed with
                   6468: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6469: <p>If a group of related packages share an optional feature
                   6470: specific to that group, prefix it with the name of the
                   6471: &#8220;<span class="quote">main</span>&#8221; package
                   6472: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6473: <p>For new options, add a line to
1.76      rillig   6474: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6475: fields, separated by tab.  The first field is the option name, the
                   6476: second its description.  The description should be a whole sentence
                   6477: (starting with an uppercase letter and ending with a period) that
                   6478: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6479: support.</span>&#8221; The file is sorted by option names.</p>
                   6480: </div>
1.107     rillig   6481: <div class="sect1" lang="en">
                   6482: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6483: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  6484: <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   6485: different dependencies based on the options with which the package was
                   6486: built. For querying these options, the file
                   6487: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6488: typical example looks like this:</p>
                   6489: <pre class="programlisting">
                   6490: pkgbase := libpurple
                   6491: .include "../../mk/pkg-build-options.mk"
                   6492: 
                   6493: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6494: ...
                   6495: .endif
                   6496: </pre>
                   6497: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6498: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6499: options of the libpurple package, which can then be queried like
                   6500: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6501: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6502: details.</p>
                   6503: </div>
1.75      rillig   6504: </div>
                   6505: <div class="chapter" lang="en">
                   6506: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6507: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   6508: <div class="toc">
                   6509: <p><b>Table of Contents</b></p>
                   6510: <dl>
1.106     rillig   6511: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6512: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6513: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6514: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.123     snj      6515: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.106     rillig   6516: <dd><dl>
                   6517: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6518: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6519: </dl></dd>
1.123     snj      6520: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
                   6521: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
                   6522: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
                   6523: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
                   6524: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
                   6525: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
                   6526: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
                   6527: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
                   6528: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
                   6529: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.106     rillig   6530: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6531: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   6532: </dl>
                   6533: </div>
                   6534: <div class="sect1" lang="en">
                   6535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6536: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   6537: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6538:     built. Building a package is separated into different
                   6539:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6540:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      6541:     described in the following sections. Each phase is split into
1.87      wiz      6542:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6543:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6544:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6545:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6546:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6547: <p>Never override the regular targets (like
                   6548:     <code class="varname">fetch</code>), if you have to, override the
                   6549:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6550: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6551:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6552:     the local system and then extracted. After any pkgsrc-specific patches
                   6553:     to compile properly are applied, the software can be configured, then
                   6554:     built (usually by compiling), and finally the generated binaries, etc.
                   6555:     can be put into place on the system.</p>
1.97      rillig   6556: <p>To get more details about what is happening at each step,
                   6557:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6558:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6559:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6560: </div>
                   6561: <div class="sect1" lang="en">
                   6562: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6563: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   6564: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6565:     the next section, here's a brief discussion on where programs are
                   6566:     installed, and which variables influence this.</p>
1.75      rillig   6567: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6568:     where all files of the final program shall be installed. It is
                   6569:     usually set to <code class="varname">LOCALBASE</code>
                   6570:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6571:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6572:     <code class="varname">PREFIX</code> needs to be put
                   6573:     into the various places in the program's source where paths to
1.110     hubertf  6574:     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   6575: <p>When choosing which of these variables to use,
1.87      wiz      6576:     follow the following rules:</p>
1.75      rillig   6577: <div class="itemizedlist"><ul type="disc">
1.88      wiz      6578: <li><p><code class="varname">PREFIX</code> always points to the location
                   6579:        where the current pkg will be installed.  When referring to a
                   6580:        pkg's own installation path, use
                   6581:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6582: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6583:        are installed.  If you need to construct a -I or -L argument
                   6584:        to the compiler to find includes and libraries installed by
                   6585:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
1.87      wiz      6586:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6587:        installed all packages in <code class="filename">/usr/local</code>. As
                   6588:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6589:        administrator, this variable is a misnomer.</p></li>
1.88      wiz      6590: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6591:        distribution (from xsrc, etc.) is installed. When looking for
                   6592:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6593:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6594: <li>
                   6595: <p>X11-based packages are special in that they may be
                   6596:        installed in either <code class="varname">X11BASE</code> or
                   6597:        <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   6598: <p>Usually, X11 packages should be installed under
1.88      wiz      6599:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6600:        will need to include
                   6601:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6602:        request the presence of X11 and to get the right compilation
                   6603:        flags.</p>
1.75      rillig   6604: <p>Even though, there are some packages that cannot be installed
1.87      wiz      6605:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6606:        files. These packages are special and they must be placed under
                   6607:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6608:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6609:        your package.</p>
1.75      rillig   6610: <p>Some notes: If you need
1.87      wiz      6611:        to find includes or libraries installed by a pkg that has
                   6612:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6613:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6614:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6615:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6616:        all X11 packages in <code class="varname">LOCALBASE</code>, the
1.91      rillig   6617:        <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      6618:        is enabled by default.</p>
1.75      rillig   6619: </li>
1.88      wiz      6620: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6621:        the installed location of an X11
                   6622:        package. <code class="varname">X11PREFIX</code> will be set to
                   6623:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6624:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6625:        installed.</p></li>
                   6626: <li>
                   6627: <p>If xpkgwedge is installed, it is possible to have some
                   6628:        packages installed in <code class="varname">X11BASE</code> and some in
                   6629:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6630:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6631:        definition can be used. It takes pairs in the format
1.110     hubertf  6632:        &#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      6633:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6634:        of the installed package &lt;package&gt;, or
                   6635:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6636:        installed.</p>
1.75      rillig   6637: <p>This is best illustrated by example.</p>
                   6638: <p>The following lines are taken from
1.87      wiz      6639:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6640: <pre class="programlisting">
1.100     rillig   6641: EVAL_PREFIX+=           GTKDIR=gtk+
                   6642: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6643: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6644: CONFIGURE_ARGS+=        --enable-multibyte
                   6645: </pre>
1.88      wiz      6646: <p>Specific defaults can be defined for the packages
                   6647:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6648:        definition of the form:</p>
1.75      rillig   6649: <pre class="programlisting">
1.100     rillig   6650: GTKDIR_DEFAULT= ${LOCALBASE}
                   6651: </pre>
1.75      rillig   6652: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6653:        to the first definition in
                   6654:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6655: </li>
1.76      rillig   6656: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.110     hubertf  6657:        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      6658:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6659:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6660: </ul></div>
                   6661: </div>
                   6662: <div class="sect1" lang="en">
                   6663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6664: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 6665: <p>When building a package, various directories are used to store
1.87      wiz      6666:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6667:     directories are explained here.</p>
1.75      rillig   6668: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6669:     are two common base directories for these relative directories:
                   6670:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6671:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6672:     inside the package itself.</p>
1.75      rillig   6673: <div class="variablelist"><dl>
                   6674: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6675: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6676:       root directory. Generally, you don't need
                   6677:       it.</p></dd>
1.97      rillig   6678: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6679: <dd><p>This is an absolute pathname that points to the
                   6680:       current package.</p></dd>
1.75      rillig   6681: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6682: <dd><p>This is a pathname relative to
1.87      wiz      6683:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6684:       package.</p></dd>
1.75      rillig   6685: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6686: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6687:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6688:       directory. It also contains temporary directories and log files used by
                   6689:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6690:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6691: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6692: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6693:       where the distfiles are extracted. It is usually a direct subdirectory
                   6694:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6695:       that isn't hidden. This variable may be changed by a package
                   6696:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6697: </dl></div>
1.114     jmcneill 6698: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6699:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   6700:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 6701:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6702:     If users would like to have their pkgsrc trees behave in a
                   6703:     read-only manner, then the value of
                   6704:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6705:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   6706: </div>
                   6707: <div class="sect1" lang="en">
                   6708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6709: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  6710: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      6711:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6712:     phase. This will automatically run all phases that are required for this
                   6713:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  6714:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      6715:     the package will be built, but not installed.</p>
1.75      rillig   6716: </div>
                   6717: <div class="sect1" lang="en">
                   6718: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6719: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6720: <p>The first step in building a package is to fetch the
1.88      wiz      6721:     distribution files (distfiles) from the sites that are providing
                   6722:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6723:     phase.</p>
1.81      rillig   6724: <div class="sect2" lang="en">
                   6725: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6726: <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      6727: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6728:       defines all URLs from where the distfile, whose name is
                   6729:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6730:       fetched. The more complicated cases are described
                   6731:       below.</p>
                   6732: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6733:       the list of distfiles that have to be fetched. Its value
                   6734:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6735:       so that most packages don't need to define it at all.
                   6736:       <code class="varname">EXTRACT_SUFX</code> is
                   6737:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6738:       freely. Note that if your package requires additional
                   6739:       distfiles to the default one, you cannot just append the
                   6740:       additional filenames using the <code class="literal">+=</code>
                   6741:       operator, but you have write for example:</p>
1.81      rillig   6742: <pre class="programlisting">
1.100     rillig   6743: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6744: </pre>
1.88      wiz      6745: <p>Each distfile is fetched from a list of sites, usually
                   6746:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6747:       <code class="varname">DISTFILES</code> or multiple
                   6748:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6749:       set
                   6750:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6751:       to the list of URLs where the file
                   6752:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6753:       (including the suffix) can be found.</p>
                   6754: <pre class="programlisting">
1.100     rillig   6755: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6756: DISTFILES+=     foo-file.tar.gz
                   6757: SITES.foo-file.tar.gz= \
                   6758: http://www.somewhere.com/somehow/ \
                   6759: http://www.somewhereelse.com/mirror/somehow/
                   6760: </pre>
1.81      rillig   6761: <p>When actually fetching the distfiles, each item from
1.88      wiz      6762:       <code class="varname">MASTER_SITES</code> or
                   6763:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6764:       appended to it, without an intermediate slash. Therefore,
                   6765:       all site values have to end with a slash or other separator
                   6766:       character. This allows for example to set
                   6767:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6768:       that gets the name of the distfile as a parameter. In this
                   6769:       case, the definition would look like:</p>
1.81      rillig   6770: <pre class="programlisting">
1.100     rillig   6771: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6772: </pre>
1.125   ! wiz      6773: <p> The exception to this rule are URLs starting with a dash.
        !          6774:       In that case the URL is taken as is, fetched and the result stored
        !          6775:       under the name of the distfile.</p>
1.81      rillig   6776: <p>There are some predefined values for
1.88      wiz      6777:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6778:       packages.  The names of the variables should speak for
                   6779:       themselves.</p>
                   6780: <pre class="programlisting">
1.100     rillig   6781: ${MASTER_SITE_APACHE}
                   6782: ${MASTER_SITE_BACKUP}
                   6783: ${MASTER_SITE_CYGWIN}
                   6784: ${MASTER_SITE_DEBIAN}
                   6785: ${MASTER_SITE_FREEBSD}
                   6786: ${MASTER_SITE_FREEBSD_LOCAL}
                   6787: ${MASTER_SITE_GENTOO}
                   6788: ${MASTER_SITE_GNOME}
                   6789: ${MASTER_SITE_GNU}
                   6790: ${MASTER_SITE_GNUSTEP}
                   6791: ${MASTER_SITE_IFARCHIVE}
                   6792: ${MASTER_SITE_KDE}
                   6793: ${MASTER_SITE_MOZILLA}
                   6794: ${MASTER_SITE_MYSQL}
                   6795: ${MASTER_SITE_OPENOFFICE}
                   6796: ${MASTER_SITE_PERL_CPAN}
                   6797: ${MASTER_SITE_PGSQL}
                   6798: ${MASTER_SITE_R_CRAN}
                   6799: ${MASTER_SITE_SOURCEFORGE}
                   6800: ${MASTER_SITE_SOURCEFORGE_JP}
                   6801: ${MASTER_SITE_SUNSITE}
                   6802: ${MASTER_SITE_SUSE}
                   6803: ${MASTER_SITE_TEX_CTAN}
                   6804: ${MASTER_SITE_XCONTRIB}
                   6805: ${MASTER_SITE_XEMACS}
                   6806: </pre>
1.88      wiz      6807: <p>Some explanations for the less self-explaining ones:
                   6808:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.110     hubertf  6809:       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
                   6810:       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      6811: <p>If you choose one of these predefined sites, you may
                   6812:       want to specify a subdirectory of that site. Since these
                   6813:       macros may expand to more than one actual site, you
                   6814:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6815:       specify a subdirectory:</p>
1.81      rillig   6816: <pre class="programlisting">
1.100     rillig   6817: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6818: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6819: </pre>
1.81      rillig   6820: <p>Note the trailing slash after the subdirectory
1.88      wiz      6821:       name.</p>
1.81      rillig   6822: </div>
                   6823: <div class="sect2" lang="en">
                   6824: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6825: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6826: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6827:       all the distfiles exist in a local directory
1.93      rillig   6828:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6829:       user). If the files do not exist, they are fetched using
                   6830:       commands of the form</p>
1.75      rillig   6831: <pre class="programlisting">
1.100     rillig   6832: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6833: </pre>
1.88      wiz      6834: <p>where <code class="literal">${site}</code> varies through
                   6835:       several possibilities in turn: first,
                   6836:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6837:       sites specified in either <code class="varname">SITES.file</code> if
                   6838:       defined, else <code class="varname">MASTER_SITES</code> or
                   6839:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6840:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6841:       all except the first and the last can be optionally sorted
                   6842:       by the user, via setting either
                   6843:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6844:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6845:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  6846: <p> The specific command and arguments used depend on the
                   6847:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6848:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   6849: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6850:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6851:       distfiles, if they are freely distributable.  Packages setting
                   6852:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   6853:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
                   6854:       mirrored.</p>
1.81      rillig   6855: </div>
1.75      rillig   6856: </div>
                   6857: <div class="sect1" lang="en">
                   6858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6859: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6860: <p>After the distfile(s) are fetched, their checksum is
                   6861:     generated and compared with the checksums stored in the
                   6862:     distinfo file. If the checksums don't match, the build is
                   6863:     aborted. This is to ensure the same distfile is used for
                   6864:     building, and that the distfile wasn't changed, e.g. by some
                   6865:     malign force, deliberately changed distfiles on the master
                   6866:     distribution site or network lossage.</p>
1.75      rillig   6867: </div>
                   6868: <div class="sect1" lang="en">
                   6869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6870: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6871: <p>When the distfiles are present on the local system, they
1.88      wiz      6872:     need to be extracted, as they usually come in the form of some
                   6873:     compressed archive format.</p>
1.75      rillig   6874: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6875:     extracted. If you only need some of them, you can set the
                   6876:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6877:     files.</p>
                   6878: <p>Extracting the files is usually done by a little
1.93      rillig   6879:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6880:     already knows how to extract various archive formats, so most
                   6881:     likely you will not need to change anything here. But if you
                   6882:     need, the following variables may help you:</p>
1.75      rillig   6883: <div class="variablelist"><dl>
                   6884: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6885: <dd><p>Use these variables to override the default
1.88      wiz      6886:       options for an extract command, which are defined in
1.93      rillig   6887:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6888: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6889: <dd><p>This variable can be set to
1.114     jmcneill 6890:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6891:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      6892:       absolute pathname pointing to the command with which tar
1.114     jmcneill 6893:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6894:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   6895: </dl></div>
1.88      wiz      6896: <p>If the <code class="filename">extract</code> program doesn't
                   6897:     serve your needs, you can also override the
                   6898:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6899:     command used for extracting the files. This command is
                   6900:     executed in the <code class="filename">${WRKSRC}</code>
                   6901:     directory. During execution of this command, the shell
                   6902:     variable <code class="varname">extract_file</code> holds the absolute
                   6903:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6904: <p>And if that still does not suffice, you can override the
1.88      wiz      6905:     <code class="varname">do-extract</code> target in the package
                   6906:     Makefile.</p>
1.75      rillig   6907: </div>
                   6908: <div class="sect1" lang="en">
                   6909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6910: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6911: <p>After extraction, all the patches named by the
1.88      wiz      6912:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6913:     subdirectory of the package as well as in
                   6914:     $LOCALPATCHES/$PKGPATH (e.g.
                   6915:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6916:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6917:     <code class="filename">.gz</code> are uncompressed before they are
                   6918:     applied, files ending in <code class="filename">.orig</code> or
                   6919:     <code class="filename">.rej</code> are ignored. Any special options to
1.110     hubertf  6920:     <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
                   6921:     <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>
                   6922: <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      6923:     it fail if the patches apply with some lines of fuzz. Please
                   6924:     fix (regen) the patches so that they apply cleanly. The
                   6925:     rationale behind this is that patches that don't apply cleanly
                   6926:     may end up being applied in the wrong place, and cause severe
                   6927:     harm there.</p>
1.75      rillig   6928: </div>
                   6929: <div class="sect1" lang="en">
                   6930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6931: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  6932: <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      6933:     </p>
1.75      rillig   6934: </div>
                   6935: <div class="sect1" lang="en">
                   6936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6937: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6938: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6939:     linkers. The following variables can be used to tweak the
                   6940:     wrappers.</p>
1.75      rillig   6941: <div class="variablelist"><dl>
                   6942: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6943: <dd><p>The command used to print progress
1.88      wiz      6944:       messages. Does nothing by default. Set to
                   6945:       <code class="literal">${ECHO}</code> to see the progress
                   6946:       messages.</p></dd>
1.75      rillig   6947: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6948: <dd><p>This variable can be set to
1.88      wiz      6949:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6950:       depending on whether you want additional information in the
                   6951:       wrapper log file.</p></dd>
1.75      rillig   6952: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6953: <dd><p>This variable can be set to
1.88      wiz      6954:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6955:       on whether the wrapper should use its cache, which will
                   6956:       improve the speed. The default value is
                   6957:       <code class="literal">yes</code>, but is forced to
                   6958:       <code class="literal">no</code> if the platform does not support
                   6959:       it.</p></dd>
1.75      rillig   6960: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6961: <dd><p>A list of reordering commands. A reordering
                   6962:       command has the form
                   6963:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6964:       It ensures that that
                   6965:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6966:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6967:       </p></dd>
1.75      rillig   6968: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6969: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6970:       investigate further]</p></dd>
1.75      rillig   6971: </dl></div>
                   6972: </div>
                   6973: <div class="sect1" lang="en">
                   6974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6975: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6976: <p>Most pieces of software need information on the header
                   6977:     files, system calls, and library routines which are available
                   6978:     on the platform they run on. The process of determining this
                   6979:     information is known as configuration, and is usually
                   6980:     automated. In most cases, a script is supplied with the
                   6981:     distfiles, and its invocation results in generation of header
                   6982:     files, Makefiles, etc.</p>
                   6983: <p>If the package contains a configure script, this can be
                   6984:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6985:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6986:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   6987:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   6988:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6989: <pre class="programlisting">
1.100     rillig   6990: .for d in ${CONFIGURE_DIRS}
                   6991:         cd ${WRKSRC} \
                   6992:         &amp;&amp; cd ${d} \
                   6993:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6994: .endfor
                   6995: </pre>
1.88      wiz      6996: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   6997:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   6998:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6999:     configure script is run with the environment
                   7000:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   7001:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   7002:     <code class="varname">CONFIGURE_ENV</code>,
                   7003:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   7004:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   7005:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   7006:     package.</p>
                   7007: <p>If the program uses an <code class="filename">Imakefile</code>
                   7008:     for configuration, the appropriate steps can be invoked by
                   7009:     setting <code class="varname">USE_IMAKE</code> to
                   7010:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   7011:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
1.97      rillig   7012:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   7013:     xmkmf's environment by adding them to the
                   7014:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   7015: <p>If the program uses <code class="filename">cmake</code>
                   7016:     for configuration, the appropriate steps can be invoked by
                   7017:     setting <code class="varname">USE_CMAKE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7018:     You can add variables to cmake's environment by adding them to the
                   7019:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   7020:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   7021:     The top directory argument is given by the
                   7022:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   7023:     &#8220;<span class="quote">.</span>&#8221; (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   7024: <p>If there is no configure step at all, set
                   7025:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   7026: </div>
                   7027: <div class="sect1" lang="en">
                   7028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7029: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      7030: <p>For building a package, a rough equivalent of the
                   7031:     following code is executed.</p>
1.75      rillig   7032: <pre class="programlisting">
1.100     rillig   7033: .for d in ${BUILD_DIRS}
                   7034:         cd ${WRKSRC} \
                   7035:         &amp;&amp; cd ${d} \
                   7036:         &amp;&amp; env ${MAKE_ENV} \
                   7037:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   7038:                 -f ${MAKE_FILE} \
                   7039:                 ${BUILD_TARGET}
                   7040: .endfor
                   7041: </pre>
1.88      wiz      7042: <p><code class="varname">BUILD_DIRS</code> (default:
                   7043:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   7044:     <code class="varname">WRKSRC</code>. In each of these directories,
                   7045:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   7046:     <code class="varname">MAKE_ENV</code> and arguments
                   7047:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   7048:     <code class="varname">MAKE_ENV</code>,
                   7049:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   7050:     <code class="varname">MAKE_FILE</code> and
                   7051:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   7052:     package.</p>
1.75      rillig   7053: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.88      wiz      7054:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   7055:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   7056:     default value of <code class="varname">MAKE_FILE</code> is
                   7057:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   7058:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
1.97      rillig   7059: <p>If there is no build step at all, set
                   7060:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
1.75      rillig   7061: </div>
                   7062: <div class="sect1" lang="en">
                   7063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7064: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   7065: <p>[TODO]</p>
                   7066: </div>
                   7067: <div class="sect1" lang="en">
                   7068: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7069: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   7070: <p>Once the build stage has completed, the final step is to
1.88      wiz      7071:     install the software in public directories, so users can
                   7072:     access the programs and files.</p>
1.75      rillig   7073: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      7074:     equivalent of the following code is executed. Additionally,
                   7075:     before and after this code, much magic is performed to do
                   7076:     consistency checks, registering the package, and so on.</p>
                   7077: <pre class="programlisting">
1.100     rillig   7078: .for d in ${INSTALL_DIRS}
                   7079:         cd ${WRKSRC} \
                   7080:         &amp;&amp; cd ${d} \
                   7081:         &amp;&amp; env ${MAKE_ENV} \
                   7082:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7083:                 -f ${MAKE_FILE} \
                   7084:                 ${INSTALL_TARGET}
                   7085: .endfor
                   7086: </pre>
1.75      rillig   7087: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      7088:     <span class="emphasis"><em>build</em></span> phase.
                   7089:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7090:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   7091:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   7092:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   7093:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7094:     defined.</p>
1.75      rillig   7095: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      7096:     variables are useful. They are all variations of the
1.110     hubertf  7097:     <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      7098:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7099:     install command. The specialized variants, together with their
                   7100:     intended use, are:</p>
1.75      rillig   7101: <div class="variablelist"><dl>
                   7102: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      7103: <dd><p>directories that contain
                   7104:       binaries</p></dd>
1.75      rillig   7105: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      7106: <dd><p>directories that contain
                   7107:       scripts</p></dd>
1.75      rillig   7108: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      7109: <dd><p>directories that contain shared and static
                   7110:       libraries</p></dd>
1.75      rillig   7111: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      7112: <dd><p>directories that contain data
                   7113:       files</p></dd>
1.75      rillig   7114: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      7115: <dd><p>directories that contain man
                   7116:       pages</p></dd>
1.75      rillig   7117: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      7118: <dd><p>binaries that can be stripped from debugging
                   7119:       symbols</p></dd>
1.75      rillig   7120: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      7121: <dd><p>binaries that cannot be
                   7122:       stripped</p></dd>
1.75      rillig   7123: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      7124: <dd><p>game
                   7125:       binaries</p></dd>
1.75      rillig   7126: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      7127: <dd><p>shared and static
                   7128:       libraries</p></dd>
1.75      rillig   7129: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7130: <dd><p>data files</p></dd>
                   7131: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      7132: <dd><p>data files for
                   7133:       games</p></dd>
1.75      rillig   7134: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7135: <dd><p>man pages</p></dd>
                   7136: </dl></div>
                   7137: <p>Some other variables are:</p>
                   7138: <div class="variablelist"><dl>
                   7139: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7140: <dd><p>A list of directories relative to
1.88      wiz      7141:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      7142:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7143:       The package is supposed to create all needed directories itself
                   7144:       before installing files to it and list all other directories here.
                   7145:       </p></dd>
1.75      rillig   7146: </dl></div>
1.97      rillig   7147: <p>In the rare cases that a package shouldn't install anything,
                   7148:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
                   7149:     mostly relevant for packages in the <code class="filename">regress</code>
                   7150:     category.</p>
1.75      rillig   7151: </div>
                   7152: <div class="sect1" lang="en">
                   7153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7154: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      7155: <p>Once the install stage has completed, a binary package of
                   7156:     the installed files can be built.  These binary packages can be
                   7157:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  7158:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7159:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      7160: <p>By default, the binary packages are created in
                   7161:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7162:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7163:     one for each category in the <code class="varname">CATEGORIES</code>
                   7164:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7165:     <code class="filename">pkgsrc/packages</code>.</p>
                   7166: </div>
                   7167: <div class="sect1" lang="en">
                   7168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7169: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      7170: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  7171:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      7172:     to clean the work directories of all dependencies too, use
1.110     hubertf  7173:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   7174: </div>
                   7175: <div class="sect1" lang="en">
                   7176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7177: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.75      rillig   7178: <div class="variablelist"><dl>
                   7179: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      7180: <dd><p>For any of the main targets described in the
                   7181:          previous section, two auxiliary targets exist with
1.87      wiz      7182:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7183:          prefix for the main target's name.  These targets are
1.88      wiz      7184:          invoked before and after the main target is called,
                   7185:          allowing extra configuration or installation steps be
                   7186:          performed from a package's Makefile, for example, which
                   7187:          a program's configure script or install target
                   7188:          omitted.</p></dd>
1.75      rillig   7189: <dt><span class="term">do-*</span></dt>
1.88      wiz      7190: <dd><p>Should one of the main targets do the wrong thing,
                   7191:          and should there be no variable to fix this, you can
                   7192:          redefine it with the do-* target.  (Note that redefining
                   7193:          the target itself instead of the do-* target is a bad
                   7194:          idea, as the pre-* and post-* targets won't be called
                   7195:          anymore, etc.) You will not usually need to do
                   7196:          this.</p></dd>
1.75      rillig   7197: <dt><span class="term">reinstall</span></dt>
1.88      wiz      7198: <dd>
1.110     hubertf  7199: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      7200:          you noticed some file was not installed properly, you
                   7201:          can repeat the installation with this target, which will
                   7202:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7203: <p>This is the default value of
                   7204:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  7205:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      7206:          package</strong></span>, where the defaults are
                   7207:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7208:          respectively.</p>
                   7209: </dd>
1.75      rillig   7210: <dt><span class="term">deinstall</span></dt>
                   7211: <dd>
1.110     hubertf  7212: <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      7213:          current directory, effectively de-installing the
                   7214:          package. The following variables can be used to tune the
                   7215:          behaviour:</p>
1.75      rillig   7216: <div class="variablelist"><dl>
                   7217: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.110     hubertf  7218: <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   7219: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      7220: <dd><p>Remove all packages that require (depend on)
                   7221:                the given package.  This can be used to remove any
                   7222:                packages that may have been pulled in by a given
1.110     hubertf  7223:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      7224:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      7225:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7226:                likely to remove whole KDE. Works by adding
1.110     hubertf  7227:                &#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      7228:                command line.</p></dd>
1.75      rillig   7229: </dl></div>
                   7230: </dd>
1.88      wiz      7231: <dt><span class="term">bin-install</span></dt>
                   7232: <dd><p>Install a binary package from local disk and via FTP
                   7233:          from a list of sites (see the
                   7234:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  7235:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      7236:          available anywhere.  The arguments given to
1.110     hubertf  7237:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      7238:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7239:          operation, etc.</p></dd>
1.75      rillig   7240: <dt><span class="term">update</span></dt>
                   7241: <dd>
1.88      wiz      7242: <p>This target causes the current package to be
                   7243:          updated to the latest version.  The package and all
                   7244:          depending packages first get de-installed, then current
                   7245:          versions of the corresponding packages get compiled and
                   7246:          installed.  This is similar to manually noting which
                   7247:          packages are currently installed, then performing a
1.110     hubertf  7248:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7249:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      7250:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7251:          packages.</p>
                   7252: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
1.110     hubertf  7253:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      7254:          update</strong></span> was interrupted for some reason.
                   7255:          However, in this case, make sure you don't call
1.110     hubertf  7256:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      7257:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7258:          Otherwise, you lose the ability to automatically update
                   7259:          the current package along with the dependent packages
                   7260:          you have installed.</p>
1.110     hubertf  7261: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      7262:          update</strong></span> will only work as long as the package
                   7263:          tree remains unchanged.  If the source code for one of
                   7264:          the packages to be updated has been changed, resuming
1.110     hubertf  7265:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      7266:          fail!</p>
                   7267: <p>The following variables can be used either on the
1.110     hubertf  7268:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7269:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      7270:          update</strong></span>:</p>
1.75      rillig   7271: <div class="variablelist"><dl>
                   7272: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      7273: <dd><p>Install target to recursively use for the
                   7274:                updated package and the dependent packages.
                   7275:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7276:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
1.110     hubertf  7277:                <span class="command"><strong>make update</strong></span>.  Other good
1.88      wiz      7278:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7279:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7280:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7281:                endless loop!</p></dd>
1.75      rillig   7282: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      7283: <dd><p>Don't clean up after updating.  Useful if
                   7284:                you want to leave the work sources of the updated
                   7285:                packages around for inspection or other purposes.
                   7286:                Be sure you eventually clean up the source tree
                   7287:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7288:                or you may run into troubles with old source code
                   7289:                still lying around on your next
1.110     hubertf  7290:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      7291:                update</strong></span>.</p></dd>
1.75      rillig   7292: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      7293: <dd><p>Deinstall each package before installing
                   7294:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7295:                may be necessary if the
                   7296:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
1.110     hubertf  7297:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      7298:                update</strong></span>.</p></dd>
1.75      rillig   7299: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      7300: <dd><p>Allows you to disable recursion and hardcode
                   7301:                the target for packages.  The default is
                   7302:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7303:                facilitating a recursive update of prerequisite
                   7304:                packages.  Only set
                   7305:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7306:                disable recursive updates. Use
                   7307:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7308:                set a specific target for each package to be
1.110     hubertf  7309:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      7310:                (see above).</p></dd>
1.75      rillig   7311: </dl></div>
                   7312: </dd>
                   7313: <dt><span class="term">clean-update</span></dt>
                   7314: <dd>
1.88      wiz      7315: <p>Clean the source tree for all packages that would
1.110     hubertf  7316:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      7317:          from the current directory.  This target should not be
                   7318:          used if the current package (or any of its depending
                   7319:          packages) have already been de-installed (e.g., after
1.110     hubertf  7320:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      7321:          some packages you intended to update. As a rule of
                   7322:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  7323:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      7324:          and only if you have a dirty package tree (e.g., if you
                   7325:          used <code class="varname">NOCLEAN</code>).</p>
                   7326: <p>If you are unsure about whether your tree is
1.110     hubertf  7327:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      7328:          clean</strong></span> at the top of the tree, or use the
                   7329:          following sequence of commands from the directory of the
                   7330:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  7331:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      7332:          time, otherwise you lose all the packages you wanted to
                   7333:          update!):</p>
1.87      wiz      7334: <pre class="screen">
                   7335: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   7336: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      7337: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7338:          </pre>
1.88      wiz      7339: <p>The following variables can be used either on the
1.110     hubertf  7340:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7341:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.75      rillig   7342: <div class="variablelist"><dl>
                   7343: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  7344: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      7345:                reconstruct the list of directories to update for
1.110     hubertf  7346:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      7347:                update</strong></span> successfully installed all
                   7348:                packages you wanted to update.  Normally, this is
1.110     hubertf  7349:                done automatically on <span class="command"><strong>make
1.88      wiz      7350:                update</strong></span>, but may have been suppressed by
                   7351:                the <code class="varname">NOCLEAN</code> variable (see
                   7352:                above).</p></dd>
1.75      rillig   7353: </dl></div>
                   7354: </dd>
1.88      wiz      7355: <dt><span class="term">replace</span></dt>
                   7356: <dd>
                   7357: <p>Update the installation of the current package.  This
                   7358:          differs from update in that it does not replace dependent
1.93      rillig   7359:          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      7360:          target to work.</p>
                   7361: <p><span class="emphasis"><em>Be careful when using this
                   7362:          target!</em></span> There are no guarantees that dependent
                   7363:          packages will still work, in particular they will most
1.110     hubertf  7364:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      7365:          library package whose shared library major version changed
                   7366:          between your installed version and the new one.  For this
                   7367:          reason, this target is not officially supported and only
                   7368:          recommended for advanced users.</p>
                   7369: </dd>
1.75      rillig   7370: <dt><span class="term">info</span></dt>
1.110     hubertf  7371: <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      7372:          package. You can use this to check which version of a
                   7373:          package is installed.</p></dd>
                   7374: <dt><span class="term">index</span></dt>
                   7375: <dd>
                   7376: <p>This is a top-level command, i.e. it should be used in
                   7377:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7378:          database of all packages in the local pkgsrc tree, including
                   7379:          dependencies, comment, maintainer, and some other useful
                   7380:          information.  Individual entries are created by running
1.110     hubertf  7381:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      7382:          directories.  This index file is saved as
                   7383:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  7384:          verbose format by running <span class="command"><strong>make
1.88      wiz      7385:          print-index</strong></span>.  You can search in it with
1.110     hubertf  7386:          <span class="command"><strong>make search
1.88      wiz      7387:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7388:          extract a list of all packages that depend on a particular
1.110     hubertf  7389:          one by running <span class="command"><strong>make show-deps
1.88      wiz      7390:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7391: <p>Running this command takes a very long time, some
                   7392:          hours even on fast machines!</p>
                   7393: </dd>
1.75      rillig   7394: <dt><span class="term">readme</span></dt>
1.88      wiz      7395: <dd>
                   7396: <p>This target generates a
                   7397:          <code class="filename">README.html</code> file, which can be
1.91      rillig   7398:          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      7399:          contain references to any packages which are in the
                   7400:          <code class="varname">PACKAGES</code> directory on the local
                   7401:          host. The generated files can be made to refer to URLs
                   7402:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7403:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7404:          wanted to generate <code class="filename">README.html</code>
                   7405:          files which pointed to binary packages on the local
                   7406:          machine, in the directory
                   7407:          <code class="filename">/usr/packages</code>, set
                   7408:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7409:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7410:          <code class="varname">${PACKAGES}</code> directory and its
                   7411:          subdirectories will be searched for all the binary
                   7412:          packages.</p>
                   7413: <p>The target can be run at the toplevel or in category
                   7414:          directories, in which case it descends recursively.</p>
                   7415: </dd>
1.75      rillig   7416: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7417: <dd><p>This is a top-level command, run it in
                   7418:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7419:          file <code class="filename">README-all.html</code> which contains a
                   7420:          list of all packages currently available in the NetBSD
                   7421:          Packages Collection, together with the category they belong
                   7422:          to and a short description. This file is compiled from the
                   7423:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  7424:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      7425:          readme</strong></span>.</p></dd>
1.75      rillig   7426: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7427: <dd><p>This is very much the same as the
                   7428:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7429:          used when generating a pkgsrc tree to be written to a
                   7430:          CD-ROM.  This target also produces
                   7431:          <code class="filename">README.html</code> files, and can be made
                   7432:          to refer to URLs based on
                   7433:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7434:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7435: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7436: <dd><p>This target shows which distfiles and patchfiles
                   7437:          are needed to build the package
                   7438:          (<code class="varname">ALLFILES</code>, which contains all
                   7439:          <code class="varname">DISTFILES</code> and
1.87      wiz      7440:          <code class="varname">PATCHFILES</code>, but not
                   7441:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7442: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7443: <dd><p>This target shows nothing if the package is not
                   7444:          installed. If a version of this package is installed,
                   7445:          but is not the version provided in this version of
                   7446:          pkgsrc, then a warning message is displayed. This target
                   7447:          can be used to show which of your installed packages are
                   7448:          downlevel, and so the old versions can be deleted, and
                   7449:          the current ones added.</p></dd>
1.75      rillig   7450: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7451: <dd><p>This target shows the directory in the pkgsrc
                   7452:          hierarchy from which the package can be built and
                   7453:          installed. This may not be the same directory as the one
                   7454:          from which the package was installed. This target is
                   7455:          intended to be used by people who may wish to upgrade
                   7456:          many packages on a single host, and can be invoked from
                   7457:          the top-level pkgsrc Makefile by using the
1.87      wiz      7458:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
1.75      rillig   7459: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7460: <dd><p>This target shows which installed packages match
                   7461:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7462:          if out of date dependencies are causing build
                   7463:          problems.</p></dd>
1.75      rillig   7464: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7465: <dd><p>After a package is installed, check all its
                   7466:          binaries and (on ELF platforms) shared libraries to see
                   7467:          if they find the shared libs they need.  Run by default
1.110     hubertf  7468:          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   7469: <dt><span class="term">print-PLIST</span></dt>
                   7470: <dd>
                   7471: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
1.88      wiz      7472:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  7473:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      7474:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7475:          to care for shared libs etc., but it is
1.87      wiz      7476:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7477:          result before putting it into
                   7478:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7479:          diff the output of this command against an already
                   7480:          existing <code class="filename">PLIST</code> file.</p>
1.110     hubertf  7481: <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      7482:          other methods that don't update file access times, be
                   7483:          sure to add these files manually to your
1.87      wiz      7484:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7485:          -newer</span>&#8221; command used by this target won't catch
                   7486:          them!</p>
1.123     snj      7487: <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      7488:          information on this target.</p>
1.75      rillig   7489: </dd>
                   7490: <dt><span class="term">bulk-package</span></dt>
                   7491: <dd>
1.88      wiz      7492: <p>Used to do bulk builds. If an appropriate binary
                   7493:          package already exists, no action is taken. If not, this
                   7494:          target will compile, install and package it (and its
                   7495:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.110     hubertf  7496:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.88      wiz      7497:          After creating the binary package, the sources, the
                   7498:          just-installed package and its required packages are
                   7499:          removed, preserving free disk space.</p>
                   7500: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7501:          all packages installed on a system!</em></span></p>
1.75      rillig   7502: </dd>
                   7503: <dt><span class="term">bulk-install</span></dt>
                   7504: <dd>
1.88      wiz      7505: <p>Used during bulk-installs to install required
                   7506:          packages. If an up-to-date binary package is available,
1.110     hubertf  7507:          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,
                   7508:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      7509:          but the installed binary won't be removed.</p>
1.88      wiz      7510: <p>A binary package is considered
                   7511:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
1.110     hubertf  7512:          <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      7513: <div class="itemizedlist"><ul type="disc">
                   7514: <li><p>None of the package's files
                   7515:              (<code class="filename">Makefile</code>, ...) were modified
                   7516:              since it was built.</p></li>
                   7517: <li><p>None of the package's required (binary)
                   7518:              packages were modified since it was built.</p></li>
1.75      rillig   7519: </ul></div>
1.88      wiz      7520: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7521:          all packages installed on a system!</em></span></p>
1.75      rillig   7522: </dd>
                   7523: </dl></div>
                   7524: </div>
                   7525: </div>
                   7526: <div class="chapter" lang="en">
                   7527: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7528: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7529: <div class="toc">
                   7530: <p><b>Table of Contents</b></p>
                   7531: <dl>
1.106     rillig   7532: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7533: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7534: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7535: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7536: </dl>
                   7537: </div>
1.87      wiz      7538: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7539: by pkgsrc and also for individual packages to define what commands
                   7540: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7541: or for later run-time of an installed packaged (such as
                   7542: <code class="varname">DEPENDS</code>).
                   7543: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7544: package will not be used.</p>
                   7545: <p>When building a package, the replacement tools are
1.75      rillig   7546: made available in a directory (as symlinks or wrapper scripts)
                   7547: that is early in the executable search path. Just like the buildlink
1.87      wiz      7548: system, this helps with consistent builds.</p>
                   7549: <p>A tool may be needed to help build a specific package. For example,
                   7550: perl, GNU make (gmake) or yacc may be needed.</p>
                   7551: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7552: tool may be inefficient for building a package with pkgsrc.
                   7553: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7554: yacc) or a better sed.</p>
                   7555: <p>The tools used by a package can be listed by running
1.110     hubertf  7556: <span class="command"><strong>make show-tools</strong></span>.</p>
1.75      rillig   7557: <div class="sect1" lang="en">
                   7558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7559: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7560: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7561: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  7562: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7563: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   7564: These can be seen by running:
1.110     hubertf  7565: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      7566: <p>If a package needs a specific program to build
1.75      rillig   7567: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7568: to define the tools needed.</p>
1.75      rillig   7569: </div>
                   7570: <div class="sect1" lang="en">
                   7571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7572: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.87      wiz      7573: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
1.75      rillig   7574: and not the native version for a build dependency.
                   7575: And the :run means that it is used for a
                   7576: run-time dependencies also (and becomes a DEPENDS).
                   7577: The default is a build dependency which can be set with
                   7578: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7579: and pkg-config:build.)</p>
1.75      rillig   7580: <pre class="programlisting">
                   7581: USE_TOOLS+=     mktemp:pkgsrc
                   7582: USE_TOOLS+=     gmake perl:run pkg-config
                   7583: </pre>
1.87      wiz      7584: <p>When using the tools framework, a
1.75      rillig   7585: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7586: which contains the full path to the appropriate tool. For example,
                   7587: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
1.87      wiz      7588: on Linux systems.</p>
                   7589: <p>If you always need a pkgsrc version of the
1.75      rillig   7590: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7591: </p>
                   7592: </div>
                   7593: <div class="sect1" lang="en">
                   7594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7595: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7596: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7597: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7598: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7599: the name of the common tools. For example:</p>
                   7600: <pre class="programlisting">
                   7601: .if exists(/usr/bin/bzcat)
                   7602: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7603: .elif exists(/usr/bin/bzip2)
                   7604: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7605: .endif
1.69      rillig   7606: 
1.75      rillig   7607: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7608: </pre>
                   7609: </div>
1.97      rillig   7610: <div class="sect1" lang="en">
                   7611: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7612: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.97      rillig   7613: <div class="qandaset">
                   7614: <dl>
1.106     rillig   7615: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97      rillig   7616: </dt>
1.106     rillig   7617: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97      rillig   7618:        tools?</a>
                   7619: </dt>
1.106     rillig   7620: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97      rillig   7621:        package is using while being built? I want to know whether it
                   7622:        uses sed or not.</a>
                   7623: </dt>
                   7624: </dl>
                   7625: <table border="0" summary="Q and A Set">
                   7626: <col align="left" width="1%">
                   7627: <tbody>
                   7628: <tr class="question">
                   7629: <td align="left" valign="top">
1.125   ! wiz      7630: <a name="tools.new"></a><a name="id1168230298940"></a><p><b>18.4.1.</b></p>
1.97      rillig   7631: </td>
                   7632: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7633: </tr>
                   7634: <tr class="answer">
                   7635: <td align="left" valign="top"></td>
                   7636: <td align="left" valign="top"><p>TODO</p></td>
                   7637: </tr>
                   7638: <tr class="question">
                   7639: <td align="left" valign="top">
1.125   ! wiz      7640: <a name="tools.listall"></a><a name="id1168230298949"></a><p><b>18.4.2.</b></p>
1.97      rillig   7641: </td>
                   7642: <td align="left" valign="top"><p>How do I get a list of all available
                   7643:        tools?</p></td>
                   7644: </tr>
                   7645: <tr class="answer">
                   7646: <td align="left" valign="top"></td>
                   7647: <td align="left" valign="top"><p>TODO</p></td>
                   7648: </tr>
                   7649: <tr class="question">
                   7650: <td align="left" valign="top">
1.125   ! wiz      7651: <a name="tools.used"></a><a name="id1168230298957"></a><p><b>18.4.3.</b></p>
1.97      rillig   7652: </td>
                   7653: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7654:        package is using while being built? I want to know whether it
                   7655:        uses sed or not.</p></td>
                   7656: </tr>
                   7657: <tr class="answer">
                   7658: <td align="left" valign="top"></td>
                   7659: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7660:        to do it.)</p></td>
                   7661: </tr>
                   7662: </tbody>
                   7663: </table>
                   7664: </div>
                   7665: </div>
1.75      rillig   7666: </div>
                   7667: <div class="chapter" lang="en">
                   7668: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7669: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   7670: <div class="toc">
                   7671: <p><b>Table of Contents</b></p>
                   7672: <dl>
1.106     rillig   7673: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   7674: <dd><dl>
1.106     rillig   7675: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.123     snj      7676: <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   7677: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7678: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7679: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7680: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7681: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7682: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7683: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7684: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7685: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7686: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7687: </dl></dd>
1.123     snj      7688: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.106     rillig   7689: <dd><dl>
                   7690: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7691: <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>
                   7692: </dl></dd>
1.123     snj      7693: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.106     rillig   7694: <dd><dl>
                   7695: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7696: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7697: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7698: </dl></dd>
                   7699: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7700: <dd><dl>
                   7701: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7702: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7703: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   7704: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   7705: </dl></dd>
1.123     snj      7706: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.106     rillig   7707: <dd><dl>
                   7708: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7709: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.123     snj      7710: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.106     rillig   7711: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7712: </dl></dd>
1.123     snj      7713: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.106     rillig   7714: <dd><dl>
                   7715: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7716: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7717: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7718: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7719: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7720: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7721: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7722: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   7723: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   7724: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   7725: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7726: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7727: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7728: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7729: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7730: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7731: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7732: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      7733:     emulation</a></span></dt>
1.106     rillig   7734: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7735: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7736: </dl></dd>
1.106     rillig   7737: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7738: </dl>
                   7739: </div>
                   7740: <div class="sect1" lang="en">
                   7741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7742: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.75      rillig   7743: <div class="sect2" lang="en">
                   7744: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7745: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.78      rillig   7746: <p>One appealing feature of pkgsrc is that it runs on many
1.87      wiz      7747:     different platforms. As a result, it is important to ensure,
                   7748:     where possible, that packages in pkgsrc are portable. This
                   7749:     chapter mentions some particular details you should pay
                   7750:     attention to while working on pkgsrc.</p>
1.78      rillig   7751: </div>
                   7752: <div class="sect2" lang="en">
                   7753: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  7754: <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   7755: </h3></div></div></div>
1.78      rillig   7756: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7757:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7758:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7759:     want to use those variables in the preprocessor directives of
1.110     hubertf  7760:     <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      7761:     <code class="literal">.for</code>), you need to include the file
                   7762:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7763:     loads the user preferences.</p>
1.78      rillig   7764: <p>But note that some variables may not be completely defined
1.87      wiz      7765:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7766:     included, as they may contain references to variables that are
                   7767:     not yet defined. In shell commands this is no problem, since
                   7768:     variables are actually macros, which are only expanded when they
                   7769:     are used. But in the preprocessor directives mentioned above and
                   7770:     in dependency lines (of the form <code class="literal">target:
                   7771:     dependencies</code>) the variables are expanded at load
                   7772:     time.</p>
1.78      rillig   7773: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7774: <h3 class="title">Note</h3>
                   7775: <p>Currently there is no exhaustive list of all
1.87      wiz      7776:     variables that tells you whether they can be used at load time
                   7777:     or only at run time, but it is in preparation.</p>
1.78      rillig   7778: </div>
                   7779: </div>
                   7780: <div class="sect2" lang="en">
                   7781: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7782: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.88      wiz      7783: <p>Occasionally, packages require interaction from the user,
                   7784:     and this can be in a number of ways:</p>
1.78      rillig   7785: <div class="itemizedlist"><ul type="disc">
1.79      rillig   7786: <li><p>When fetching the distfiles, some packages require user
1.87      wiz      7787:        interaction such as entering username/password or accepting a
                   7788:        license on a web page.</p></li>
1.88      wiz      7789: <li><p>When extracting the distfiles, some packages may ask for
                   7790:        passwords.</p></li>
1.78      rillig   7791: <li><p>help to configure the package before it is built</p></li>
                   7792: <li><p>help during the build process</p></li>
                   7793: <li><p>help during the installation of a package</p></li>
                   7794: </ul></div>
1.88      wiz      7795: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7796:     provided to notify the pkgsrc mechanism of an interactive stage
                   7797:     which will be needed, and this should be set in the package's
                   7798:     <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7799: <pre class="programlisting">
1.100     rillig   7800: INTERACTIVE_STAGE=      build
1.87      wiz      7801:     </pre>
1.78      rillig   7802: <p>Multiple interactive stages can be specified:</p>
1.75      rillig   7803: <pre class="programlisting">
1.100     rillig   7804: INTERACTIVE_STAGE=      configure install
1.87      wiz      7805:     </pre>
1.88      wiz      7806: <p>The user can then decide to skip this package by setting the
                   7807:     <code class="varname">BATCH</code> variable.</p>
1.75      rillig   7808: </div>
                   7809: <div class="sect2" lang="en">
                   7810: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7811: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.98      wiz      7812: <p>Authors of software can choose the licence under which
                   7813:     software can be copied.  This is due to copyright law, and reasons
                   7814:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7815:     system recognizes that there are a number of licenses which some
                   7816:     users may find objectionable or difficult or impossible to comply
                   7817:     with.  The Free Software Foundation has declared some licenses
                   7818:     "Free", and the Open Source Initiative has a definition of "Open
                   7819:     Source".  The pkgsrc system, as a policy choice, does not label
                   7820:     packages which have licenses that are Free or Open Source.
                   7821:     However, packages without a license meeting either of those tests
                   7822:     are labeled with a license tag denoting the license.  Note that a
                   7823:     package with no license to copy trivially does not meet either the
                   7824:     Free or Open Source test.</p>
                   7825: <p>For packages which are not Free or Open Source, pkgsrc will
                   7826:     not build the package unless the user has indicated to pkgsrc that
                   7827:     packages with that particular license may be built.  Note that
                   7828:     this documentation avoids the term "accepted the license".  The
                   7829:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7830:     accidentally building a package with a non-free license;
1.98      wiz      7831:     judgement and responsibility remain with the user.  (Installation
                   7832:     of binary packages are not currently subject to this mechanism;
                   7833:     this is a bug.)</p>
                   7834: <p>One might want to only install packages with a BSD license,
1.121     jnemeth  7835:     or the GPL, and not the other.  The free licenses are added to the 
                   7836:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
                   7837:     user can override the default by setting the
                   7838:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
                   7839:     of "+=".  The licenses accepted by default are:
                   7840:     </p>
                   7841: <pre class="programlisting">
                   7842:     public-domain
                   7843:     gnu-gpl-v2 gnu-lgpl-v2
                   7844:     gnu-gpl-v3 gnu-lgpl-v3
                   7845:     original-bsd modified-bsd
                   7846:     x11
                   7847:     apache-2.0
                   7848:     cddl-1.0
                   7849:     open-font-license
                   7850:     </pre>
                   7851: <p>
                   7852:     </p>
1.78      rillig   7853: <p>The license tag mechanism is intended to address
1.87      wiz      7854:     copyright-related issues surrounding building, installing and
                   7855:     using a package, and not to address redistribution issues (see
                   7856:     <code class="varname">RESTRICTED</code> and
1.121     jnemeth  7857:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  
                   7858:     Packages with redistribution restrictions should set these
                   7859:     tags.</p>
1.98      wiz      7860: <p>Denoting that a package may be copied according to a
                   7861:     particular license is done by placing the license in
1.87      wiz      7862:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7863:     <code class="varname">LICENSE</code> variable to a string identifying the
1.91      rillig   7864:     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      7865: <pre class="programlisting">
1.100     rillig   7866: LICENSE=        xv-license
1.87      wiz      7867:     </pre>
                   7868: <p>When trying to build, the user will get a notice that the
1.98      wiz      7869:     package is covered by a license which has not been placed in the
                   7870:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7871: <pre class="programlisting">
1.100     rillig   7872: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7873: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7874: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7875: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7876: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7877: *** Error code 1
1.87      wiz      7878:     </pre>
1.110     hubertf  7879: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7880:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7881:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7882:     convey to pkgsrc that it should not in the future fail because of
                   7883:     that license:</p>
1.78      rillig   7884: <pre class="programlisting">
1.100     rillig   7885: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      7886:     </pre>
1.98      wiz      7887: <p>When adding a package with a new license, the license text
                   7888:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7889:     displaying.  A list of known licenses can be seen in this
1.91      rillig   7890:     directory.</p>
1.98      wiz      7891: <p>When the license changes (in a way other than formatting),
                   7892:     please make sure that the new license has a different name (e.g.,
                   7893:     append the version number if it exists, or the date).  Just
                   7894:     because a user told pkgsrc to build programs under a previous
                   7895:     version of a license does not mean that pkgsrc should build
1.99      rillig   7896:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7897:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7898:     test is a mechanistic test of whether a particular text has been
                   7899:     approved by either of two bodies.</p>
1.78      rillig   7900: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      7901:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7902:     is deprecated because it does not crisply refer to a particular
                   7903:     license text.  Another problem with such usage is that it does not
                   7904:     enable a user to tell pkgsrc to proceed for a single package
                   7905:     without also telling pkgsrc to proceed for all packages with that
                   7906:     tag.</p>
1.75      rillig   7907: </div>
                   7908: <div class="sect2" lang="en">
                   7909: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7910: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.75      rillig   7911: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      7912:     Because a license tag is required unless the package is Free or
                   7913:     Open Source, all packages with restrictions should have license
                   7914:     tags.  By declaring the restrictions, package tools can
                   7915:     automatically refrain from e.g. placing binary packages on FTP
                   7916:     sites.</p>
                   7917: <p>There are four restrictions that may be encoded, which are
                   7918:     the cross product of sources (distfiles) and binaries not being
                   7919:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7920:     language in any license, and because non-Free licenses tend to be
                   7921:     different from each other, pkgsrc adopts a definition of FTP and
                   7922:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7923:     should not be made available over the Internet at no charge.
                   7924:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7925:     made available on some kind of media, together with other source
                   7926:     and binary packages, and which is sold for a distribution charge.
                   7927:     </p>
                   7928: <p>In order to encode these restrictions, the package system
1.87      wiz      7929:     defines five make variables that can be set to note these
                   7930:     restrictions:</p>
1.75      rillig   7931: <div class="itemizedlist"><ul type="disc">
                   7932: <li>
                   7933: <p><code class="varname">RESTRICTED</code></p>
                   7934: <p>This variable should be set whenever a restriction
1.87      wiz      7935:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7936:        string containing the reason for the restriction.  It should
                   7937:        be understood that those wanting to understand the restriction
                   7938:        will have to read the license, and perhaps seek advice of
                   7939:        counsel.</p>
1.75      rillig   7940: </li>
                   7941: <li>
                   7942: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7943: <p>Binaries may not be placed on CD-ROM containing other
                   7944:        binary packages, for which a distribution charge may be made.
                   7945:        In this case, set this variable to
                   7946:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7947: </li>
                   7948: <li>
                   7949: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7950: <p>Binaries may not made available on the Internet without
                   7951:        charge.  In this case, set this variable to
                   7952:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7953:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7954: </li>
                   7955: <li>
                   7956: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7957: <p>Distfiles may not be placed on CD-ROM, together with
                   7958:        other distfiles, for which a fee may be charged.  In this
                   7959:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7960:        </p>
1.75      rillig   7961: </li>
                   7962: <li>
                   7963: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7964: <p>Distfiles may not made available via FTP at no charge.
                   7965:        In this case, set this variable to
                   7966:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7967:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7968: </li>
                   7969: </ul></div>
                   7970: </div>
                   7971: <div class="sect2" lang="en">
                   7972: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7973: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.75      rillig   7974: <p>Your package may depend on some other package being present
1.88      wiz      7975:     - and there are various ways of expressing this dependency.
                   7976:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7977:     <code class="varname">DEPENDS</code> definitions, the
                   7978:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7979:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7980:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  7981:     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   7982: <p>The basic difference between the two variables is as
1.87      wiz      7983:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7984:     that pre-requisite in the binary package so it will be pulled in
                   7985:     when the binary package is later installed, whilst the
                   7986:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7987:     dependency that is only needed for building the package.</p>
1.75      rillig   7988: <p>This means that if you only need a package present whilst
1.87      wiz      7989:     you are building, it should be noted as a
                   7990:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7991: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7992:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7993: <pre class="programlisting">
1.100     rillig   7994: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      7995:     </pre>
1.75      rillig   7996: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
1.87      wiz      7997:     may include any of the wildcard version numbers recognized by
1.110     hubertf  7998:     <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   7999: <div class="orderedlist"><ol type="1">
                   8000: <li>
                   8001: <p>If your package needs another package's binaries or
1.87      wiz      8002:        libraries to build or run, and if that package has a
                   8003:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   8004: <pre class="programlisting">
1.100     rillig   8005: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      8006:        </pre>
1.75      rillig   8007: </li>
                   8008: <li>
                   8009: <p>If your package needs to use another package to build
1.87      wiz      8010:        itself and there is no <code class="filename">buildlink3.mk</code>
                   8011:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   8012:        definition:</p>
1.75      rillig   8013: <pre class="programlisting">
1.100     rillig   8014: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
1.87      wiz      8015:        </pre>
1.75      rillig   8016: </li>
                   8017: <li>
                   8018: <p>If your package needs a library with which to link and
1.76      rillig   8019:        again there is no <code class="filename">buildlink3.mk</code> file
1.87      wiz      8020:        available, this is specified using the
                   8021:        <code class="varname">DEPENDS</code> definition. For example:</p>
1.75      rillig   8022: <pre class="programlisting">
1.100     rillig   8023: DEPENDS+=       xpm-3.4j:../../graphics/xpm
1.87      wiz      8024:        </pre>
1.109     rillig   8025: <p>You can also use wildcards in package dependencies:</p>
1.75      rillig   8026: <pre class="programlisting">
1.100     rillig   8027: DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
1.87      wiz      8028:        </pre>
1.75      rillig   8029: <p>Note that such wildcard dependencies are retained when
1.87      wiz      8030:        creating binary packages.  The dependency is checked when
                   8031:        installing the binary package and any package which matches
                   8032:        the pattern will be used.  Wildcard dependencies should be
                   8033:        used with care.</p>
1.75      rillig   8034: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
1.87      wiz      8035:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   8036:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   8037:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
1.75      rillig   8038: <p>Wildcards can also be used to specify that a package
1.87      wiz      8039:        will only build against a certain minimum version of a
                   8040:        pre-requisite:</p>
1.75      rillig   8041: <pre class="programlisting">
1.100     rillig   8042: DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
1.87      wiz      8043:        </pre>
1.75      rillig   8044: <p>This means that the package will build against version
1.87      wiz      8045:        3.5.4 of the tiff library or newer.  Such a dependency may
                   8046:        be warranted if, for example, the API of the library has
                   8047:        changed with version 3.5.4 and a package would not compile
                   8048:        against an earlier version of tiff.</p>
1.75      rillig   8049: <p>Please note that such dependencies should only be
1.87      wiz      8050:        updated if a package requires a newer pre-requisite, but
1.93      rillig   8051:        not to denote recommendations such as
1.87      wiz      8052:        ABI changes that do not prevent a package from building
                   8053:        correctly.  Such recommendations can be expressed using
                   8054:        <code class="varname">ABI_DEPENDS</code>:</p>
1.75      rillig   8055: <pre class="programlisting">
1.100     rillig   8056: ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
1.87      wiz      8057:        </pre>
1.75      rillig   8058: <p>In addition to the above <code class="varname">DEPENDS</code>
1.87      wiz      8059:        line, this denotes that while a package will build against
                   8060:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   8061:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   8062:        dependencies unless explicitly ignored (in which case a
                   8063:        warning will be printed).</p>
1.75      rillig   8064: <p>To ignore these ABI dependency recommendations and just
1.87      wiz      8065:        use the required <code class="varname">DEPENDS</code>, set
                   8066:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   8067:        it easier and faster to update packages built using pkgsrc,
                   8068:        since older compatible dependencies can continue to be
                   8069:        used. This is useful for people who watch their rebuilds
                   8070:        very carefully; it is not very good as a general-purpose
                   8071:        hammer.  If you use it, you need to be mindful of possible
                   8072:        ABI changes, including those from the underlying OS.</p>
1.75      rillig   8073: <p>Packages that are built with recommendations ignored
1.87      wiz      8074:        may not be uploaded to ftp.NetBSD.org by developers and
                   8075:        should not be used across different systems that may have
                   8076:        different versions of binary packages installed.</p>
1.75      rillig   8077: <p>For security fixes, please update the package
1.110     hubertf  8078:        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      8079:        information.</p>
1.75      rillig   8080: </li>
                   8081: <li>
                   8082: <p>If your package needs some executable to be able to run
1.87      wiz      8083:        correctly and if there's no
                   8084:        <code class="filename">buildlink3.mk</code> file, this is specified
                   8085:        using the <code class="varname">DEPENDS</code> variable. The
1.91      rillig   8086:        <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      8087:        be able to execute the latex binary from the teTeX package
                   8088:        when it runs, and that is specified:</p>
1.75      rillig   8089: <pre class="programlisting">
1.100     rillig   8090: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      8091:        </pre>
1.75      rillig   8092: <p>The comment about wildcard dependencies from previous
1.87      wiz      8093:        paragraph applies here, too.</p>
1.75      rillig   8094: </li>
                   8095: </ol></div>
                   8096: <p>If your package needs files from another package to build,
1.87      wiz      8097:     add the relevant distribution files to
                   8098:     <code class="varname">DISTFILES</code>, so they will be extracted
1.91      rillig   8099:     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      8100:     (It relies on the jpeg sources being present in source form
                   8101:     during the build.)</p>
1.75      rillig   8102: </div>
                   8103: <div class="sect2" lang="en">
                   8104: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8105: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   8106: <p>Your package may conflict with other packages a user might
1.87      wiz      8107:     already have installed on his system, e.g. if your package
1.88      wiz      8108:     installs the same set of files as another package in the pkgsrc
                   8109:     tree.</p>
1.75      rillig   8110: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      8111:     space-separated list of packages (including version string) your
                   8112:     package conflicts with.</p>
1.91      rillig   8113: <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>
                   8114:     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      8115:     install the same shared library, thus you set in
                   8116:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8117: <pre class="programlisting">
1.100     rillig   8118: CONFLICTS=      Xaw-Xpm-[0-9]*
1.87      wiz      8119:     </pre>
                   8120: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
1.75      rillig   8121: <pre class="programlisting">
1.100     rillig   8122: CONFLICTS=      Xaw3d-[0-9]*
1.87      wiz      8123:     </pre>
1.75      rillig   8124: <p>Packages will automatically conflict with other packages
1.87      wiz      8125:     with the name prefix and a different version
                   8126:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   8127:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
1.75      rillig   8128: </div>
                   8129: <div class="sect2" lang="en">
                   8130: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8131: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   8132: <p>There are several reasons why a package might be
1.88      wiz      8133:     instructed to not build under certain circumstances.  If the
1.87      wiz      8134:     package builds and runs on most platforms, the exceptions
                   8135:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8136:     the package builds and runs on a small handful of platforms,
                   8137:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8138:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8139:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8140:     (OS-version-platform) that can use glob-style
                   8141:     wildcards.</p>
1.88      wiz      8142: <p>Some packages are tightly bound to a specific version of an
1.91      rillig   8143:     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      8144:     backwards compatible with other versions of the OS, and should be
                   8145:     uploaded to a version specific directory on the FTP server.  Mark
                   8146:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   8147:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   8148:     the package system internals, but may be used in the
                   8149:     future.</p>
1.75      rillig   8150: <p>If the package should be skipped (for example, because it
1.87      wiz      8151:     provides functionality already provided by the system), set
1.88      wiz      8152:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8153:     the package should fail because some preconditions are not met,
                   8154:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      8155:     message.</p>
1.75      rillig   8156: </div>
                   8157: <div class="sect2" lang="en">
                   8158: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8159: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   8160: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      8161:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8162:     be set in the package Makefile. This will be carried into any
                   8163:     binary package that is made from this pkgsrc entry. A
                   8164:     &#8220;<span class="quote">preserved</span>&#8221; package will
1.110     hubertf  8165:     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      8166:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
1.75      rillig   8167: </div>
                   8168: <div class="sect2" lang="en">
                   8169: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8170: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.75      rillig   8171: <p>When a vulnerability is found, this should be noted in
1.87      wiz      8172:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.110     hubertf  8173:     and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.87      wiz      8174:     in the same directory to update the file on ftp.NetBSD.org.</p>
1.75      rillig   8175: <p>After fixing the vulnerability by a patch, its
1.87      wiz      8176:     <code class="varname">PKGREVISION</code> should be increased (this
                   8177:     is of course not necessary if the problem is fixed by using
                   8178:     a newer release of the software).</p>
1.75      rillig   8179: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      8180:     branch, be sure to submit a pullup request!</p>
1.75      rillig   8181: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      8182:     semi-automatically by a weekly cron job.</p>
1.75      rillig   8183: </div>
                   8184: <div class="sect2" lang="en">
                   8185: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8186: <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   8187: <p>When making fixes to an existing package it can be useful
1.87      wiz      8188:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8189:     avoid conflicting with future versions by the original author, a
                   8190:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8191:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8192:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8193:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8194: <pre class="programlisting">
1.100     rillig   8195: DISTNAME=       foo-17.42
                   8196: PKGREVISION=    9
1.87      wiz      8197:     </pre>
1.75      rillig   8198: <p>will result in a <code class="varname">PKGNAME</code> of
1.87      wiz      8199:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8200:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8201:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8202:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   8203: <p>When a new release of the package is released, the
1.87      wiz      8204:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8205:     minor release of the above package, things should be like:</p>
1.75      rillig   8206: <pre class="programlisting">
1.100     rillig   8207: DISTNAME=       foo-17.43
1.87      wiz      8208:     </pre>
                   8209: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8210:     non-trivial change in the resulting binary package.  Without a
                   8211:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8212:     version installed has no way of knowing that their package is out
                   8213:     of date.  Thus, changes without increasing
                   8214:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8215:     trivial that no reasonable person would want to upgrade", and this
                   8216:     is the rough test for when increasing
                   8217:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8218:     changes that do not merit increasing
                   8219:     <code class="varname">PKGREVISION</code> are:</p>
1.100     rillig   8220: <div class="itemizedlist"><ul type="disc">
1.114     jmcneill 8221: <li><p>Changing <code class="varname">HOMEPAGE</code>,
                   8222:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   8223:       or comments in Makefile.</p></li>
                   8224: <li><p>
                   8225:       Changing build variables if the resulting binary package is the same.</p></li>
                   8226: <li><p>
                   8227:       Changing <code class="filename">DESCR</code>.</p></li>
                   8228: <li><p>
                   8229:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8230: </ul></div>
1.87      wiz      8231: <p>Examples of changes that do merit an increase to
                   8232:     <code class="varname">PKGREVISION</code> include:</p>
1.100     rillig   8233: <div class="itemizedlist"><ul type="disc">
                   8234: <li><p>
                   8235:       Security fixes</p></li>
                   8236: <li><p>
                   8237:       Changes or additions to a patch file</p></li>
                   8238: <li><p>
                   8239:       Changes to the <code class="filename">PLIST</code></p></li>
1.112     weinem   8240: <li><p>A dependency is changed or renamed.</p></li>
1.100     rillig   8241: </ul></div>
1.78      rillig   8242: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8243:     changes.</p>
1.75      rillig   8244: </div>
1.79      rillig   8245: <div class="sect2" lang="en">
                   8246: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8247: <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   8248: <p>When you want to replace the same text in multiple files
1.87      wiz      8249:     or when the replacement text varies, patches alone cannot help.
                   8250:     This is where the SUBST framework comes in. It provides an
                   8251:     easy-to-use interface for replacing text in files.
                   8252:     Example:</p>
                   8253: <pre class="programlisting">
1.100     rillig   8254: SUBST_CLASSES+=                 fix-paths
                   8255: SUBST_STAGE.fix-paths=          pre-configure
                   8256: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8257: SUBST_FILES.fix-paths=          src/*.c
                   8258: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8259: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8260: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      8261:     </pre>
1.79      rillig   8262: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      8263:     that are used to identify the different SUBST blocks that are
                   8264:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8265:     important to always use the <code class="literal">+=</code> operator with
                   8266:     this variable. Otherwise some substitutions may be
                   8267:     skipped.</p>
1.79      rillig   8268: <p>The remaining variables of each SUBST block are
1.87      wiz      8269:     parameterized with the identifier from the first line
                   8270:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8271:     parameters to a function call.</p>
1.79      rillig   8272: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      8273:     which the replacement will take place. All combinations of
                   8274:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8275:     <code class="literal">post-</code> together with a phase name are
                   8276:     possible, though only few are actually used. Most commonly used
                   8277:     are <code class="literal">post-patch</code> and
                   8278:     <code class="literal">pre-configure</code>. Of these two,
                   8279:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  8280:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      8281:     have the state after applying the patches but before making any
                   8282:     other changes. This is especially useful when you are debugging
                   8283:     a package in order to create new patches for it. Similarly,
                   8284:     <code class="literal">post-build</code> is preferred over
                   8285:     <code class="literal">pre-install</code>, because the install phase should
                   8286:     generally be kept as simple as possible. When you use
                   8287:     <code class="literal">post-build</code>, you have the same files in the
                   8288:     working directory that will be installed later, so you can check
                   8289:     if the substitution has succeeded.</p>
1.79      rillig   8290: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      8291:     that is printed just before the substitution is done.</p>
1.79      rillig   8292: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      8293:     globbing patterns that specifies the files in which the
                   8294:     substitution will take place. The patterns are interpreted
                   8295:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   8296: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.110     hubertf  8297:     <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      8298:     command should be prefixed with <code class="literal">-e</code>, so that
                   8299:     all SUBST blocks look uniform.</p>
1.79      rillig   8300: <p>There are some more variables, but they are so seldomly
1.87      wiz      8301:     used that they are only documented in the
                   8302:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   8303: </div>
1.75      rillig   8304: </div>
                   8305: <div class="sect1" lang="en">
                   8306: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8307: <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   8308: <div class="sect2" lang="en">
                   8309: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8310: <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   8311: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8312:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8313:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8314:     with the name of each file to download as an argument, expecting
                   8315:     it to output the URL of the directory from which to download
1.91      rillig   8316:     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      8317:     example of this usage.</p>
1.75      rillig   8318: <p>If the download can't be automated, because the user must
1.87      wiz      8319:     submit personal information to apply for a password, or must pay
                   8320:     for the source, or whatever, you can set
                   8321:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8322:     displayed to the user before aborting the build. Example:</p>
                   8323: <pre class="programlisting">
1.100     rillig   8324: FETCH_MESSAGE=  "Please download the files"
                   8325: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8326: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8327:     </pre>
1.75      rillig   8328: </div>
                   8329: <div class="sect2" lang="en">
                   8330: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8331: <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   8332: <p>Sometimes authors of a software package make some
1.87      wiz      8333:     modifications after the software was released, and they put up a
                   8334:     new distfile without changing the package's version number. If a
                   8335:     package is already in pkgsrc at that time, the checksum will
                   8336:     no longer match. The contents of the new distfile should be
                   8337:     compared against the old one before changing anything, to make
                   8338:     sure the distfile was really updated on purpose, and that
                   8339:     no trojan horse or so crept in.
1.97      rillig   8340:     Please mention that the distfiles were compared and what was found
                   8341:     in your commit message.
1.87      wiz      8342:     Then, the correct way to work around this is to
                   8343:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8344:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8345:     <code class="varname">DISTFILES</code> and
1.93      rillig   8346:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8347:     subdirectory of the local distfiles directory.
1.110     hubertf  8348:     (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   8349:     In case this
1.87      wiz      8350:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8351:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8352:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8353:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8354:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8355:     path in the filenames.
1.97      rillig   8356:     Also increase the PKGREVISION if the installed package is different.
1.87      wiz      8357:     Furthermore, a mail to the package's authors seems appropriate
                   8358:     telling them that changing distfiles after releases without
                   8359:     changing the file names is not good practice.</p>
1.75      rillig   8360: </div>
                   8361: </div>
                   8362: <div class="sect1" lang="en">
                   8363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8364: <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   8365: <div class="sect2" lang="en">
                   8366: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8367: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8368: <p>pkgsrc supports many different machines, with different
1.87      wiz      8369:     object formats like a.out and ELF, and varying abilities to do
                   8370:     shared library and dynamic loading at all. To accompany this,
                   8371:     varying commands and options have to be passed to the
                   8372:     compiler, linker, etc. to get the Right Thing, which can be
                   8373:     pretty annoying especially if you don't have all the machines
                   8374:     at your hand to test things.  The
1.91      rillig   8375:     <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      8376:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8377:     both static and dynamic libraries from a set of source files,
                   8378:     thus being platform-independent.</p>
                   8379: <p>Here's how to use libtool in a package in seven simple
                   8380:     steps:</p>
1.75      rillig   8381: <div class="orderedlist"><ol type="1">
                   8382: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8383:        Makefile.</p></li>
1.75      rillig   8384: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
1.87      wiz      8385:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8386:        add it to the definition of <code class="varname">CC</code>, if only
                   8387:        libraries are being built in a given Makefile. This one command
                   8388:        will build both PIC and non-PIC library objects, so you need not
                   8389:        have separate shared and non-shared library rules.</p></li>
1.75      rillig   8390: <li>
                   8391: <p>For the linking of the library, remove any
1.87      wiz      8392:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8393:        -Bshareable</span>&#8221; commands, and instead use:</p>
1.75      rillig   8394: <pre class="programlisting">
1.100     rillig   8395: ${LIBTOOL} --mode=link \
                   8396:     ${CC} -o ${.TARGET:.a=.la} \
                   8397:         ${OBJS:.o=.lo} \
                   8398:         -rpath ${PREFIX}/lib \
                   8399:         -version-info major:minor
1.87      wiz      8400:        </pre>
1.75      rillig   8401: <p>Note that the library is changed to have a
1.87      wiz      8402:        <code class="filename">.la</code> extension, and the objects are
                   8403:        changed to have a <code class="filename">.lo</code>
                   8404:        extension. Change <code class="varname">OBJS</code> as
                   8405:        necessary. This automatically creates all of the
                   8406:        <code class="filename">.a</code>,
                   8407:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8408:        necessary) in the build directory. Be sure to include
                   8409:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8410:        minor are zero, as libtool will otherwise strip off the
                   8411:        shared library version.</p>
1.75      rillig   8412: <p>From the libtool manual:</p>
                   8413: <pre class="programlisting">
1.100     rillig   8414: So, libtool library versions are described by three integers:
1.69      rillig   8415: 
1.100     rillig   8416: CURRENT
                   8417: The most recent interface number that this library implements.
1.69      rillig   8418: 
1.100     rillig   8419: REVISION
                   8420: The implementation number of the CURRENT interface.
1.69      rillig   8421: 
1.100     rillig   8422: AGE
                   8423: The difference between the newest and oldest interfaces that
                   8424: this library implements.  In other words, the library implements
                   8425: all the interface numbers in the range from number `CURRENT -
                   8426: AGE' to `CURRENT'.
1.1       grant    8427: 
1.100     rillig   8428: If two libraries have identical CURRENT and AGE numbers, then the
                   8429: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8430:        </pre>
1.75      rillig   8431: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
1.87      wiz      8432:        different results for a.out and ELF (excluding symlinks)
                   8433:        in only one case. An ELF library of the form
                   8434:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8435:        will have a symlink of
                   8436:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8437:        on an a.out platform. This is handled
                   8438:        automatically.</p>
1.75      rillig   8439: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
1.87      wiz      8440:        directory of the library being built.</p>
1.76      rillig   8441: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8442:        <code class="filename">.la</code> file, the other files will be
                   8443:        added automatically.</p>
1.75      rillig   8444: </li>
                   8445: <li>
1.76      rillig   8446: <p>When linking shared object (<code class="filename">.so</code>)
1.110     hubertf  8447:        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      8448:        shared libraries, use &#8220;<span class="quote">-module
                   8449:        -avoid-version</span>&#8221; to prevent them getting version
                   8450:        tacked on.</p>
1.76      rillig   8451: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8452:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8453: </li>
                   8454: <li>
                   8455: <p>When linking programs that depend on these libraries
1.87      wiz      8456:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.110     hubertf  8457:        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      8458:        --mode=link</span>&#8221;, and it will find the correct
                   8459:        libraries (static or shared), but please be aware that
                   8460:        libtool will not allow you to specify a relative path in
                   8461:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8462:        expects you to change that argument to be the
                   8463:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8464: <pre class="programlisting">
1.100     rillig   8465: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8466:        </pre>
1.75      rillig   8467: <p>should be changed to:</p>
                   8468: <pre class="programlisting">
1.100     rillig   8469: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8470:        </pre>
1.75      rillig   8471: <p>and it will do the right thing with the libraries.</p>
                   8472: </li>
                   8473: <li>
1.110     hubertf  8474: <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>
                   8475:        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      8476:        --mode=install</span>&#8221;, and change the library name to
                   8477:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8478: <pre class="programlisting">
1.100     rillig   8479: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8480:        </pre>
1.76      rillig   8481: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8482:        shared library, any needed symlinks, and run
1.110     hubertf  8483:        <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   8484: </li>
1.76      rillig   8485: <li><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8486:        the <code class="filename">.la</code>
                   8487:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8488: </ol></div>
                   8489: </div>
                   8490: <div class="sect2" lang="en">
                   8491: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8492: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8493: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8494:     package Makefile. This will override the package's own libtool
                   8495:     in most cases.  For older libtool using packages,  libtool is
                   8496:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8497:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8498:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8499: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8500:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8501:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8502:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8503:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8504: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8505:     libraries built and installed, then use
                   8506:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8507: <p>If your package makes use of the platform-independent library
1.87      wiz      8508:     for loading dynamic shared objects, that comes with libtool
                   8509:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8510: <p>Some packages use libtool incorrectly so that the package
                   8511:     may not work or build in some circumstances. Some of the more
                   8512:     common errors are:</p>
1.75      rillig   8513: <div class="itemizedlist"><ul type="disc">
                   8514: <li>
                   8515: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8516:        executable or library. This in itself isn't a problem if one of two things
                   8517:        has been done:</p>
1.75      rillig   8518: <div class="orderedlist"><ol type="1">
                   8519: <li><p>The shared object is named correctly, i.e.
1.87      wiz      8520:            <code class="filename">libfoo.la</code>, not
                   8521:            <code class="filename">foo.la</code></p></li>
1.75      rillig   8522: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8523: </ol></div>
                   8524: </li>
                   8525: <li><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8526:        The function lt_dlinit() should be called and the macro
                   8527:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8528:        executables.</p></li>
1.75      rillig   8529: </ul></div>
                   8530: </div>
                   8531: <div class="sect2" lang="en">
                   8532: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8533: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8534: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8535:     to regenerate the configure script and Makefile.in makefile
                   8536:     templates, then they should be executed in a pre-configure
                   8537:     target.</p>
1.75      rillig   8538: <p>For packages that need only autoconf:</p>
                   8539: <pre class="programlisting">
1.100     rillig   8540: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8541: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8542: ...
1.1       grant    8543: 
1.100     rillig   8544: pre-configure:
                   8545:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8546: 
1.100     rillig   8547: ...
1.87      wiz      8548:     </pre>
1.75      rillig   8549: <p>and for packages that need automake and autoconf:</p>
                   8550: <pre class="programlisting">
1.100     rillig   8551: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8552: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8553: ...
                   8554: 
                   8555: pre-configure:
                   8556:         set -e; cd ${WRKSRC}; \
                   8557:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8558: 
1.100     rillig   8559: ...
1.87      wiz      8560:     </pre>
1.75      rillig   8561: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8562:     require GNU Make.</p>
1.75      rillig   8563: <p>There are times when the configure process makes
1.87      wiz      8564:     additional changes to the generated files, which then causes
                   8565:     the build process to try to re-execute the automake sequence.
                   8566:     This is prevented by touching various files in the configure
                   8567:     stage. If this causes problems with your package you can set
                   8568:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8569:     Makefile.</p>
1.75      rillig   8570: </div>
                   8571: </div>
                   8572: <div class="sect1" lang="en">
                   8573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8574: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.87      wiz      8575: <div class="sect2" lang="en">
                   8576: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8577: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8578: <p>Compilers for the C, C++, and Fortran languages comes with
                   8579:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8580:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  8581:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8582: <p>To declare which language's compiler a package needs, set
                   8583:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8584:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8585:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8586:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8587:     written in C++, usually need a C compiler for the configure
                   8588:     phase.</p>
                   8589: </div>
                   8590: <div class="sect2" lang="en">
                   8591: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8592: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      8593: <p>If a program is written in Java, use the Java framework in
                   8594:     pkgsrc.  The package must include
                   8595:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8596:     provides the following variables:</p>
                   8597: <div class="itemizedlist"><ul type="disc">
                   8598: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8599:       dependency on the JDK is added.  If
                   8600:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8601:       there is only a runtime dependency on the JDK.  The default is
                   8602:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8603:       JDK.</p></li>
                   8604: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8605:       a package needs a Java2 implementation.  The supported values
                   8606:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8607:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8608:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8609:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8610:       above. This variable is not set by default.</p></li>
                   8611: </ul></div>
                   8612: </div>
                   8613: <div class="sect2" lang="en">
                   8614: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8615: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8616: <p>If your package contains interpreted perl scripts, add
                   8617:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8618:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8619:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8620:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8621:     that you want adjusted.  Every occurrence of
                   8622:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8623:     path to the perl executable.</p>
                   8624: <p>If a particular version of perl is needed, set the
                   8625:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8626:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.110     hubertf  8627: <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      8628:     about handling perl modules.</p>
                   8629: </div>
                   8630: <div class="sect2" lang="en">
                   8631: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8632: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.87      wiz      8633: <p>Currently, there is no special handling for other languages
                   8634:     in pkgsrc.  If a compiler package provides a
                   8635:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8636:     just add a (build) dependency on the appropriate compiler
                   8637:     package.</p>
                   8638: </div>
                   8639: </div>
                   8640: <div class="sect1" lang="en">
                   8641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8642: <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   8643: <p>The most common failures when building a package are that
                   8644:        some platforms do not provide certain header files, functions or
                   8645:        libraries, or they provide the functions in a library that the
                   8646:        original package author didn't know. To work around this, you
                   8647:        can rewrite the source code in most cases so that it does not
                   8648:        use the missing functions or provides a replacement function.</p>
                   8649: <div class="sect2" lang="en">
                   8650: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8651: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8652: <p>If a package already comes with a GNU configure script, the
                   8653:        preferred way to fix the build failure is to change the
                   8654:        configure script, not the code. In the other cases, you can
                   8655:        utilize the C preprocessor, which defines certain macros
                   8656:        depending on the operating system and hardware architecture it
                   8657:        compiles for. These macros can be queried using for example
                   8658:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8659:        system, hardware architecture and compiler has its own macro.
                   8660:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8661:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8662:        are all defined, you know that you are using NetBSD on an i386
                   8663:        compatible CPU, and your compiler is GCC.</p>
                   8664: <p>The list of the following macros for hardware and
                   8665:        operating system depends on the compiler that is used. For
                   8666:        example, if you want to conditionally compile code on Solaris,
                   8667:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8668:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.75      rillig   8669: <div class="sect3" lang="en">
                   8670: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8671: <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   8672: <p>To distinguish between 4.4 BSD-derived systems and the
                   8673:         rest of the world, you should use the following code.</p>
                   8674: <pre class="programlisting">
1.100     rillig   8675: #include &lt;sys/param.h&gt;
                   8676: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8677: /* BSD-specific code goes here */
                   8678: #else
                   8679: /* non-BSD-specific code goes here */
                   8680: #endif
1.75      rillig   8681: </pre>
1.77      rillig   8682: <p>If this distinction is not fine enough, you can also test
                   8683:        for the following macros.</p>
1.75      rillig   8684: <pre class="programlisting">
1.100     rillig   8685: FreeBSD     __FreeBSD__
                   8686: DragonFly   __DragonFly__
                   8687: Interix     __INTERIX
                   8688: IRIX        __sgi (TODO: get a definite source for this)
                   8689: Linux       linux, __linux, __linux__
                   8690: NetBSD      __NetBSD__
                   8691: OpenBSD     __OpenBSD__
                   8692: Solaris     sun, __sun
1.75      rillig   8693: </pre>
                   8694: </div>
                   8695: <div class="sect3" lang="en">
                   8696: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8697: <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   8698: <pre class="programlisting">
1.100     rillig   8699: i386        i386, __i386, __i386__
                   8700: MIPS        __mips
                   8701: SPARC       sparc, __sparc
1.75      rillig   8702: </pre>
                   8703: </div>
                   8704: <div class="sect3" lang="en">
                   8705: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8706: <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   8707: <pre class="programlisting">
1.100     rillig   8708: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8709: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8710: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8711: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8712: </pre>
                   8713: </div>
                   8714: </div>
1.78      rillig   8715: <div class="sect2" lang="en">
                   8716: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8717: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8718: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8719:         combinations of compiler version and architecture and almost
                   8720:         always relation to optimisation being enabled.  Common symptoms
                   8721:         are gcc internal errors or never finishing compiling a
1.78      rillig   8722:        file.</p>
                   8723: <p>Typically, a workaround involves testing the
                   8724:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8725:         optimisation for that combination of file,
                   8726:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
1.87      wiz      8727:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
1.78      rillig   8728:        number of examples.</p>
                   8729: </div>
                   8730: <div class="sect2" lang="en">
                   8731: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8732: <a name="undefined-reference"></a>19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.92      rillig   8733: <p>This error message often means that a package did not
1.78      rillig   8734:        link to a shared library it needs. The following functions are
                   8735:        known to cause this error message over and over.</p>
                   8736: <div class="informaltable">
                   8737: <a name="undefined-reference-functions"></a><table border="1">
                   8738: <colgroup>
                   8739: <col>
                   8740: <col>
                   8741: <col>
                   8742: </colgroup>
                   8743: <thead><tr>
                   8744: <th>Function</th>
                   8745: <th>Library</th>
                   8746: <th>Affected platforms</th>
                   8747: </tr></thead>
                   8748: <tbody>
                   8749: <tr>
                   8750: <td>accept, bind, connect</td>
                   8751: <td>-lsocket</td>
                   8752: <td>Solaris</td>
                   8753: </tr>
                   8754: <tr>
                   8755: <td>crypt</td>
                   8756: <td>-lcrypt</td>
                   8757: <td>DragonFly, NetBSD</td>
                   8758: </tr>
                   8759: <tr>
                   8760: <td>dlopen, dlsym</td>
                   8761: <td>-ldl</td>
                   8762: <td>Linux</td>
                   8763: </tr>
                   8764: <tr>
                   8765: <td>gethost*</td>
                   8766: <td>-lnsl</td>
                   8767: <td>Solaris</td>
                   8768: </tr>
                   8769: <tr>
                   8770: <td>inet_aton</td>
                   8771: <td>-lresolv</td>
                   8772: <td>Solaris</td>
                   8773: </tr>
                   8774: <tr>
                   8775: <td>nanosleep, sem_*, timer_*</td>
                   8776: <td>-lrt</td>
                   8777: <td>Solaris</td>
                   8778: </tr>
                   8779: <tr>
                   8780: <td>openpty</td>
                   8781: <td>-lutil</td>
                   8782: <td>Linux</td>
                   8783: </tr>
                   8784: </tbody>
                   8785: </table>
                   8786: </div>
                   8787: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8788:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8789:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8790:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8791:     bmake</strong></span>.</p>
1.92      rillig   8792: <div class="sect3" lang="en">
                   8793: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8794: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8795: <p>When you are using the SunPro compiler, there is another
                   8796: possibility. That compiler cannot handle the following code:</p>
                   8797: <pre class="programlisting">
1.100     rillig   8798: extern int extern_func(int);
1.93      rillig   8799: 
1.100     rillig   8800: static inline int
                   8801: inline_func(int x)
                   8802: {
1.92      rillig   8803:         return extern_func(x);
1.100     rillig   8804: }
1.93      rillig   8805: 
1.100     rillig   8806: int main(void)
                   8807: {
1.92      rillig   8808:         return 0;
1.100     rillig   8809: }
1.92      rillig   8810: </pre>
                   8811: <p>It generates the code for <code class="function">inline_func</code> even if
                   8812: that function is never used. This code then refers to
                   8813: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8814: solve this problem you can try to tell the package to disable inlining
                   8815: of functions.</p>
                   8816: </div>
1.87      wiz      8817: </div>
                   8818: <div class="sect2" lang="en">
                   8819: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8820: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8821: <p>Sometimes packages fail to build because the compiler runs
                   8822:     into an operating system specific soft limit.  With the
                   8823:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8824:     to unlimit the resources.  Currently, the allowed values are
                   8825:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8826:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8827:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8828:     segment size or maximum stack size of a process, respectively, to
                   8829:     their hard limits.</p>
1.78      rillig   8830: </div>
1.75      rillig   8831: </div>
                   8832: <div class="sect1" lang="en">
                   8833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8834: <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   8835: <div class="sect2" lang="en">
                   8836: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8837: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8838: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8839:     with some operating systems cannot create more than one
                   8840:     directory at a time. As such, you should call
                   8841:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8842: <pre class="programlisting">
1.100     rillig   8843: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8844: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      8845:     </pre>
1.78      rillig   8846: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
1.87      wiz      8847:     dir2</code></span>&#8221; to the
                   8848:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8849:     automatically do the right thing.</p>
1.75      rillig   8850: </div>
                   8851: <div class="sect2" lang="en">
                   8852: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8853: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8854: <p>In general, documentation should be installed into
1.87      wiz      8855:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8856:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8857:     includes the version number of the package).</p>
1.84      wiz      8858: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8859:     directory where HTML documentation is installed with the
                   8860:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8861:     is needed because otherwise the documentation ends up in
                   8862:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8863:     places.</p>
                   8864: <p>An exception to the above is that library API documentation
1.91      rillig   8865:     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      8866:     browsers (devhelp) should be left at their default location, which
                   8867:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8868:     documentation can be recognized from files ending in
                   8869:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8870:     (It is also acceptable to install such files in
                   8871:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8872:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8873:     <code class="filename">.devhelp*</code> file must be directly in that
                   8874:     directory then, no additional subdirectory level is allowed in
                   8875:     this case. This is usually achieved by using
                   8876:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8877:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8878:     though.)</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="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8883: <p>Certain packages, most of them in the games category, install
1.87      wiz      8884:     a score file that allows all users on the system to record their
                   8885:     highscores.  In order for this to work, the binaries need to be
                   8886:     installed setgid and the score files owned by the appropriate
                   8887:     group and/or owner (traditionally the "games" user/group).  The
                   8888:     following variables, documented in more detail in
                   8889:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8890:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8891:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8892:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
1.75      rillig   8893: <p>Note that per default, setgid installation of games is
1.87      wiz      8894:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8895:     the other variables accordingly.</p>
1.114     jmcneill 8896: <p>A package should therefore never hard code file ownership or
1.87      wiz      8897:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8898:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8899:     correctly.</p>
1.75      rillig   8900: </div>
                   8901: <div class="sect2" lang="en">
                   8902: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8903: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8904: <p><code class="varname">DESTDIR</code> support means that a package
                   8905:     installs into a staging directory, not the final location of the
                   8906:     files. Then a binary package is created which can be used for
                   8907:     installation as usual. There are two ways: Either the package must
                   8908:     install as root (&#8220;<span class="quote">destdir</span>&#8221;) or the package can
                   8909:     install as non-root user (&#8220;<span class="quote">user-destdir</span>&#8221;).</p>
                   8910: <div class="itemizedlist"><ul type="disc">
                   8911: <li><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
                   8912:       set to &#8220;<span class="quote">destdir</span>&#8221; or &#8220;<span class="quote">user-destdir</span>&#8221;. If
                   8913:       bsd.prefs.mk is included in the Makefile,
                   8914:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8915:       the inclusion.</p></li>
1.103     wiz      8916: <li><p>All installation operations have to be prefixed with
                   8917:       <code class="filename">${DESTDIR}</code>.</p></li>
                   8918: <li><p>automake gets this DESTDIR mostly right
                   8919:       automatically. Many manual rules and pre/post-install often are
                   8920:       incorrect; fix them.</p></li>
                   8921: <li><p>If files are installed with special owner/group
1.118     imil     8922:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.103     wiz      8923: <li><p>In general, packages should support
                   8924:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8925:       DESTDIR.</p></li>
                   8926: </ul></div>
                   8927: </div>
                   8928: <div class="sect2" lang="en">
                   8929: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8930: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8931: <p>Your package may also contain scripts with hardcoded paths to
                   8932:       other interpreters besides (or as well as) perl.  To correct the
                   8933:       full pathname to the script interpreter, you need to set the
                   8934:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8935:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8936: <pre class="programlisting">
1.100     rillig   8937: REPLACE_INTERPRETER+=   tcl
                   8938: REPLACE.tcl.old=        .*/bin/tclsh
                   8939: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8940: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8941: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      8942:     </pre>
1.75      rillig   8943: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8944: <h3 class="title">Note</h3>
                   8945: <p>Before March 2006, these variables were called
1.87      wiz      8946:     <code class="varname">_REPLACE.*</code> and
                   8947:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8948: </div>
                   8949: </div>
                   8950: <div class="sect2" lang="en">
                   8951: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8952: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8953: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8954:     the Makefile fragment
                   8955:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8956:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8957:     configuration for such modules as well as various hooks to tune
                   8958:     this configuration.  See comments in this file for
                   8959:     details.</p>
1.75      rillig   8960: <p>Perl5 modules will install into different places depending
1.87      wiz      8961:     on the version of perl used during the build process.  To
                   8962:     address this, pkgsrc will append lines to the
                   8963:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8964:     the installed <code class="filename">.packlist</code> file generated by
                   8965:     most perl5 modules.  This is invoked by defining
                   8966:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8967:     paths to packlist files, e.g.:</p>
1.75      rillig   8968: <pre class="programlisting">
1.100     rillig   8969: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
1.87      wiz      8970:     </pre>
1.75      rillig   8971: <p>The variables <code class="varname">PERL5_SITELIB</code>,
1.87      wiz      8972:     <code class="varname">PERL5_SITEARCH</code>, and
                   8973:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8974:     in which perl5 modules may be installed, and may be used by
                   8975:     perl5 packages that don't have a packlist.  These three
                   8976:     variables are also substituted for in the
                   8977:     <code class="filename">PLIST</code>.</p>
1.75      rillig   8978: </div>
                   8979: <div class="sect2" lang="en">
                   8980: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8981: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8982: <p>Some packages install info files or use the
1.87      wiz      8983:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8984:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8985:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8986:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8987:     handle registration of the info files in the Info directory
                   8988:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   8989:     files registration is either provided by the system, or by a
                   8990:     special purpose package automatically added as dependency if
                   8991:     needed.</p>
1.75      rillig   8992: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8993:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8994:     located. <code class="varname">PKGINFODIR</code> defaults to
                   8995:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
1.75      rillig   8996: <p>The info files for the package should be listed in the
1.87      wiz      8997:     package <code class="filename">PLIST</code>; however any split info files
                   8998:     need not be listed.</p>
1.75      rillig   8999: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
1.87      wiz      9000:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   9001:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   9002:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   9003:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9004:     variable in the package <code class="filename">Makefile</code>. By
                   9005:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9006:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9007:     does not match the required minimum, a build dependency on the
1.91      rillig   9008:     <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      9009:     be added automatically.</p>
1.75      rillig   9010: <p>The build and installation process of the software provided
1.87      wiz      9011:     by the package should not use the
1.110     hubertf  9012:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9013:     info files is the task of the package
                   9014:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9015:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9016: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9017:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9018:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9019:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9020: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9021:     no effect except the logging of a message. The script overriding
1.110     hubertf  9022:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9023:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9024:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9025: </div>
                   9026: <div class="sect2" lang="en">
                   9027: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9028: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   9029: <p>All packages that install manual pages should install them
1.87      wiz      9030:     into the same directory, so that there is one common place to look
                   9031:     for them. In pkgsrc, this place is
                   9032:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9033:     should be used in packages. The default for
                   9034:     <code class="varname">PKGMANDIR</code> is
                   9035:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   9036:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
1.75      rillig   9037: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9038: <h3 class="title">Note</h3>
1.87      wiz      9039: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9040:     is far from complete.</p>
1.75      rillig   9041: </div>
1.81      rillig   9042: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9043:     <code class="filename">man/</code> as the top level directory for the man
                   9044:     page file entries, and the pkgsrc framework will convert as
                   9045:     needed. In all other places, the correct
                   9046:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9047: <p>Packages that are
                   9048:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   9049:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   9050:     <code class="filename">./configure</code>
                   9051:     --mandir switch to set where the man pages should be installed.
                   9052:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9053:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9054: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9055:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   9056:     to &#8220;<span class="quote">no</span>&#8221;.
                   9057:     Or if the <code class="filename">./configure</code> script uses
                   9058:     a non-standard use of --mandir, you can set
                   9059:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  9060: <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      9061:     information on installation of compressed manual pages.</p>
1.75      rillig   9062: </div>
                   9063: <div class="sect2" lang="en">
                   9064: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   9065: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      9066: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   9067:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      9068:     you need to take some extra steps to make sure they get registered
                   9069:     in the database:</p>
1.75      rillig   9070: <div class="orderedlist"><ol type="1">
1.107     rillig   9071: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      9072:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   9073:        takes care of rebuilding the GConf database at installation and
1.87      wiz      9074:        deinstallation time, and tells the package where to install
1.107     rillig   9075:        GConf data files using some standard configure arguments.  It
1.87      wiz      9076:        also disallows any access to the database directly from the
                   9077:        package.</p></li>
1.75      rillig   9078: <li><p>Ensure that the package installs its
1.87      wiz      9079:        <code class="filename">.schemas</code> files under
                   9080:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9081:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9082:        need to manually patch the package.</p></li>
1.75      rillig   9083: <li><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      9084:        directory, as they will be handled automatically.  See
1.110     hubertf  9085:        <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   9086: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      9087:        your <code class="filename">Makefile</code> with a list of all
                   9088:        <code class="filename">.schemas</code> files installed by the package, if
                   9089:        any.  Names must not contain any directories in them.</p></li>
1.107     rillig   9090: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      9091:        your <code class="filename">Makefile</code> with a
                   9092:        list of all <code class="filename">.entries</code> files installed by the
                   9093:        package, if any. Names must not contain any directories in
                   9094:        them.</p></li>
1.75      rillig   9095: </ol></div>
                   9096: </div>
                   9097: <div class="sect2" lang="en">
                   9098: <div class="titlepage"><div><div><h3 class="title">
1.119     mishka   9099: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      9100: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   9101:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      9102:     get registered in the database:</p>
1.75      rillig   9103: <div class="orderedlist"><ol type="1">
                   9104: <li><p>Include
1.119     mishka   9105:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9106:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      9107:        takes care of rebuilding the scrollkeeper database at
                   9108:        installation and deinstallation time, and disallows any access
                   9109:        to it directly from the package.</p></li>
1.75      rillig   9110: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9111:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9112:        will be handled automatically.</p></li>
1.76      rillig   9113: <li><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   9114:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9115:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   9116: </ol></div>
                   9117: </div>
                   9118: <div class="sect2" lang="en">
                   9119: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9120: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9121: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9122:     the fonts database in the directory where they get installed at
                   9123:     installation and deinstallation time.  This can be automatically
                   9124:     done by using the pkginstall framework.</p>
1.75      rillig   9125: <p>You can list the directories where fonts are installed in the
1.87      wiz      9126:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9127:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   9128:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   9129:     Also make sure that the database file
                   9130:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9131: <p>Note that you should not create new directories for fonts;
1.87      wiz      9132:     instead use the standard ones to avoid that the user needs to
                   9133:     manually configure his X server to find them.</p>
1.75      rillig   9134: </div>
                   9135: <div class="sect2" lang="en">
                   9136: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9137: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9138: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9139:     take some extra steps to get them registered in the GTK2 database
                   9140:     properly:</p>
1.75      rillig   9141: <div class="orderedlist"><ol type="1">
                   9142: <li><p>Include
1.87      wiz      9143:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9144:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9145:       rebuilding the database at installation and deinstallation time.</p></li>
                   9146: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   9147:       your package installs GTK2 immodules.</p></li>
                   9148: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   9149:       GTK2 loaders.</p></li>
1.75      rillig   9150: <li>
1.87      wiz      9151: <p>Patch the package to not touch any of the GTK2
                   9152:       databases directly.  These are:</p>
1.75      rillig   9153: <div class="itemizedlist"><ul type="disc">
1.76      rillig   9154: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9155: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9156: </ul></div>
                   9157: </li>
1.87      wiz      9158: <li><p>Check the <code class="filename">PLIST</code> and remove
                   9159:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9160:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9161: </ol></div>
                   9162: </div>
                   9163: <div class="sect2" lang="en">
                   9164: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9165: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9166: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9167:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9168:     etc.), you need to take some extra steps:</p>
1.75      rillig   9169: <div class="orderedlist"><ol type="1">
                   9170: <li><p>Include
1.87      wiz      9171:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9172:        your <code class="filename">Makefile</code>, which takes care of
                   9173:        registering those files in system-wide catalogs at
                   9174:        installation and deinstallation time.</p></li>
1.75      rillig   9175: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9176:        any SGML catalogs installed by the package.</p></li>
1.75      rillig   9177: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9178:        any XML catalogs installed by the package.</p></li>
1.75      rillig   9179: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9180:        to be added to the SGML catalog.  These come in groups of
                   9181:        three strings; see xmlcatmgr(1) for more information
                   9182:        (specifically, arguments recognized by the 'add' action).
                   9183:        Note that you will normally not use this variable.</p></li>
1.75      rillig   9184: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9185:        to be added to the XML catalog.  These come in groups of three
                   9186:        strings; see xmlcatmgr(1) for more information (specifically,
                   9187:        arguments recognized by the 'add' action).  Note that you will
                   9188:        normally not use this variable.</p></li>
1.75      rillig   9189: </ol></div>
                   9190: </div>
                   9191: <div class="sect2" lang="en">
                   9192: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9193: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9194: <p>If a package provides extensions to the MIME database by
1.87      wiz      9195:     installing <code class="filename">.xml</code> files inside
                   9196:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9197:     need to take some extra steps to ensure that the database is kept
                   9198:     consistent with respect to these new files:</p>
1.75      rillig   9199: <div class="orderedlist"><ol type="1">
                   9200: <li><p>Include
1.87      wiz      9201:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9202:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9203:        this same directory, which is reserved for inclusion from
                   9204:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9205:        care of rebuilding the MIME database at installation and
                   9206:        deinstallation time, and disallows any access to it directly
                   9207:        from the package.</p></li>
1.75      rillig   9208: <li><p>Check the PLIST and remove any entries under the
1.87      wiz      9209:        <code class="filename">share/mime</code> directory,
                   9210:        <span class="emphasis"><em>except</em></span> for files saved under
                   9211:        <code class="filename">share/mime/packages</code>.  The former are
                   9212:        handled automatically by
                   9213:        the update-mime-database program, but the latter are
                   9214:        package-dependent and must be removed by the package that
                   9215:        installed them in the first place.</p></li>
1.76      rillig   9216: <li><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9217:        from the PLIST.  They will be handled by the shared-mime-info
                   9218:        package.</p></li>
1.75      rillig   9219: </ol></div>
                   9220: </div>
                   9221: <div class="sect2" lang="en">
                   9222: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9223: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9224: <p>If a package uses intltool during its build, add
                   9225:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9226:     which forces it to use the intltool package provided by pkgsrc,
                   9227:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9228: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9229:     latest available version; this way, the package benefits of any
                   9230:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9231: </div>
                   9232: <div class="sect2" lang="en">
                   9233: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9234: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9235: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9236:     the startup directory by default, but you can enable it, by adding
                   9237:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9238:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9239:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9240:     it will automatically remove the scripts when the package is
                   9241:     deinstalled.</p>
1.75      rillig   9242: </div>
                   9243: <div class="sect2" lang="en">
                   9244: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9245: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9246: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9247:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9248:     updated.</p>
1.75      rillig   9249: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9250: <h3 class="title">Note</h3>
1.125   ! wiz      9251: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9252:     packages should install files
1.125   ! wiz      9253:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
        !          9254:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9255: </div>
                   9256: <div class="orderedlist"><ol type="1">
                   9257: <li><p>Include
1.125   ! wiz      9258:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9259:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9260:       database at installation and deinstallation time.</p></li>
1.75      rillig   9261: <li>
                   9262: <p>If your package installs files into a texmf
1.87      wiz      9263:       tree other than the one
1.125   ! wiz      9264:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
        !          9265:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9266:       trees that need database update.</p>
1.75      rillig   9267: <p>If your package also installs font map files that need
1.110     hubertf  9268:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.125   ! wiz      9269:       include <code class="filename">../../print/texlive-tetex/map.mk</code> and
        !          9270:       set <code class="varname">TEX_MAP_FILES</code> and/or
        !          9271:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9272:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9273:       be run automatically at installation/deinstallation to
                   9274:       enable/disable font map files for TeX output
                   9275:       drivers.</p>
1.75      rillig   9276: </li>
1.76      rillig   9277: <li><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9278:       databases are included in <code class="filename">PLIST</code>, as
                   9279:       they will be removed only by the teTeX-bin package.</p></li>
1.75      rillig   9280: </ol></div>
                   9281: </div>
1.85      jmmv     9282: <div class="sect2" lang="en">
                   9283: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9284: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      9285:     emulation</h3></div></div></div>
                   9286: <p>There are some packages that provide libraries and
                   9287:     executables for running binaries from a one operating system
                   9288:     on a different one (if the latter supports it).  One example
                   9289:     is running Linux binaries on NetBSD.</p>
1.91      rillig   9290: <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      9291:     helps in extracting and packaging Linux rpm packages.</p>
                   9292: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9293:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9294:     if all libraries for each installed executable can be found by
                   9295:     the dynamic linker.  Since the standard dynamic linker is run,
                   9296:     this fails for emulation packages, because the libraries used
                   9297:     by the emulation are not in the standard directories.</p>
                   9298: </div>
                   9299: <div class="sect2" lang="en">
                   9300: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9301: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9302: <p>If a package installs images under the
1.87      wiz      9303:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9304:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9305:     database, you need to take some extra steps to make sure that the
                   9306:     shared theme directory is handled appropriately and that the cache
                   9307:     database is rebuilt:</p>
1.85      jmmv     9308: <div class="orderedlist"><ol type="1">
                   9309: <li><p>Include
1.87      wiz      9310:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9311: <li><p>Check the <code class="filename">PLIST</code> and remove the
                   9312:        entry that refers to the theme cache.</p></li>
1.85      jmmv     9313: <li><p>Ensure that the PLIST does not remove the shared icon
                   9314:          directories from the <code class="filename">share/icons/hicolor</code>
                   9315:          hierarchy because they will be handled automatically.</p></li>
                   9316: </ol></div>
                   9317: <p>The best way to verify that the PLIST is correct with
                   9318:       respect to the last two points is to regenerate it using
1.110     hubertf  9319:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     9320: </div>
                   9321: <div class="sect2" lang="en">
                   9322: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9323: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9324: <p>If a package installs <code class="filename">.desktop</code> files
                   9325:       under <code class="filename">share/applications</code> and these include
                   9326:       MIME information, you need to take extra steps to ensure that they
                   9327:       are registered into the MIME database:</p>
                   9328: <div class="orderedlist"><ol type="1">
                   9329: <li><p>Include
                   9330:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9331: <li><p>Check the PLIST and remove the entry that refers to the
                   9332:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9333:          It will be handled automatically.</p></li>
                   9334: </ol></div>
                   9335: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  9336:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     9337:       print-PLIST</strong></span>.</p>
1.75      rillig   9338: </div>
                   9339: </div>
1.87      wiz      9340: <div class="sect1" lang="en">
                   9341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9342: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9343: <p>In some cases one does not have the time to solve a problem
1.125   ! wiz      9344:   immediately. In this case, one can plainly mark a package as broken.  For
        !          9345:   this, one just sets the variable <code class="varname">BROKEN</code> to the
        !          9346:   reason why the package is broken (similar to the
        !          9347:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
        !          9348:   the package will immediately be shown this message, and the build
        !          9349:   will not be even tried.</p>
        !          9350: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87      wiz      9351:   intervals.</p>
                   9352: </div>
1.75      rillig   9353: </div>
                   9354: <div class="chapter" lang="en">
                   9355: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9356: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      9357: <p>To check out all the gotchas when building a package, here are
                   9358:   the steps that I do in order to get a package working.  Please note
                   9359:   this is basically the same as what was explained in the previous
                   9360:   sections, only with some debugging aids.</p>
1.75      rillig   9361: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9362: <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   9363: <li>
1.91      rillig   9364: <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      9365:       create a directory for a new package, change into it, then run
1.110     hubertf  9366:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   9367: <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>
                   9368: <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>
                   9369: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9370: </li>
1.76      rillig   9371: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9372: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.110     hubertf  9373: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.75      rillig   9374: <li><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9375:       configure step to the package's
                   9376:       <code class="filename">Makefile</code>.</p></li>
1.75      rillig   9377: <li>
                   9378: <p>Make the package compile, doing multiple rounds of</p>
                   9379: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9380: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9381: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9382: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9383: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9384: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9385: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9386: <p>Doing this step as non-root user will ensure that no files
                   9387:       are modified that shouldn't be, especially during the build
1.110     hubertf  9388:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9389:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.91      rillig   9390:       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      9391:       package.</p>
1.75      rillig   9392: </li>
1.88      wiz      9393: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.123     snj      9394:       necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, &#8220;Makefile&#8221;</a>.</p></li>
1.75      rillig   9395: <li>
1.76      rillig   9396: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9397: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9398: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9399: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9400: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9401: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9402: <p>You usually need to be <code class="username">root</code> to do
                   9403:       this.  Look if there are any files left:</p>
1.75      rillig   9404: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9405: <p>If this reveals any files that are missing in
1.88      wiz      9406:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9407: </li>
                   9408: <li>
1.88      wiz      9409: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9410:       package again and make a binary package:</p>
1.75      rillig   9411: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9412: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9413: </li>
                   9414: <li>
                   9415: <p>Delete the installed package:</p>
1.88      wiz      9416: <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   9417: </li>
                   9418: <li>
1.110     hubertf  9419: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      9420:       command, which shouldn't find anything now:</p>
1.75      rillig   9421: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9422: </li>
                   9423: <li>
                   9424: <p>Reinstall the binary package:</p>
1.93      rillig   9425: <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   9426: </li>
1.88      wiz      9427: <li><p>Play with it.  Make sure everything works.</p></li>
1.75      rillig   9428: <li>
1.110     hubertf  9429: <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      9430:       reports:</p>
1.75      rillig   9431: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9432: </li>
1.110     hubertf  9433: <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   9434: </ul></div>
                   9435: </div>
                   9436: <div class="chapter" lang="en">
                   9437: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9438: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   9439: <div class="toc">
                   9440: <p><b>Table of Contents</b></p>
                   9441: <dl>
1.106     rillig   9442: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9443: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9444: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9445: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   9446: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     9447: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   9448: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9449: </dl>
                   9450: </div>
                   9451: <div class="sect1" lang="en">
                   9452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9453: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9454: <p>Our policy is that we accept binaries only from pkgsrc
                   9455:        developers to guarantee that the packages don't contain any
                   9456:        trojan horses etc. This is not to annoy anyone but rather to
                   9457:        protect our users! You're still free to put up your home-made
                   9458:        binary packages and tell the world where to get them. NetBSD
                   9459:        developers doing bulk builds and wanting to upload them please
1.110     hubertf  9460:        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   9461: </div>
                   9462: <div class="sect1" lang="en">
                   9463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9464: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9465: <p>First, check that your package is complete, compiles and
1.110     hubertf  9466:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
                   9467:        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   9468:        archive that contains all files that make up the package.
1.87      wiz      9469:        Finally, send this package to the pkgsrc bug tracking system,
1.110     hubertf  9470:        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      9471:        that, go to the web page
1.110     hubertf  9472:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124     snj      9473:        which contains some instructions and a link to a form where you
                   9474:        can submit packages.  The
                   9475:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
                   9476:        also available as a substitute for either of the above two tools.
                   9477:        </p>
1.87      wiz      9478: <p>In the form of the problem report, the category should be
                   9479:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9480:        and version number, and the description field should contain a
                   9481:        short description of your package (contents of the COMMENT
                   9482:        variable or DESCR file are OK). The uuencoded package data should
                   9483:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
1.75      rillig   9484: <p>If you want to submit several packages, please send a
                   9485:        separate PR for each one, it's easier for us to track things
                   9486:        that way.</p>
                   9487: <p>Alternatively, you can also import new packages into
                   9488:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
1.110     hubertf  9489:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.75      rillig   9490:        for details.</p>
                   9491: </div>
                   9492: <div class="sect1" lang="en">
                   9493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9494: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9495: <p>Please note all package additions, updates, moves, and
1.93      rillig   9496:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9497:        important to keep this file up to date and conforming to the
                   9498:        existing format, because it will be used by scripts to
1.110     hubertf  9499:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9500:        sites. Additionally, check the
1.76      rillig   9501:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9502:        for the package you updated or removed, in case it was mentioned
                   9503:        there.</p>
                   9504: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9505:        bumped, the change should appear in
1.93      rillig   9506:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9507:        related or otherwise relevant. Mass bumps that result from a
                   9508:        dependency being updated should not be mentioned. In all other
                   9509:        cases it's the developer's decision.</p>
                   9510: <p>There is a make target that helps in creating proper
1.110     hubertf  9511:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9512:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9513:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9514:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9515:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9516:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9517:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9518:   For new packages, or package moves or removals, set the
                   9519:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9520:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9521:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125   ! wiz      9522:   not the same as your NetBSD login name. The target also automatically
        !          9523:   removes possibly existing entries for the package in the
        !          9524:   <code class="filename">TODO</code> file. Don't forget to commit
        !          9525:   the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
        !          9526:   If you are not using a checkout directly from cvs.netbsd.org, but e.g.
        !          9527:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
        !          9528:   makes the cvs commands use the main repository.
        !          9529:   </p>
1.75      rillig   9530: </div>
                   9531: <div class="sect1" lang="en">
                   9532: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9533: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.87      wiz      9534: <p>This section is only of interest for pkgsrc developers with write
1.75      rillig   9535:   access to the pkgsrc repository. Please remember that cvs
                   9536:   imports files relative to the current working directory, and that
                   9537:   the pathname that you
1.110     hubertf  9538:   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.75      rillig   9539:   to place the files in the repository.  Newly created packages should be
                   9540:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
1.87      wiz      9541:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
1.75      rillig   9542: <pre class="programlisting">
1.100     rillig   9543: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9544: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
1.75      rillig   9545: </pre>
1.87      wiz      9546: <p>Remember to move the directory from which you imported out of
1.75      rillig   9547:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9548:   update</span>&#8221; your source tree.  Also don't forget to add the new
1.87      wiz      9549:   package to the category's <code class="filename">Makefile</code>.</p>
                   9550: <p>The commit message of the initial import should include part of the
1.76      rillig   9551:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9552:   what the package is/does.</p>
                   9553: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
1.75      rillig   9554:   add</span>&#8221; because the former gets everything with a single command,
1.87      wiz      9555:   and provides a consistent tag.</p>
1.75      rillig   9556: </div>
                   9557: <div class="sect1" lang="en">
                   9558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9559: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9560: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9561:   changes between old and new versions into the commit log when updating
1.87      wiz      9562:   a package. There are various reasons for this:</p>
1.75      rillig   9563: <div class="itemizedlist"><ul type="disc">
1.87      wiz      9564: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9565:   or its information may be overwritten by newer information.</p></li>
                   9566: <li><p>Having the change information between old and new versions in our CVS
                   9567:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9568: <li><p>Having the change information between old and new versions in our CVS
1.75      rillig   9569:   repository is very useful for people who read the pkgsrc-changes mailing
                   9570:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9571:   the package.</p></li>
1.75      rillig   9572: </ul></div>
1.87      wiz      9573: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9574:   has been released, it should not automatically be upgraded in the CVS
                   9575:   repository.  We prefer to be conservative in the packages that are
                   9576:   included in pkgsrc - development or beta packages are not really the
                   9577:   best thing for most places in which pkgsrc is used. Please use your
                   9578:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9579:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9580: </div>
                   9581: <div class="sect1" lang="en">
                   9582: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122     reed     9583: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   9584: <p>Renaming packages is not recommended.</p>
                   9585: <p>When renaming packages, be sure to fix any references to old name
                   9586:   in other Makefiles, options, buildlink files, etc.</p>
                   9587: <p>Also When renaming a package, please define
                   9588:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   9589:   pattern(s) of the previous package name.
                   9590:   This may be repeated for multiple renames.
                   9591:   The new package would be an exact replacement.
                   9592: </p>
                   9593: <p>Note that &#8220;<span class="quote">successor</span>&#8221; in the
                   9594:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9595:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9596:   not be an exact replacement but is a suggestion for the replaced
                   9597:   functionality.</p>
                   9598: </div>
                   9599: <div class="sect1" lang="en">
                   9600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9601: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   9602: <p>It is preferred that packages are not renamed or moved, but if needed
                   9603:   please follow these steps.
                   9604: </p>
1.75      rillig   9605: <div class="orderedlist"><ol type="1">
                   9606: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9607: <li>
                   9608: <p>Remove all CVS dirs.</p>
1.87      wiz      9609: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9610: <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      9611: <p>and use that for further work.</p>
1.75      rillig   9612: </li>
                   9613: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9614: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9615: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
1.122     reed     9616: <li><p>In the modified package's Makefile, consider setting
                   9617: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9618: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9619: for doing an update using pkgsrc building; for example, it can
                   9620: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
                   9621: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9622: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9623: it may have multiple matches, so the tool should also check on the
                   9624: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9625: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9626: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.110     hubertf  9627: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9628: place.</p></li>
                   9629: <li>
                   9630: <p>Check if any package depends on it:
                   9631: </p>
                   9632: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9633: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9634: </li>
                   9635: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.110     hubertf  9636: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.76      rillig   9637: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9638: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
1.75      rillig   9639: <li>
                   9640: <p>Commit the changed and removed files:</p>
                   9641: <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      9642: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9643: </li>
                   9644: </ol></div>
                   9645: </div>
                   9646: </div>
                   9647: <div class="chapter" lang="en">
                   9648: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9649: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9650: <p>This section contains the answers to questions that may
                   9651:        arise when you are writing a package. If you don't find your
                   9652:        question answered here, first have a look in the other chapters,
                   9653:        and if you still don't have the answer, ask on the
                   9654:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9655: <div class="qandaset">
                   9656: <dl>
1.106     rillig   9657: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9658:        MAKEFLAGS, .MAKEFLAGS and
                   9659:        MAKE_FLAGS?</a>
                   9660: </dt>
1.106     rillig   9661: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9662:        MAKE, GMAKE and
                   9663:        MAKE_PROGRAM?</a>
                   9664: </dt>
1.106     rillig   9665: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9666:        CC, PKG_CC and
                   9667:        PKGSRC_COMPILER?</a>
                   9668: </dt>
1.106     rillig   9669: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9670:        BUILDLINK_LDFLAGS,
                   9671:        BUILDLINK_LDADD and
                   9672:        BUILDLINK_LIBS?</a>
                   9673: </dt>
1.106     rillig   9674: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9675:        VARNAME=BUILDLINK_PREFIX.foo
                   9676:        say it's empty?</a>
                   9677: </dt>
1.106     rillig   9678: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9679:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9680:        don't understand the := inside
                   9681:        it.</a>
                   9682: </dt>
1.106     rillig   9683: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9684:        developers?</a>
                   9685: </dt>
1.106     rillig   9686: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9687:        documentation?</a>
                   9688: </dt>
1.106     rillig   9689: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   9690: do?</a>
                   9691: </dt>
1.75      rillig   9692: </dl>
                   9693: <table border="0" summary="Q and A Set">
                   9694: <col align="left" width="1%">
                   9695: <tbody>
                   9696: <tr class="question">
                   9697: <td align="left" valign="top">
1.125   ! wiz      9698: <a name="devfaq.makeflags"></a><a name="id1168230286524"></a><p><b>22.1.</b></p>
1.75      rillig   9699: </td>
                   9700: <td align="left" valign="top"><p>What is the difference between
                   9701:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9702:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9703: </tr>
                   9704: <tr class="answer">
1.91      rillig   9705: <td align="left" valign="top"></td>
1.75      rillig   9706: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.110     hubertf  9707:        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   9708:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9709:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9710:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9711: </tr>
                   9712: <tr class="question">
                   9713: <td align="left" valign="top">
1.125   ! wiz      9714: <a name="devfaq.make"></a><a name="id1168230286557"></a><p><b>22.2.</b></p>
1.75      rillig   9715: </td>
                   9716: <td align="left" valign="top"><p>What is the difference between
                   9717:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9718:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9719: </tr>
                   9720: <tr class="answer">
1.91      rillig   9721: <td align="left" valign="top"></td>
1.75      rillig   9722: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.110     hubertf  9723:        <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   9724:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9725:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9726:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9727:        Make program that is used for building the
                   9728:        package.</p></td>
                   9729: </tr>
                   9730: <tr class="question">
                   9731: <td align="left" valign="top">
1.125   ! wiz      9732: <a name="devfaq.cc"></a><a name="id1168230286595"></a><p><b>22.3.</b></p>
1.75      rillig   9733: </td>
                   9734: <td align="left" valign="top"><p>What is the difference between
                   9735:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9736:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9737: </tr>
                   9738: <tr class="answer">
1.91      rillig   9739: <td align="left" valign="top"></td>
1.75      rillig   9740: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9741:        compiler, which can be configured by the pkgsrc user.
                   9742:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9743:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9744:        path to a compiler, but the type of compiler that should be
1.76      rillig   9745:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9746:        information about the latter variable.</p></td>
                   9747: </tr>
                   9748: <tr class="question">
                   9749: <td align="left" valign="top">
1.125   ! wiz      9750: <a name="devfaq.bl3flags"></a><a name="id1168230286629"></a><p><b>22.4.</b></p>
1.75      rillig   9751: </td>
                   9752: <td align="left" valign="top"><p>What is the difference between
                   9753:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9754:        <code class="varname">BUILDLINK_LDADD</code> and
                   9755:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9756: </tr>
                   9757: <tr class="answer">
1.91      rillig   9758: <td align="left" valign="top"></td>
1.75      rillig   9759: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9760: </tr>
                   9761: <tr class="question">
                   9762: <td align="left" valign="top">
1.125   ! wiz      9763: <a name="devfaq.bl3prefix"></a><a name="id1168230286648"></a><p><b>22.5.</b></p>
1.75      rillig   9764: </td>
1.110     hubertf  9765: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9766:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9767:        say it's empty?</p></td>
                   9768: </tr>
                   9769: <tr class="answer">
1.91      rillig   9770: <td align="left" valign="top"></td>
1.75      rillig   9771: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9772:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9773:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
1.110     hubertf  9774:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9775:        command.</p></td>
                   9776: </tr>
1.78      rillig   9777: <tr class="question">
                   9778: <td align="left" valign="top">
1.125   ! wiz      9779: <a name="devfaq.master_sites"></a><a name="id1168230286674"></a><p><b>22.6.</b></p>
1.78      rillig   9780: </td>
                   9781: <td align="left" valign="top"><p>What does
                   9782:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9783:        don't understand the <code class="literal">:=</code> inside
                   9784:        it.</p></td>
                   9785: </tr>
                   9786: <tr class="answer">
1.91      rillig   9787: <td align="left" valign="top"></td>
1.78      rillig   9788: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9789:        assignment operator, like you might expect at first sight.
                   9790:        Instead, it is a degenerate form of
                   9791:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.110     hubertf  9792:        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   9793:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9794:        case of <code class="varname">MASTER_SITE_*</code>,
                   9795:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9796:        <em class="replaceable"><code>new_string</code></em> is
                   9797:        <code class="literal">package/</code>. That's where the
                   9798:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9799:        together.</p></td>
                   9800: </tr>
                   9801: <tr class="question">
                   9802: <td align="left" valign="top">
1.125   ! wiz      9803: <a name="devfaq.mailinglists"></a><a name="id1168230286741"></a><p><b>22.7.</b></p>
1.78      rillig   9804: </td>
                   9805: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9806:        developers?</p></td>
                   9807: </tr>
                   9808: <tr class="answer">
1.91      rillig   9809: <td align="left" valign="top"></td>
1.78      rillig   9810: <td align="left" valign="top"><div class="variablelist"><dl>
1.110     hubertf  9811: <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   9812: <dd><p>This is a list for technical discussions related
                   9813:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9814:        pkgsrc infrastructure, proposed new features, questions related
                   9815:        to porting pkgsrc to a new platform, advice for maintaining a
                   9816:        package, patches that affect many packages, help requests moved
                   9817:        from pkgsrc-users when an infrastructure bug is found,
                   9818:        etc.</p></dd>
1.110     hubertf  9819: <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   9820: <dd><p>All bug reports in category "pkg" sent with
1.110     hubertf  9821:        <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   9822:        directly; use one of the other mailing
                   9823:        lists.</p></dd>
                   9824: </dl></div></td>
                   9825: </tr>
1.80      rillig   9826: <tr class="question">
                   9827: <td align="left" valign="top">
1.125   ! wiz      9828: <a name="devfaq.documentation"></a><a name="id1168230286772"></a><p><b>22.8.</b></p>
1.80      rillig   9829: </td>
                   9830: <td align="left" valign="top"><p>Where is the pkgsrc
                   9831:        documentation?</p></td>
                   9832: </tr>
                   9833: <tr class="answer">
1.91      rillig   9834: <td align="left" valign="top"></td>
1.80      rillig   9835: <td align="left" valign="top">
                   9836: <p>There are many places where you can find
                   9837:        documentation about pkgsrc:</p>
                   9838: <div class="itemizedlist"><ul type="disc">
                   9839: <li><p>The pkgsrc guide (this document) is a collection
                   9840:        of chapters that explain large parts of pkgsrc, but some
                   9841:        chapters tend to be outdated. Which ones they are is hard to
                   9842:        say.</p></li>
1.110     hubertf  9843: <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   9844:        about certain features, announcements of new parts of the pkgsrc
                   9845:        infrastructure and sometimes even announcements that a certain
                   9846:        feature has been marked as obsolete. The benefit here is that
                   9847:        each message has a date appended to it.</p></li>
                   9848: <li><p>Many of the files in the
                   9849:        <code class="filename">mk/</code> directory start with a comment that
                   9850:        describes the purpose of the file and how it can be used by the
1.92      rillig   9851:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9852:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9853:        help</strong></span>.</p></li>
1.80      rillig   9854: <li><p>The CVS log messages are a rich source of
                   9855:        information, but they tend to be highly abbreviated, especially
                   9856:        for actions that occur often. Some contain a detailed
                   9857:        description of what has changed, but they are geared towards the
                   9858:        other pkgsrc developers, not towards an average pkgsrc user.
                   9859:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9860:        don't know what has been before, these messages may not be worth
                   9861:        too much to you.</p></li>
                   9862: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9863:        documented</span>&#8221;, that is the documentation exists only in the
                   9864:        mind of the developer who wrote the code. To get this
1.110     hubertf  9865:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9866:        to see who has written it and ask on the
                   9867:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9868:        find your questions later (see above). To be sure that the
                   9869:        developer in charge reads the mail, you may CC him or
                   9870:        her.</p></li>
                   9871: </ul></div>
                   9872: </td>
                   9873: </tr>
1.92      rillig   9874: <tr class="question">
                   9875: <td align="left" valign="top">
1.125   ! wiz      9876: <a name="devfaq.too-much-time"></a><a name="id1168230286826"></a><p><b>22.9.</b></p>
1.92      rillig   9877: </td>
                   9878: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9879: do?</p></td>
                   9880: </tr>
                   9881: <tr class="answer">
                   9882: <td align="left" valign="top"></td>
                   9883: <td align="left" valign="top">
1.93      rillig   9884: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9885: anyway.</p>
                   9886: <div class="itemizedlist"><ul type="disc">
1.110     hubertf  9887: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.92      rillig   9888:     <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
                   9889:     will tell you about newer versions of installed packages that are
                   9890:     available, but not yet updated in pkgsrc.</p></li>
                   9891: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.125   ! wiz      9892:     &#8212; it contains a list of suggested new packages and a list of
1.92      rillig   9893:     cleanups and enhancements for pkgsrc that would be nice to
                   9894:     have.</p></li>
                   9895: <li><p>Review packages for which review was requested on
1.110     hubertf  9896:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.92      rillig   9897:     mailing list.</p></li>
                   9898: </ul></div>
                   9899: </td>
                   9900: </tr>
1.75      rillig   9901: </tbody>
                   9902: </table>
                   9903: </div>
                   9904: </div>
1.85      jmmv     9905: <div class="chapter" lang="en">
                   9906: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9907: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9908: <div class="toc">
                   9909: <p><b>Table of Contents</b></p>
                   9910: <dl>
1.106     rillig   9911: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9912: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9913: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9914: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9915: </dl>
                   9916: </div>
1.110     hubertf  9917: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9918: site</a>:</p>
                   9919: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9920:   environment, an intuitive and attractive desktop for users, and the
                   9921:   GNOME development platform, an extensive framework for building
                   9922:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9923: <p>pkgsrc provides a seamless way to automatically build and install
                   9924: a complete GNOME environment <span class="emphasis"><em>under many different
                   9925: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9926: the most advanced build and packaging systems for GNOME due to its
                   9927: included technologies buildlink3, the wrappers and tools framework and
                   9928: automatic configuration file management.  Lots of efforts are put into
                   9929: achieving a completely clean deinstallation of installed software
                   9930: components.</p>
1.110     hubertf  9931: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9932: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9933: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9934: pkgsrc as its preferred packaging system, contributing lots of
                   9935: portability fixes to make GNOME build and install under it.</p>
                   9936: <p>This chapter is aimed at pkgsrc developers and other people
                   9937: interested in helping our GNOME porting and packaging efforts.  It
                   9938: provides instructions on how to manage the existing packages and some
                   9939: important information regarding their internals.</p>
                   9940: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9941: <h3 class="title">We need your help!</h3>
                   9942: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9943:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9944:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9945:   work</a> list!  There is still a long way to go to get a
                   9946:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9947:   achieve it!</p>
                   9948: </div>
                   9949: <div class="sect1" lang="en">
                   9950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9951: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9952: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9953: <div class="itemizedlist"><ul type="disc">
1.91      rillig   9954: <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     9955:     the core GNOME desktop environment.  It only includes the necessary
                   9956:     bits to get it to boot correctly, although it may lack important
                   9957:     functionality for daily operation.  The idea behind this package is
                   9958:     to let end users build their own configurations on top of this one,
                   9959:     first installing this meta package to achieve a functional setup and
                   9960:     then adding individual applications.</p></li>
1.91      rillig   9961: <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     9962:     complete installation of the GNOME platform and desktop as defined
                   9963:     by the GNOME project; this is based on the components distributed in
                   9964:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9965:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9966:     official FTP server.  Developer-only tools found in those
                   9967:     directories are not installed unless required by some other
                   9968:     component to work properly.  Similarly, packages from the bindings
                   9969:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9970:     in unless required as a dependency for an end-user component.  This
1.91      rillig   9971:     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>
                   9972: <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     9973:     Installs all the tools required to build a GNOME component when
                   9974:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9975:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9976: </ul></div>
                   9977: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9978: sorted in a way that eases updates: a package may depend on other
                   9979: packages listed before it but not on any listed after it.  It is very
                   9980: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9981: change it to alphabetical sorting!</em></span></p>
                   9982: </div>
                   9983: <div class="sect1" lang="en">
                   9984: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9985: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9986: <p>Almost all GNOME applications are written in C and use a common
                   9987: set of tools as their build system.  Things get different with the new
                   9988: bindings to other languages (such as Python), but the following will
                   9989: give you a general idea on the minimum required tools:</p>
                   9990: <div class="itemizedlist"><ul type="disc">
                   9991: <li>
                   9992: <p>Almost all GNOME applications use the GNU Autotools as their
                   9993:     build system.  As a general rule you will need to tell this to your
                   9994:     package:</p>
1.100     rillig   9995: <pre class="programlisting">
                   9996: GNU_CONFIGURE=yes
1.85      jmmv     9997: USE_LIBTOOL=yes
1.100     rillig   9998: USE_TOOLS+=gmake
                   9999: </pre>
1.85      jmmv     10000: </li>
                   10001: <li>
                   10002: <p>If the package uses pkg-config to detect dependencies, add this
                   10003:     tool to the list of required utilities:</p>
                   10004: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.91      rillig   10005: <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     10006:     the end of the build process to ensure that you did not miss to
                   10007:     specify any dependency in your package and that the version
                   10008:     requirements are all correct.</p>
                   10009: </li>
1.93      rillig   10010: <li><p>If the package uses intltool, be sure to add
                   10011:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     10012:     to handle dependencies and to force the package to use the latest
                   10013:     available version.</p></li>
                   10014: <li>
                   10015: <p>If the package uses gtk-doc (a documentation generation
                   10016:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   10017:     tool is rather big and the distfile should come with pregenerated
                   10018:     documentation anyway; if it does not, it is a bug that you ought to
                   10019:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   10020:     the default):</p>
                   10021: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   10022: <p>The default location of installed HTML files
                   10023:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   10024:     and should not be changed unless the package insists on installing
                   10025:     them somewhere else.  Otherwise programs as
1.110     hubertf  10026:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   10027:     do that with an entry similar to:</p>
                   10028: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     10029: </li>
                   10030: </ul></div>
                   10031: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   10032: files under the installation prefix to maintain databases.  In this
                   10033: context, shared means that those exact same directories and files are
                   10034: used among several different packages, leading to conflicts in the
                   10035: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   10036: handle the most common cases, so you have to forget about using
                   10037: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   10038: omitting shared files from them.  If you find yourself doing those,
                   10039: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   10040: <p>The following table lists the common situations that result in
                   10041: using shared directories or files.  For each of them, the appropriate
                   10042: solution is given.  After applying the solution be sure to
                   10043: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  10044: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     10045: <div class="table">
1.106     rillig   10046: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.91      rillig   10047: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     10048: <colgroup>
                   10049: <col>
                   10050: <col>
                   10051: </colgroup>
                   10052: <thead><tr>
                   10053: <th>If the package...</th>
                   10054: <th>Then...</th>
                   10055: </tr></thead>
                   10056: <tbody>
                   10057: <tr>
                   10058: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119     mishka   10059: <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     10060: </tr>
                   10061: <tr>
                   10062: <td>Installs icons under the
                   10063:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   10064:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  10065: <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     10066: </tr>
                   10067: <tr>
                   10068: <td>Installs files under
                   10069:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  10070: <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     10071: </tr>
                   10072: <tr>
                   10073: <td>Installs <code class="filename">.desktop</code> files under
                   10074:         <code class="filename">share/applications</code> and these include MIME
                   10075:         information.</td>
1.110     hubertf  10076: <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     10077: </tr>
                   10078: </tbody>
1.91      rillig   10079: </table></div>
1.85      jmmv     10080: </div>
1.91      rillig   10081: <br class="table-break">
1.85      jmmv     10082: </div>
                   10083: <div class="sect1" lang="en">
                   10084: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10085: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     10086: <p>When seeing GNOME as a whole, there are two kinds of
                   10087: updates:</p>
                   10088: <div class="variablelist"><dl>
                   10089: <dt><span class="term">Major update</span></dt>
                   10090: <dd>
                   10091: <p>Given that there is still a very long way for GNOME 3 (if it
                   10092:       ever appears), we consider a major update one that goes from a
                   10093:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   10094:       where <code class="literal">Y</code> is even and greater than
                   10095:       <code class="literal">X</code>.  These are hard to achieve because they
                   10096:       introduce lots of changes in the components' code and almost all
                   10097:       GNOME distfiles are updated to newer versions.  Some of them can
                   10098:       even break API and ABI compatibility with the previous major
                   10099:       version series.  As a result, the update needs to be done all at
                   10100:       once to minimize breakage.</p>
                   10101: <p>A major update typically consists of around 80 package
                   10102:       updates and the addition of some new ones.</p>
                   10103: </dd>
                   10104: <dt><span class="term">Minor update</span></dt>
                   10105: <dd>
                   10106: <p>We consider a minor update one that goes from a
                   10107:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10108:       one where <code class="literal">Y</code> is greater than
                   10109:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10110:       not update all GNOME components, can be done in an incremental way
                   10111:       and do not break API nor ABI compatibility.</p>
                   10112: <p>A minor update typically consists of around 50 package
                   10113:       updates, although the numbers here may vary a lot.</p>
                   10114: </dd>
                   10115: </dl></div>
                   10116: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10117: release (either major or minor), the following steps should be
                   10118: followed:</p>
                   10119: <div class="orderedlist"><ol type="1">
                   10120: <li>
                   10121: <p>Get a list of all the tarballs that form the new release by
                   10122:     using the following commands.  These will leave the full list of the
1.120     snj      10123:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     10124:     file:</p>
1.88      wiz      10125: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10126:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10127:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      10128: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     10129:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10130:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10131: </li>
                   10132: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   10133:     bump their version to the release you are updating them to.  The
                   10134:     three meta packages should be always consistent with versioning.
                   10135:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10136:     in them.</p></li>
                   10137: <li>
                   10138: <p>For each meta package, update all its
                   10139:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10140:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10141:     newer version (even if found in the FTP) because the meta packages
                   10142:     are supposed to list the exact versions that form a specific GNOME
                   10143:     release.  Exceptions are permitted here if a newer version solves a
                   10144:     serious issue in the overall desktop experience; these typically
                   10145:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10146:     from the developers.</p>
                   10147: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10148:     should be updated to the latest version available (if found in
                   10149:     pkgsrc).  This is the case, for example, of the dependencies on the
1.91      rillig   10150:     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     10151: </li>
                   10152: <li>
                   10153: <p>Generate a patch from the modified meta packages and extract the
                   10154:     list of "new" lines.  This will provide you an outline on what
                   10155:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   10156: <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     10157: </li>
                   10158: <li><p>For major desktop updates it is recommended to zap all your
                   10159:     installed packages and start over from scratch at this point.</p></li>
                   10160: <li><p>Now comes the longest step by far: iterate over the contents
                   10161:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10162:     it in order.  For major desktop updates none of these should be
1.93      rillig   10163:     committed until the entire set is completed because there are chances
1.85      jmmv     10164:     of breaking not-yet-updated packages.</p></li>
                   10165: <li><p>Once the packages are up to date and working, commit them to
                   10166:     the tree one by one with appropriate log messages.  At the end,
                   10167:     commit the three meta package updates and all the corresponding
                   10168:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10169:     <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>
                   10170: </ol></div>
                   10171: </div>
                   10172: <div class="sect1" lang="en">
                   10173: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10174: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     10175: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10176: packages.  Please, it is very important that you always, always,
                   10177: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  10178: 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     10179: their attention on portability issues and to ensure that future versions
                   10180: can be built out-of-the box on NetBSD.  The less custom patches in
                   10181: pkgsrc, the easier further updates are.  Those developers in charge of
                   10182: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  10183: <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     10184: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10185: of them do.  Do not be short on your reports: always provide detailed
                   10186: explanations of the current failure, how it can be improved to achieve
                   10187: maximum portability and, if at all possible, provide a patch against CVS
                   10188: head.  The more verbose you are, the higher chances of your patch being
                   10189: accepted.</p>
                   10190: <p>Also, please avoid using preprocessor magic to fix portability
                   10191: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10192: GNOME to their operating system, the official GNOME sources are now
                   10193: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10194: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  10195: 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     10196: details.</p>
                   10197: </div>
                   10198: </div>
1.75      rillig   10199: </div>
                   10200: <div class="part" lang="en">
                   10201: <div class="titlepage"><div><div><h1 class="title">
                   10202: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   10203: <div class="partintro" lang="en">
                   10204: <div></div>
                   10205: <p>This part of the guide deals with everything
                   10206:        from the infrastructure that is behind the interfaces described
                   10207:        in the developer's guide. A casual package maintainer should not
                   10208:        need anything from this part.</p>
                   10209: <div class="toc">
                   10210: <p><b>Table of Contents</b></p>
                   10211: <dl>
1.106     rillig   10212: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10213: <dd><dl>
1.106     rillig   10214: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10215: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10216: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   10217: <dd><dl>
1.106     rillig   10218: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10219: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   10220: </dl></dd>
1.106     rillig   10221: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10222: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10223: <dd><dl>
1.106     rillig   10224: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10225: <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   10226: </dl></dd>
1.106     rillig   10227: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10228: <dd><dl>
1.123     snj      10229: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
                   10230: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75      rillig   10231: </dl></dd>
                   10232: </dl></dd>
1.106     rillig   10233: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   10234: <dd><dl>
1.106     rillig   10235: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10236: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10237: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10238: <dd><dl>
1.106     rillig   10239: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10240: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10241: </dl></dd>
                   10242: </dl></dd>
1.106     rillig   10243: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.75      rillig   10244: <dd><dl>
1.106     rillig   10245: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10246: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10247: </dl></dd>
                   10248: </dl>
                   10249: </div>
                   10250: </div>
                   10251: <div class="chapter" lang="en">
                   10252: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10253: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10254: <div class="toc">
                   10255: <p><b>Table of Contents</b></p>
                   10256: <dl>
1.106     rillig   10257: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10258: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10259: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   10260: <dd><dl>
1.106     rillig   10261: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10262: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   10263: </dl></dd>
1.106     rillig   10264: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10265: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10266: <dd><dl>
1.106     rillig   10267: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10268: <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   10269: </dl></dd>
1.106     rillig   10270: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10271: <dd><dl>
1.123     snj      10272: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
                   10273: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.75      rillig   10274: </dl></dd>
                   10275: </dl>
                   10276: </div>
                   10277: <p>The pkgsrc infrastructure consists of many small Makefile
                   10278:        fragments. Each such fragment needs a properly specified
                   10279:        interface. This chapter explains how such an interface looks
                   10280:        like.</p>
                   10281: <div class="sect1" lang="en">
                   10282: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10283: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10284: <p>Whenever a variable is defined in the pkgsrc
                   10285:        infrastructure, the location and the way of definition provide
                   10286:        much information about the intended use of that variable.
                   10287:        Additionally, more documentation may be found in a header
                   10288:        comment or in this pkgsrc guide.</p>
                   10289: <p>A special file is
                   10290:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10291:        variables that are intended to be user-defined. They are either
                   10292:        defined using the <code class="literal">?=</code> operator or they are
                   10293:        left undefined because defining them to anything would
                   10294:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10295:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10296:        file.</p>
                   10297: <p>Outside this file, the following conventions apply:
                   10298:        Variables that are defined using the <code class="literal">?=</code>
                   10299:        operator may be overridden by a package.</p>
                   10300: <p>Variables that are defined using the <code class="literal">=</code>
                   10301:        operator may be used read-only at run-time.</p>
                   10302: <p>Variables whose name starts with an underscore must not be
                   10303:        accessed outside the pkgsrc infrastructure at all. They may
                   10304:        change without further notice.</p>
                   10305: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10306: <h3 class="title">Note</h3>
                   10307: <p>These conventions are currently not applied
                   10308:        consistently to the complete pkgsrc
                   10309:        infrastructure.</p>
                   10310: </div>
                   10311: </div>
                   10312: <div class="sect1" lang="en">
                   10313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10314: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10315: <p>All variables that contain lists of things should default
                   10316:        to being empty. Two examples that do not follow this rule are
                   10317:        <code class="varname">USE_LANGUAGES</code> and
                   10318:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10319:        modified using the <code class="literal">+=</code> operator in package
                   10320:        <code class="filename">Makefile</code>s (or other files included by
                   10321:        them), since there is no guarantee whether the variable is
                   10322:        already set or not, and what its value is. In the case of
                   10323:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10324:        the default value and just define it as in the following
                   10325:        example.</p>
                   10326: <pre class="programlisting">
1.100     rillig   10327: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10328: </pre>
                   10329: <p>Because of the selection of this default value, the same
                   10330:        value appears in many package Makefiles. Similarly for
                   10331:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10332:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10333:        doesn't stand out. Nevertheless it is mentioned in many
                   10334:        files.</p>
                   10335: </div>
                   10336: <div class="sect1" lang="en">
                   10337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10338: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.75      rillig   10339: <div class="sect2" lang="en">
                   10340: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10341: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   10342: <p>Variable evaluation takes place either at load time or at
                   10343:        runtime, depending on the context in which they occur. The
                   10344:        contexts where variables are evaluated at load time are:</p>
                   10345: <div class="itemizedlist"><ul type="disc">
                   10346: <li><p>The right hand side of the <code class="literal">:=</code>
                   10347:        and <code class="literal">!=</code> operators,</p></li>
                   10348: <li><p>Make directives like <code class="literal">.if</code> or
                   10349:        <code class="literal">.for</code>,</p></li>
                   10350: <li><p>Dependency lines.</p></li>
                   10351: </ul></div>
                   10352: <p>A special exception are references to the iteration
                   10353:        variables of <code class="literal">.for</code> loops, which are expanded
                   10354:        inline, no matter in which context they appear.</p>
                   10355: <p>As the values of variables may change during load time,
                   10356:        care must be taken not to evaluate them by accident. Typical
                   10357:        examples for variables that should not be evaluated at load time
                   10358:        are <code class="varname">DEPENDS</code> and
                   10359:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10360:        clear, here is an example:</p>
                   10361: <pre class="programlisting">
1.100     rillig   10362: CONFIGURE_ARGS=         # none
                   10363: CFLAGS=                 -O
                   10364: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10365: 
1.100     rillig   10366: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10367: 
1.100     rillig   10368: CFLAGS+=                -Wall
1.75      rillig   10369:        </pre>
                   10370: <p>This code shows how the use of the <code class="literal">:=</code>
                   10371:        operator can quickly lead to unexpected results. The first
                   10372:        paragraph is fairly common code. The second paragraph evaluates
                   10373:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10374:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10375:        <code class="literal">-Wall</code> is appended to the
                   10376:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10377:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10378:        paragraphs from above typically occur in completely unrelated
                   10379:        files.</p>
                   10380: </div>
                   10381: <div class="sect2" lang="en">
                   10382: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10383: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   10384: <p>After all the files have been loaded, the values of the
                   10385:        variables cannot be changed anymore. Variables that are used in
                   10386:        the shell commands are expanded at this point.</p>
                   10387: </div>
                   10388: </div>
                   10389: <div class="sect1" lang="en">
                   10390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10391: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10392: <p>There are many ways in which the definition and use of a
                   10393:        variable can be restricted in order to detect bugs and
                   10394:        violations of the (mostly unwritten) policies. See the
                   10395:        <code class="literal">pkglint</code> developer's documentation for further
                   10396:        details.</p>
                   10397: </div>
                   10398: <div class="sect1" lang="en">
                   10399: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10400: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10401: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10402:        of the following classes. Cases where a file falls into more
                   10403:        than one class should be avoided as it often leads to subtle
                   10404:        bugs.</p>
                   10405: <div class="sect2" lang="en">
                   10406: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10407: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10408: <p>In a traditional imperative programming language some of
1.76      rillig   10409:        the <code class="filename">.mk</code> files could be described as
1.125   ! wiz      10410:        procedures. They take some input parameters and&#8212;after
        !          10411:        inclusion&#8212;provide a result in output parameters. Since all
1.76      rillig   10412:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10413:        care must be taken not to use parameter names that have already
                   10414:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10415:        bad choice for a parameter name.</p>
                   10416: <p>Procedures are completely evaluated at preprocessing time.
                   10417:        That is, when calling a procedure all input parameters must be
                   10418:        completely resolvable. For example,
                   10419:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10420:        parameter since it is very likely that further text will be
                   10421:        added after calling the procedure, which would effectively apply
                   10422:        the procedure to only a part of the variable. Also, references
                   10423:        to other variables wit will be modified after calling the
                   10424:        procedure.</p>
                   10425: <p>A procedure can declare its output parameters either as
                   10426:        suitable for use in preprocessing directives or as only
                   10427:        available at runtime. The latter alternative is for variables
                   10428:        that contain references to other runtime variables.</p>
                   10429: <p>Procedures shall be written such that it is possible to
                   10430:        call the procedure more than once. That is, the file must not
                   10431:        contain multiple-inclusion guards.</p>
                   10432: <p>Examples for procedures are
1.76      rillig   10433:        <code class="filename">mk/bsd.options.mk</code> and
                   10434:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10435:        that the parameters are evaluated at load time, they should be
                   10436:        assigned using the <code class="literal">:=</code> operator, which should
                   10437:        be used only for this purpose.</p>
                   10438: </div>
                   10439: <div class="sect2" lang="en">
                   10440: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10441: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10442: <p>Action files take some input parameters and may define
                   10443:        runtime variables. They shall not define loadtime variables.
                   10444:        There are action files that are included implicitly by the
                   10445:        pkgsrc infrastructure, while other must be included
                   10446:        explicitly.</p>
                   10447: <p>An example for action files is
1.76      rillig   10448:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10449: </div>
                   10450: </div>
1.81      rillig   10451: <div class="sect1" lang="en">
                   10452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10453: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10454: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10455:        a set of variable definitions, and include the file
                   10456:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10457:        Before that, they may also include various other
                   10458:        <code class="filename">*.mk</code> files if they need to query the
                   10459:        availability of certain features like the type of compiler or
                   10460:        the X11 implementation. Due to the heavy use of preprocessor
                   10461:        directives like <code class="literal">.if</code> and
                   10462:        <code class="literal">.for</code>, the order in which the files are loaded
                   10463:        matters.</p>
                   10464: <p>This section describes at which point the various files
                   10465:        are loaded and gives reasons for that order.</p>
                   10466: <div class="sect2" lang="en">
                   10467: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10468: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10469: </h3></div></div></div>
                   10470: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10471:        is to define some essential variables like
                   10472:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10473:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10474: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10475:        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   10476:        After that, those variables
1.81      rillig   10477:        that have not been overridden by the user are loaded from
                   10478:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10479: <p>After the user settings, the system settings and platform
                   10480:        settings are loaded, which may override the user
                   10481:        settings.</p>
                   10482: <p>Then, the tool definitions are loaded. The tool wrappers
                   10483:        are not yet in effect. This only happens when building a
                   10484:        package, so the proper variables must be used instead of the
                   10485:        direct tool names.</p>
                   10486: <p>As the last steps, some essential variables from the
                   10487:        wrapper and the package system flavor are loaded, as well as the
                   10488:        variables that have been cached in earlier phases of a package
                   10489:        build.</p>
                   10490: </div>
                   10491: <div class="sect2" lang="en">
                   10492: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10493: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10494: </h3></div></div></div>
1.81      rillig   10495: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10496: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10497:        loaded, which fill default values for those variables that have
1.93      rillig   10498:        not been defined by the package. These variables may later
1.81      rillig   10499:        be used even in unrelated files.</p>
                   10500: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10501:        provides the target <code class="literal">error-check</code> that is added
                   10502:        as a special dependency to all other targets that use
                   10503:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10504:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10505: <p>Then, the package-specific hacks from
                   10506:        <code class="filename">hacks.mk</code> are included.</p>
                   10507: <p>Then, various other files follow. Most of them don't have
                   10508:        any dependencies on what they need to have included before or
                   10509:        after them, though some do.</p>
                   10510: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10511:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10512:        restricts the use of these variables to all the files that have
                   10513:        been included before. Appearances in later files will be
                   10514:        silently ignored.</p>
                   10515: <p>Then, the files for the main targets are included, in the
                   10516:        order of later execution, though the actual order should not
                   10517:        matter.</p>
                   10518: <p>At last, some more files are included that don't set any
                   10519:        interesting variables but rather just define make targets to be
                   10520:        executed.</p>
                   10521: </div>
                   10522: </div>
1.75      rillig   10523: </div>
                   10524: <div class="chapter" lang="en">
                   10525: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10526: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   10527: <div class="toc">
                   10528: <p><b>Table of Contents</b></p>
                   10529: <dl>
1.106     rillig   10530: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10531: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10532: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.75      rillig   10533: <dd><dl>
1.106     rillig   10534: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10535: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.75      rillig   10536: </dl></dd>
                   10537: </dl>
                   10538: </div>
                   10539: <p>The pkgsrc infrastructure consists of a large codebase,
                   10540:        and there are many corners where every little bit of a file is
                   10541:        well thought out, making pkgsrc likely to fail as soon as
                   10542:        anything is changed near those parts. To prevent most changes
                   10543:        from breaking anything, a suite of regression tests should go
                   10544:        along with every important part of the pkgsrc infrastructure.
                   10545:        This chapter describes how regression tests work in pkgsrc and
                   10546:        how you can add new tests.</p>
                   10547: <div class="sect1" lang="en">
                   10548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10549: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.75      rillig   10550: <p></p>
                   10551: </div>
                   10552: <div class="sect1" lang="en">
                   10553: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10554: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.91      rillig   10555: <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  10556:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10557:        can simply run that command, which will run all tests in the
1.76      rillig   10558:        <code class="filename">regress</code> category.</p>
1.75      rillig   10559: </div>
                   10560: <div class="sect1" lang="en">
                   10561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10562: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.76      rillig   10563: <p>Every directory in the <code class="filename">regress</code>
                   10564:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10565:        is considered a regression test. This file is a shell program
1.110     hubertf  10566:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10567:        The following functions can be overridden to suit your
                   10568:        needs.</p>
                   10569: <div class="sect2" lang="en">
                   10570: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10571: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.75      rillig   10572: <p>These functions do not take any parameters. They are all
                   10573:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10574:        to check the exitcodes of any commands you run in the
                   10575:        test.</p>
                   10576: <div class="variablelist"><dl>
                   10577: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10578: <dd><p>This function prepares the environment for the
                   10579:        test. By default it does nothing.</p></dd>
                   10580: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10581: <dd><p>This function runs the actual test. By default,
                   10582:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10583:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10584:        error messages into the file
                   10585:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10586: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10587: <dd><p>This function is run after the test and is
                   10588:        typically used to compare the actual output from the one that is
                   10589:        expected. It can make use of the various helper functions from
                   10590:        the next section.</p></dd>
                   10591: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10592: <dd><p>This function cleans everything up after the
                   10593:        test has been run. By default it does nothing.</p></dd>
                   10594: </dl></div>
                   10595: </div>
                   10596: <div class="sect2" lang="en">
                   10597: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10598: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.75      rillig   10599: <div class="variablelist"><dl>
                   10600: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10601: <dd><p>This function compares the exitcode of the
1.110     hubertf  10602:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.75      rillig   10603:        If they differ, the test will fail.</p></dd>
                   10604: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10605: <dd><p>This function checks for each of its parameters
1.110     hubertf  10606:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.75      rillig   10607:        extended regular expression. If it does not, the test will
                   10608:        fail.</p></dd>
                   10609: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10610: <dd><p>This function checks for each of its parameters
1.110     hubertf  10611:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10612:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10613:        If any of the regular expressions matches, the test will
                   10614:        fail.</p></dd>
                   10615: </dl></div>
                   10616: </div>
                   10617: </div>
                   10618: </div>
                   10619: <div class="chapter" lang="en">
                   10620: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10621: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10622: <div class="toc">
                   10623: <p><b>Table of Contents</b></p>
                   10624: <dl>
1.106     rillig   10625: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10626: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.75      rillig   10627: </dl>
                   10628: </div>
                   10629: <p>The pkgsrc system has already been ported to many
                   10630:        operating systems, hardware architectures and compilers. This
                   10631:        chapter explains the necessary steps to make pkgsrc even more
                   10632:        portable.</p>
                   10633: <div class="sect1" lang="en">
                   10634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10635: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10636: <p>To port pkgsrc to a new operating system (called
                   10637:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10638:        following files:</p>
                   10639: <div class="variablelist"><dl>
1.93      rillig   10640: <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   10641: <dd><p>This file contains some basic definitions, for
                   10642:        example the name of the C
                   10643:        compiler.</p></dd>
1.76      rillig   10644: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10645: <dd><p>Insert code that defines the variables
                   10646:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10647:        <code class="varname">LOWER_OS_VERSION</code>,
                   10648:        <code class="varname">LOWER_VENDOR</code>,
                   10649:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10650:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10651:        appear in this file.</p></dd>
1.93      rillig   10652: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10653: <dd><p>This file contains the platform-specific
                   10654:        definitions that are used by pkgsrc. Start by copying one of the
                   10655:        other files and edit it to your
                   10656:        needs.</p></dd>
1.93      rillig   10657: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
1.75      rillig   10658: <dd><p>This file contains a list of directories,
                   10659:        together with their permission bits and ownership. These
                   10660:        directories will be created automatically with every package
1.98      wiz      10661:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10662:        be removed.</p></dd>
1.93      rillig   10663: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
1.75      rillig   10664: <dd><p>Just copy one of the pre-existing x11.dist files
                   10665:        to your
1.76      rillig   10666:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10667: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
1.75      rillig   10668: <dd><p>On some operating systems, the tools that are
                   10669:        provided with the base system are not good enough for pkgsrc.
1.110     hubertf  10670:        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   10671:        narrow limit on the line length they can process. Therefore
                   10672:        pkgsrc brings its own tools, which can be enabled
                   10673:        here.</p></dd>
1.93      rillig   10674: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10675: <dd><p>This file defines the paths to all the tools
                   10676:        that are needed by one or the other package in pkgsrc, as well
                   10677:        as by pkgsrc itself. Find out where these tools are on your
                   10678:        platform and add them.</p></dd>
                   10679: </dl></div>
                   10680: <p>Now, you should be able to build some basic packages, like
1.91      rillig   10681:        <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   10682: </div>
                   10683: <div class="sect1" lang="en">
                   10684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10685: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.75      rillig   10686: <p>TODO</p>
                   10687: </div>
                   10688: </div>
                   10689: </div>
                   10690: <div class="appendix" lang="en">
                   10691: <div class="titlepage"><div><div><h2 class="title">
                   10692: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10693: <div class="toc">
                   10694: <p><b>Table of Contents</b></p>
                   10695: <dl>
                   10696: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10697: <dd><dl>
                   10698: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10699: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10700: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.123     snj      10701: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   10702: </dl></dd>
                   10703: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10704: </dl>
                   10705: </div>
                   10706: <p>We checked to find a piece of software that wasn't in the packages
                   10707:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10708:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10709:     present in the tree is beyond us, but it's useful for the purposes of
                   10710:     this exercise.</p>
                   10711: <div class="sect1" lang="en">
                   10712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10713: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10714: <div class="sect2" lang="en">
                   10715: <div class="titlepage"><div><div><h3 class="title">
                   10716: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10717: <pre class="programlisting">
1.100     rillig   10718: # $NetBSD$
                   10719: #
1.1       grant    10720: 
1.100     rillig   10721: DISTNAME=       bison-1.25
                   10722: CATEGORIES=     devel
                   10723: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10724: 
1.100     rillig   10725: MAINTAINER=     thorpej@NetBSD.org
                   10726: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10727: COMMENT=        GNU yacc clone
1.1       grant    10728: 
1.100     rillig   10729: GNU_CONFIGURE=  yes
                   10730: INFO_FILES=     bison.info
1.1       grant    10731: 
1.100     rillig   10732: .include "../../mk/bsd.pkg.mk"
1.1       grant    10733: </pre>
1.75      rillig   10734: </div>
                   10735: <div class="sect2" lang="en">
                   10736: <div class="titlepage"><div><div><h3 class="title">
                   10737: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10738: <pre class="programlisting">
1.100     rillig   10739: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.110     hubertf  10740: 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   10741: of the NetBSD source tree is beyond me.
1.1       grant    10742: </pre>
1.75      rillig   10743: </div>
                   10744: <div class="sect2" lang="en">
                   10745: <div class="titlepage"><div><div><h3 class="title">
                   10746: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10747: <pre class="programlisting">
1.100     rillig   10748: @comment $NetBSD$
                   10749: bin/bison
                   10750: man/man1/bison.1.gz
                   10751: share/bison.simple
                   10752: share/bison.hairy
1.1       grant    10753: </pre>
1.75      rillig   10754: </div>
                   10755: <div class="sect2" lang="en">
                   10756: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  10757: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   10758: </h3></div></div></div>
1.75      rillig   10759: <p>The NetBSD package system comes with
1.91      rillig   10760:         <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   10761:        which helps to check the contents of these
                   10762:        files. After installation it is quite easy to use, just change to the
                   10763:        directory of the package you wish to examine and execute
1.110     hubertf  10764:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10765: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10766: looks fine.</pre>
                   10767: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  10768:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   10769:        -Wall</strong></span> for a very thorough check.</p>
                   10770: </div>
                   10771: </div>
                   10772: <div class="sect1" lang="en">
                   10773: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10774: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10775: <p>Create the directory where the package lives,
                   10776:       plus any auxiliary directories:</p>
                   10777: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10778: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10779: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10780: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10781: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  10782:       <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   10783:       then continue with fetching the distfile:</p>
                   10784: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10785: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10786: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10787: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10788: ftp: Error retrieving file: 500 Internal error
                   10789: 
                   10790: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10791: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10792: ftp: Error retrieving file: 500 Internal error
                   10793: 
                   10794: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10795: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10796: Successfully retrieved file.</pre>
                   10797: <p>Generate the checksum of the distfile into
1.76      rillig   10798:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10800: <p>Now compile:</p>
                   10801: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10802: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10803: ===&gt;  Extracting for bison-1.25
                   10804: ===&gt;  Patching for bison-1.25
                   10805: ===&gt;   Ignoring empty patch directory
                   10806: ===&gt;  Configuring for bison-1.25
                   10807: creating cache ./config.cache
                   10808: checking for gcc... cc
                   10809: checking whether we are using GNU C... yes
                   10810: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10811: checking how to run the C preprocessor... cc -E
                   10812: checking for minix/config.h... no
                   10813: checking for POSIXized ISC... no
                   10814: checking whether cross-compiling... no
                   10815: checking for ANSI C header files... yes
                   10816: checking for string.h... yes
                   10817: checking for stdlib.h... yes
                   10818: checking for memory.h... yes
                   10819: checking for working const... yes
                   10820: checking for working alloca.h... no
                   10821: checking for alloca... yes
                   10822: checking for strerror... yes
                   10823: updating cache ./config.cache
                   10824: creating ./config.status
                   10825: creating Makefile
                   10826: ===&gt;  Building for bison-1.25
                   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 LR0.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 allocate.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 closure.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 conflicts.c
                   10831: 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   10832: 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    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 getargs.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 gram.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 lalr.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 lex.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 main.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 nullable.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 output.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 print.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 reader.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 reduce.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 symtab.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 warshall.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 version.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 getopt.c
                   10847: 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
                   10848: 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
                   10849: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10850: rm -f bison.s1
1.75      rillig   10851: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10852: <p>Everything seems OK, so install the files:</p>
                   10853: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10854: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10855: ===&gt;  Installing for bison-1.25
                   10856: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10857: rm -f /usr/pkg/bin/bison
                   10858: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10859: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10860: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10861: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10862: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10863: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10864: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10865: ===&gt;  Registering installation for bison-1.25</pre>
                   10866: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10867:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10868:       binary package, do this now:</p>
                   10869: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10870: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10871: ===&gt;  Building package for bison-1.25
                   10872: Creating package bison-1.25.tgz
                   10873: Registering depends:.
1.75      rillig   10874: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10875: <p>Now that you don't need the source and object files
                   10876:       any more, clean up:</p>
                   10877: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10878: ===&gt;  Cleaning for bison-1.25</pre>
                   10879: </div>
                   10880: </div>
                   10881: <div class="appendix" lang="en">
                   10882: <div class="titlepage"><div><div><h2 class="title">
                   10883: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10884: <div class="toc">
                   10885: <p><b>Table of Contents</b></p>
                   10886: <dl>
                   10887: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10888: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10889: </dl>
                   10890: </div>
                   10891: <div class="sect1" lang="en">
                   10892: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10893: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10894: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10895: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10896: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10897: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10898: =&gt; [172219 bytes]
                   10899: Connected to ftp.plig.net.
                   10900: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10901: 331 Guest login ok, send your complete e-mail address as password.
                   10902: 230-You are user #5 of 500 simultaneous users allowed.
                   10903: 230-
1.68      rillig   10904: 230-  ___ _             _ _
                   10905: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10906: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10907: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10908: 230-         |_|   |_|     |___|         |___|
                   10909: 230-
                   10910: 230-** Welcome to ftp.plig.org **
                   10911: 230-
                   10912: 230-Please note that all transfers from this FTP site are logged. If you
                   10913: 230-do not like this, please disconnect now.
                   10914: 230-
1.120     snj      10915: 230-This archive is available via
1.1       grant    10916: 230-
                   10917: 230-HTTP:  http://ftp.plig.org/
                   10918: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10919: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10920: 230-
                   10921: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10922: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10923: 230-
                   10924: 230-
                   10925: 230 Logged in anonymously.
                   10926: Remote system type is UNIX.
                   10927: Using binary mode to transfer files.
                   10928: 200 Type okay.
                   10929: 250 "/pub" is new cwd.
                   10930: 250-"/pub/figlet" is new cwd.
                   10931: 250-
                   10932: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10933: 250-
1.75      rillig   10934: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10935: 250-
                   10936: 250-The official FIGlet web page is:
1.75      rillig   10937: 250-   http://www.figlet.org/
1.1       grant    10938: 250-
                   10939: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10940: 250-contribute a font or something else, you can email us.
1.68      rillig   10941: 250
1.1       grant    10942: 250 "/pub/figlet/program" is new cwd.
                   10943: 250 "/pub/figlet/program/unix" is new cwd.
                   10944: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10945: 502 Unimplemented command.
                   10946: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10947: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10948: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10949: 226 Transfer completed.
                   10950: 172219 bytes received in 00:02 (75.99 KB/s)
                   10951: 221 Goodbye.
                   10952: =&gt; Checksum OK for figlet221.tar.gz.
                   10953: ===&gt; Extracting for figlet-2.2.1nb2
                   10954: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10955: ===&gt; Patching for figlet-2.2.1nb2
                   10956: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10957: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10958: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10959: ===&gt; Configuring for figlet-2.2.1nb2
                   10960: ===&gt; Building for figlet-2.2.1nb2
                   10961: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10962: chmod a+x figlet
                   10963: gcc -O2 -o chkfont chkfont.c
                   10964: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10965: <code class="prompt">#</code>
1.75      rillig   10966: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10967: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10968: ===&gt; Installing for figlet-2.2.1nb2
                   10969: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10970: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10971: mkdir -p /usr/pkg/share/figlet
                   10972: cp figlet /usr/pkg/bin
                   10973: cp chkfont /usr/pkg/bin
                   10974: chmod 555 figlist showfigfonts
                   10975: cp figlist /usr/pkg/bin
                   10976: cp showfigfonts /usr/pkg/bin
                   10977: cp fonts/*.flf /usr/pkg/share/figlet
                   10978: cp fonts/*.flc /usr/pkg/share/figlet
                   10979: cp figlet.6 /usr/pkg/man/man6
                   10980: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10981: <code class="prompt">#</code></pre>
                   10982: </div>
                   10983: <div class="sect1" lang="en">
                   10984: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10985: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10986: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10987: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10988: ===&gt; Packaging figlet-2.2.1nb2
                   10989: ===&gt; Building binary package for figlet-2.2.1nb2
                   10990: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10991: Using SrcDir value of /usr/pkg
1.68      rillig   10992: Registering depends:.
1.75      rillig   10993: <code class="prompt">#</code></pre>
                   10994: </div>
                   10995: </div>
                   10996: <div class="appendix" lang="en">
                   10997: <div class="titlepage"><div><div><h2 class="title">
1.76      rillig   10998: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10999: <div class="toc">
                   11000: <p><b>Table of Contents</b></p>
                   11001: <dl>
1.123     snj      11002: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
                   11003: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
                   11004: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
                   11005: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
                   11006: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
                   11007: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
                   11008: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
                   11009: pkgsrc-200xQy:
1.76      rillig   11010: source packages</a></span></dt>
                   11011: </dl>
                   11012: </div>
                   11013: <p>As in other big projects, the directory layout of pkgsrc
                   11014:        is quite complex for newbies. This chapter explains where you
                   11015:        find things on the FTP server. The base directory on
1.110     hubertf  11016:        <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   11017:        On other servers it may be different, but inside this directory,
                   11018:        everything should look the same, no matter on which server you
                   11019:        are. This directory contains some subdirectories, which are
                   11020:        explained below.</p>
1.76      rillig   11021: <div class="sect1" lang="en">
                   11022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11023: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.109     rillig   11024: <p>This directory used to contain binary packages of the
                   11025:        package management tools for various platforms. For those
                   11026:        package collections that need them, they are now stored near the
1.110     hubertf  11027:        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   11028:        directory</a>.</p>
1.76      rillig   11029: </div>
                   11030: <div class="sect1" lang="en">
                   11031: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11032: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   11033: <p>The directory <code class="filename">distfiles</code> contains lots
                   11034:        of archive files from all pkgsrc packages, which are mirrored
                   11035:        here. The subdirectories are called after their package names
                   11036:        and are used when the distributed files have names that don't
                   11037:        explicitly contain a version number or are otherwise too generic
                   11038:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11039: </div>
                   11040: <div class="sect1" lang="en">
                   11041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11042: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   11043: <p>This directory is currently not in use.</p>
                   11044: </div>
                   11045: <div class="sect1" lang="en">
                   11046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11047: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   11048: <p>This directory contains things that individual pkgsrc
                   11049:        developers find worth publishing.</p>
                   11050: </div>
                   11051: <div class="sect1" lang="en">
                   11052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.102     rillig   11053: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   11054: <p>This directory contains binary packages for the various
                   11055:        platforms that are supported by pkgsrc.
                   11056:        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>
                   11057: <div class="itemizedlist"><ul type="disc">
1.108     rillig   11058: <li><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   11059:        operating system for which the packages have been built. The
1.110     hubertf  11060:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   11061:        command, so it may differ from the one you are used to
                   11062:        hear.</p></li>
1.108     rillig   11063: <li><p><code class="varname">ARCH</code> is the hardware
                   11064:        architecture of the platform for which the packages have been
1.110     hubertf  11065:        built. It also includes the <code class="varname">ABI</code> (Application
                   11066:        Binary Interface) for platforms that have several of
                   11067:        them.</p></li>
1.108     rillig   11068: <li><p><code class="varname">OSVERSION</code> is the version of
                   11069:        the operating system. For version numbers that change often (for
                   11070:        example NetBSD-current), the often-changing part should be
                   11071:        replaced with an <code class="literal">x</code>, for example
                   11072:        <code class="literal">4.99.x</code>.</p></li>
                   11073: <li><p><code class="varname">TAG</code> is either
                   11074:        <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11075:        for a stable branch, or <code class="literal">head</code> for packages
                   11076:        built from the HEAD branch. The latter should only be used when
                   11077:        the packages are updated on a regular basis. Otherwise the date
                   11078:        from checking out pkgsrc should be appended, for example
                   11079:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   11080: </ul></div>
                   11081: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11082:        can quickly click through the directories on the
                   11083:        server and find the best binary packages for their machines. Since they
                   11084:        usually know the operating system and the hardware architecture, OPSYS
                   11085:        and ARCH are placed first. After these choices, they can select the
                   11086:        best combination of OSVERSION and TAG together, since it is usually the
                   11087:        case that packages stay compatible between different version of the
                   11088:        operating system.</p>
                   11089: <p>In each of these directories, there is a
                   11090:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   11091:        <code class="filename">All</code> which contains all binary packages.
                   11092:        Besides that, there are various category directories that
                   11093:        contain symbolic links to the real binary packages.</p>
                   11094: </div>
                   11095: <div class="sect1" lang="en">
                   11096: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   11097: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
                   11098: <p>Here are the reports from bulk builds, for those who want
                   11099:        to fix packages that didn't build on some of the platforms. The
1.123     snj      11100:        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   11101: </div>
                   11102: <div class="sect1" lang="en">
                   11103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11104: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.93      rillig   11105: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11106: source packages</h2></div></div></div>
                   11107: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   11108:        that is the files that define how to create binary packages from
                   11109:        source archives.</p>
                   11110: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11111:        snapshot of the CVS repository, which is updated regularly. The
                   11112:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11113:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   11114: <p>In the directories for the quarterly branches, there is an
                   11115:        additional file called
                   11116:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   11117:        which contains the state of pkgsrc when it was branched.</p>
                   11118: </div>
1.75      rillig   11119: </div>
                   11120: <div class="appendix" lang="en">
                   11121: <div class="titlepage"><div><div><h2 class="title">
                   11122: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   11123: <div class="toc">
                   11124: <p><b>Table of Contents</b></p>
                   11125: <dl>
1.79      rillig   11126: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   11127: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11128: </dl>
                   11129: </div>
1.79      rillig   11130: <p>This section contains information on editing the pkgsrc
                   11131:        guide itself.</p>
1.75      rillig   11132: <div class="sect1" lang="en">
                   11133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   11134: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11135: <p>The pkgsrc guide's source code is stored in
                   11136:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11137:        are created from it:</p>
                   11138: <div class="itemizedlist"><ul type="disc">
                   11139: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11140: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.110     hubertf  11141: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   11142: <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   11143:        The PDF version of the pkgsrc guide.</p></li>
1.110     hubertf  11144: <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   11145:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   11146: </ul></div>
                   11147: </div>
                   11148: <div class="sect1" lang="en">
                   11149: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11150: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   11151: <p>The procedure to edit the pkgsrc guide is:</p>
                   11152: <div class="procedure"><ol type="1">
                   11153: <li><p>Make sure you have the packages needed to
1.83      wiz      11154:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.91      rillig   11155:        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
                   11156:        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   11157:        PostScript and PDF versions. You will need both packages
                   11158:        installed, to make sure documentation is consistent across all
                   11159:        formats.</p></li>
1.110     hubertf  11160: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   11161:        right directory. All further steps will take place
                   11162:        here.</p></li>
                   11163: <li><p>Edit the XML file(s) in
                   11164:        <code class="filename">files/</code>.</p></li>
1.110     hubertf  11165: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   11166:        guide for valid XML and to build the final output files. If you
                   11167:        get any errors at this stage, you can just edit the files, as
                   11168:        there are only symbolic links in the working directory, pointing
                   11169:        to the files in <code class="filename">files/</code>.</p></li>
1.110     hubertf  11170: <li><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   11171:        commit)</strong></span></p></li>
1.110     hubertf  11172: <li><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   11173:        regenerate the output files with the proper RCS
                   11174:        Ids.</p></li>
1.91      rillig   11175: <li>
1.110     hubertf  11176: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   11177:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11178:        <code class="filename">htdocs</code>.</p>
                   11179: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11180: <h3 class="title">Note</h3>
                   11181: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  11182:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11183:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   11184:        directory.</p>
                   11185: </div>
                   11186: </li>
1.79      rillig   11187: </ol></div>
1.75      rillig   11188: </div>
                   11189: </div>
                   11190: </div></body>
1.1       grant    11191: </html>

CVSweb <webmaster@jp.NetBSD.org>