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

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.2       rillig      6: <link rel="stylesheet" href="/global.css" type="text/css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
                      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
                      9: </head>
                     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.10      hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.10      hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.4       rillig     33: <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
1.6       rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
1.1       dsieger    35: <div><div class="abstract">
                     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
                     48: <dl>
                     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
                     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                     58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
                     67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                     68: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
                     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>
                     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>
                     90: </dl></dd>
                     91: </dl></dd>
                     92: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     93: <dd><dl>
                     94: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     97: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                     98: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    100: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    102: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    103: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    104: </dl></dd>
                    105: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    106: <dd><dl>
                    107: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    108: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    109: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    110: </dl></dd>
                    111: </dl></dd>
                    112: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    113: <dd><dl>
                    114: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    115: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    116: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    117: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   118: <dd><dl>
1.4       rillig    119: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.15      rillig    120: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
                    121: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.1       dsieger   122: </dl></dd>
1.4       rillig    123: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    124: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   125: </dl></dd>
                    126: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    127: <dd><dl>
                    128: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    129: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    130: </dl></dd>
                    131: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    132: builds)</a></span></dt>
1.1       dsieger   133: <dd><dl>
1.6       rillig    134: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    135: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    136: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    137: <dd><dl>
                    138: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    139: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    140: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    141: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    142: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    143: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    144: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    145: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    146: </dl></dd>
                    147: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig    148: <dd><dl>
                    149: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    150: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    151: </dl></dd>
1.6       rillig    152: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    153: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    154: </dl></dd>
                    155: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    156: <dd><dl>
1.15      rillig    157: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
                    158: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.6       rillig    159: </dl></dd>
                    160: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    161: <dd><dl>
                    162: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    165: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    166: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.15      rillig    169: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.6       rillig    170: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.15      rillig    171: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
                    172: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
                    173: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.6       rillig    174: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    175: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    176: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.15      rillig    177: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.6       rillig    178: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.15      rillig    179: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.1       dsieger   180: </dl></dd>
                    181: </dl></dd>
                    182: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    183: <dd><dl>
1.6       rillig    184: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger   185: <dd><dl>
1.6       rillig    186: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger   187: <dd><dl>
1.6       rillig    188: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                    189: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17    ! imil      190: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger   191: </dl></dd>
1.6       rillig    192: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    193: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    194: </dl></dd>
                    195: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    196: <dd><dl>
1.15      rillig    197: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
                    198: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.6       rillig    199: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                    200: <dd><dl>
                    201: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    202: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    203: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    204: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    205: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    206: </dl></dd>
                    207: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    208: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    209: <dd><dl>
                    210: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    211: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    212: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    213: </dl></dd>
1.15      rillig    214: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
                    215: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.6       rillig    216: </dl></dd>
1.15      rillig    217: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.6       rillig    218: <dd><dl>
                    219: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.15      rillig    220: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.6       rillig    221: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    222: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    223: <dd><dl>
                    224: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                    225: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                    226: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                    227: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                    228: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                    229: </dl></dd>
                    230: </dl></dd>
                    231: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    232: <dd><dl>
                    233: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.15      rillig    234: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
                    235: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.6       rillig    236: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    237: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.15      rillig    238: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.6       rillig    239: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                    240: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                    241: </dl></dd>
                    242: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    243: <dd><dl>
                    244: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.15      rillig    245: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.6       rillig    246: <dd><dl>
                    247: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.15      rillig    248: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.6       rillig    249: </dl></dd>
1.15      rillig    250: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.6       rillig    251: <dd><dl>
1.15      rillig    252: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.6       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.15      rillig    265: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.6       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.15      rillig    281: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.6       rillig    282: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig    283: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       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.15      rillig    291: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.6       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.15      rillig    296: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
                    297: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
                    298: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
                    299: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
                    300: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
                    301: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
                    302: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
                    303: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
                    304: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
                    305: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.6       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.15      rillig    321: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.6       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.15      rillig    333: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.6       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.15      rillig    338: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.6       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.15      rillig    351: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.6       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.15      rillig    355: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.6       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.15      rillig    358: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.6       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.7       rillig    368: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6       rillig    369: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                    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.1       dsieger   378:     emulation</a></span></dt>
1.6       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.1       dsieger   381: </dl></dd>
1.6       rillig    382: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   383: </dl></dd>
1.6       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.1       dsieger   386: <dd><dl>
1.6       rillig    387: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    388: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    389: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                    390: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                    391: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                    392: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
                    393: </dl></dd>
                    394: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    395: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    396: <dd><dl>
                    397: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    398: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    399: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    400: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger   401: </dl></dd>
                    402: </dl></dd>
                    403: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    404: <dd><dl>
1.6       rillig    405: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   406: <dd><dl>
1.6       rillig    407: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    408: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    409: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger   410: <dd><dl>
1.6       rillig    411: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    412: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger   413: </dl></dd>
1.6       rillig    414: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    415: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   416: <dd><dl>
1.6       rillig    417: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    418: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger   419: </dl></dd>
1.6       rillig    420: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   421: <dd><dl>
1.15      rillig    422: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
                    423: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.1       dsieger   424: </dl></dd>
                    425: </dl></dd>
1.6       rillig    426: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger   427: <dd><dl>
1.6       rillig    428: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                    429: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                    430: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger   431: <dd><dl>
1.6       rillig    432: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                    433: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger   434: </dl></dd>
                    435: </dl></dd>
1.6       rillig    436: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger   437: <dd><dl>
1.6       rillig    438: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                    439: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger   440: </dl></dd>
                    441: </dl></dd>
                    442: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    443: <dd><dl>
                    444: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    445: <dd><dl>
                    446: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    447: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    448: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.15      rillig    449: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1       dsieger   450: </dl></dd>
                    451: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    452: </dl></dd>
                    453: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    454: <dd><dl>
                    455: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    456: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    457: </dl></dd>
                    458: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    459: <dd><dl>
1.15      rillig    460: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
                    461: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
                    462: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
                    463: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
                    464: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
                    465: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
                    466: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
                    467: pkgsrc-200xQy:
1.1       dsieger   468: source packages</a></span></dt>
                    469: </dl></dd>
                    470: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    471: <dd><dl>
                    472: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                    473: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    474: </dl></dd>
                    475: </dl>
                    476: </div>
                    477: <div class="list-of-tables">
                    478: <p><b>List of Tables</b></p>
                    479: <dl>
                    480: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    481: </dt>
1.6       rillig    482: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   483: </dt>
1.6       rillig    484: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   485: </dt>
                    486: </dl>
                    487: </div>
                    488: <div class="chapter" lang="en">
                    489: <div class="titlepage"><div><div><h2 class="title">
                    490: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
                    491: <div class="toc">
                    492: <p><b>Table of Contents</b></p>
                    493: <dl>
                    494: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    495: <dd><dl>
                    496: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    497: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    498: </dl></dd>
                    499: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    500: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    501: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    502: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    503: </dl>
                    504: </div>
                    505: <div class="sect1" lang="en">
                    506: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    507: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    508: <p>There is a lot of software freely available for Unix-based
                    509: systems, which is usually available in form of the source code. Before
                    510: such software can be used, it needs to be configured to the local
                    511: system, compiled and installed, and this is exactly what The NetBSD
                    512: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    513: to handle binary packages, so that not every user has to build the
                    514: packages for himself, which is a time-costly task.</p>
                    515: <p>pkgsrc currently contains several thousand packages,
                    516:       including:</p>
                    517: <div class="itemizedlist"><ul type="disc">
                    518: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
                    519:          web server</p></li>
                    520: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
                    521:          web browser</p></li>
                    522: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
                    523:          Desktop Environment</p></li>
                    524: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
                    525:          Desktop Environment</p></li>
                    526: </ul></div>
                    527: <p>...just to name a few.</p>
                    528: <p>pkgsrc has built-in support for handling varying dependencies,
                    529:       such as pthreads and X11, and extended features such as IPv6 support on
                    530:       a range of platforms.</p>
                    531: <div class="sect2" lang="en">
                    532: <div class="titlepage"><div><div><h3 class="title">
                    533: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    534: <p>
                    535: pkgsrc provides the following key features:
                    536: </p>
                    537: <div class="itemizedlist"><ul type="disc">
                    538: <li><p>Easy building of software from source as well as the creation
                    539:   and installation of binary packages. The source and latest
                    540:   patches are retrieved from a master or mirror download site, checksum
                    541:   verified, then built on your system. Support for binary-only
                    542:   distributions is available for both native platforms and NetBSD
                    543:   emulated platforms.</p></li>
                    544: <li><p>All packages are installed in a consistent directory tree,
                    545:   including binaries, libraries, man pages and other
                    546:   documentation.</p></li>
                    547: <li><p>Package dependencies, including when performing package updates,
                    548:   are handled automatically. The configuration files of various
                    549:   packages are handled automatically during updates, so local changes
                    550:   are preserved.</p></li>
                    551: <li><p>Like NetBSD, pkgsrc is designed with portability in mind and
                    552:   consists of highly portable code. This allows the greatest speed of
                    553:   development when porting to new a platform. This portability also
                    554:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    555:   platforms</em></span>.</p></li>
                    556: <li><p>The installation prefix, acceptable software licenses,
                    557:   international encryption requirements and build-time options for a
                    558:   large number of packages are all set in a simple, central
                    559:   configuration file.</p></li>
                    560: <li><p>The entire source (not including the distribution files) is
                    561:   freely available under a BSD license, so you may extend and adapt
                    562:   pkgsrc to your needs. Support for local packages and patches is
                    563:   available right out of the box, so you can configure it specifically
                    564:   for your environment.</p></li>
                    565: </ul></div>
                    566: <p>The following principles are basic to pkgsrc:</p>
                    567: <div class="itemizedlist"><ul type="disc">
                    568: <li><p>&#8220;<span class="quote">It should only work if it's right.</span>&#8221;
1.14      jmcneill  569: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   570: them and to complain about them rather than to just install the package
                    571: and hope that it works. There are numerous checks in pkgsrc that try to
                    572: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
                    573: of shell scripts), and post-installation checks (installed files,
                    574: references to shared libraries, script interpreters).</p></li>
                    575: <li><p>&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;
1.14      jmcneill  576: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   577: pkgsrc has been ported to many operating systems. Care is taken that
                    578: packages behave the same on all platforms.</p></li>
                    579: </ul></div>
                    580: </div>
                    581: <div class="sect2" lang="en">
                    582: <div class="titlepage"><div><div><h3 class="title">
                    583: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    584: <p>pkgsrc consists of both a source distribution and a binary
                    585: distribution for these operating systems. After retrieving the required
                    586: source or binaries, you can be up and running with pkgsrc in just
                    587: minutes!</p>
                    588: <p>pkgsrc was derived from FreeBSD's ports system, and
                    589:       initially developed for NetBSD only. Since then, pkgsrc has
                    590:       grown a lot, and now supports the following platforms:</p>
                    591: <div class="table">
                    592: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
                    593: <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
                    594: <colgroup>
                    595: <col>
                    596: <col>
                    597: </colgroup>
                    598: <thead><tr>
                    599: <th>Platform</th>
                    600: <th>Date Support Added</th>
                    601: </tr></thead>
                    602: <tbody>
                    603: <tr>
1.10      hubertf   604: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1       dsieger   605: <td align="center">Aug 1997</td>
                    606: </tr>
                    607: <tr>
1.10      hubertf   608: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1       dsieger   609: <td align="center">Mar 1999</td>
                    610: </tr>
                    611: <tr>
1.10      hubertf   612: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1       dsieger   613: <td align="center">Jun 1999</td>
                    614: </tr>
                    615: <tr>
                    616: <td>
1.10      hubertf   617:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    618:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.1       dsieger   619:         </td>
                    620: <td align="center">Oct 2001</td>
                    621: </tr>
                    622: <tr>
1.10      hubertf   623: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1       dsieger   624: <td align="center">Nov 2002</td>
                    625: </tr>
                    626: <tr>
1.10      hubertf   627: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1       dsieger   628: <td align="center">Nov 2002</td>
                    629: </tr>
                    630: <tr>
1.10      hubertf   631: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1       dsieger   632: <td align="center">Dec 2002</td>
                    633: </tr>
                    634: <tr>
                    635: <td>BSD/OS</td>
                    636: <td align="center">Dec 2003</td>
                    637: </tr>
                    638: <tr>
1.10      hubertf   639: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1       dsieger   640: <td align="center">Dec 2003</td>
                    641: </tr>
                    642: <tr>
                    643: <td>
1.10      hubertf   644:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1       dsieger   645:           (Microsoft Windows Services for Unix)
                    646:         </td>
                    647: <td align="center">Mar 2004</td>
                    648: </tr>
                    649: <tr>
1.10      hubertf   650: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1       dsieger   651: <td align="center">Oct 2004</td>
                    652: </tr>
                    653: <tr>
1.10      hubertf   654: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1       dsieger   655: <td align="center">Nov 2004</td>
                    656: </tr>
                    657: <tr>
1.10      hubertf   658: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1       dsieger   659: <td align="center">Apr 2007</td>
                    660: </tr>
                    661: </tbody>
                    662: </table></div>
                    663: </div>
                    664: <br class="table-break">
                    665: </div>
                    666: </div>
                    667: <div class="sect1" lang="en">
                    668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    669: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    670: <p>This document is divided into three parts. The first,
1.10      hubertf   671:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1       dsieger   672:        describes how one can use one of the packages in the Package
                    673:        Collection, either by installing a precompiled binary package,
                    674:        or by building one's own copy using the NetBSD package system.
1.10      hubertf   675:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1       dsieger   676:        package so it can be easily built by other NetBSD users without
                    677:        knowing about the package's building details. The third part,
1.10      hubertf   678:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1       dsieger   679:        is intended for those who want to understand how pkgsrc is
                    680:        implemented.</p>
                    681: <p>This document is available in various formats:
1.10      hubertf   682:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1       dsieger   683: </div>
                    684: <div class="sect1" lang="en">
                    685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    686: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
                    687: <p>There has been a lot of talk about &#8220;<span class="quote">ports</span>&#8221;,
                    688:       &#8220;<span class="quote">packages</span>&#8221;, etc. so far. Here is a description of all the
                    689:       terminology used within this document.</p>
                    690: <div class="variablelist"><dl>
                    691: <dt><span class="term">Package</span></dt>
                    692: <dd><p>A set of files and building instructions
                    693:            that describe what's necessary
                    694:            to build a certain piece of software using
                    695:             pkgsrc. Packages are traditionally stored under
                    696:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
                    697: <dt><span class="term">The NetBSD package system</span></dt>
                    698: <dd><p>This is the former name of &#8220;<span class="quote">pkgsrc</span>&#8221;.  It
                    699:          is part of the NetBSD operating system and can be bootstrapped
                    700:          to run on non-NetBSD operating systems as well.  It handles
                    701:          building (compiling), installing, and removing of
                    702:          packages.</p></dd>
                    703: <dt><span class="term">Distfile</span></dt>
                    704: <dd><p>This term describes the file or files that are
                    705:            provided by the author of the piece of software to
                    706:            distribute his work. All the changes necessary to build on
                    707:            NetBSD are reflected in the corresponding package. Usually
                    708:            the distfile is in the form of a compressed tar-archive,
                    709:            but other types are possible, too. Distfiles are usually
                    710:            stored below
                    711:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    712: <dt><span class="term">Port</span></dt>
                    713: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    714:            for what we call a package.
                    715:            In NetBSD terminology, &#8220;<span class="quote">port</span>&#8221; refers to a different
                    716:            architecture.</p></dd>
                    717: <dt><span class="term">Precompiled/binary package</span></dt>
                    718: <dd>
                    719: <p>A set of binaries built with pkgsrc from a distfile
                    720:            and stuffed together in a single <code class="filename">.tgz</code>
                    721:            file so it can be installed on machines of the same
                    722:            machine architecture without the need to
                    723:            recompile. Packages are usually generated in
                    724:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.10      hubertf   725:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.1       dsieger   726: <p>Sometimes, this is referred to by the term &#8220;<span class="quote">package</span>&#8221; too,
                    727:            especially in the context of precompiled packages.</p>
                    728: </dd>
                    729: <dt><span class="term">Program</span></dt>
                    730: <dd><p>The piece of software to be installed which will be
                    731:          constructed from all the files in the distfile by the
                    732:          actions defined in the corresponding package.</p></dd>
                    733: </dl></div>
                    734: <div class="sect2" lang="en">
                    735: <div class="titlepage"><div><div><h3 class="title">
                    736: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
                    737: <div class="variablelist"><dl>
                    738: <dt><span class="term">pkgsrc users</span></dt>
                    739: <dd>
                    740: <p>The
                    741:        pkgsrc users are people who use the packages provided by pkgsrc.
                    742:        Typically they are system administrators. The people using the
                    743:        software that is inside the packages (maybe called &#8220;<span class="quote">end
                    744:        users</span>&#8221;) are not covered by the pkgsrc guide.</p>
                    745: <p>There are two kinds of pkgsrc users: Some only want to
                    746:        install pre-built binary packages. Others build the pkgsrc
                    747:        packages from source, either for installing them directly or for
1.10      hubertf   748:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.1       dsieger   749:        documentation.</p>
                    750: </dd>
                    751: <dt><span class="term">package maintainers</span></dt>
                    752: <dd><p>A
1.10      hubertf   753:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.1       dsieger   754: <dt><span class="term">infrastructure developers</span></dt>
                    755: <dd><p>These people are involved in all those files
                    756:        that live in the <code class="filename">mk/</code> directory and below.
1.10      hubertf   757:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.1       dsieger   758:        too.</p></dd>
                    759: </dl></div>
                    760: </div>
                    761: </div>
                    762: <div class="sect1" lang="en">
                    763: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    764: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    765: <p>When giving examples for commands, shell prompts are used to
                    766:       show if the command should/can be issued as root, or if
                    767:       &#8220;<span class="quote">normal</span>&#8221; user privileges are sufficient. We use a
                    768:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    769:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    770: </div>
                    771: </div>
                    772: <div class="part" lang="en">
                    773: <div class="titlepage"><div><div><h1 class="title">
                    774: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    775: <div class="toc">
                    776: <p><b>Table of Contents</b></p>
                    777: <dl>
                    778: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    779: <dd><dl>
                    780: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    781: <dd><dl>
                    782: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    783: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
                    784: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
                    785: </dl></dd>
                    786: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    787: <dd><dl>
                    788: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    789: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    790: </dl></dd>
                    791: </dl></dd>
                    792: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    793: <dd><dl>
                    794: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    795: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    796: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    797: <dd><dl>
                    798: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                    799: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                    800: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                    801: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                    802: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                    803: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                    804: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                    805: </dl></dd>
                    806: </dl></dd>
                    807: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    808: <dd><dl>
                    809: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    810: <dd><dl>
                    811: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    812: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                    813: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    814: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    815: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    816: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    817: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    818: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                    819: </dl></dd>
                    820: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    821: <dd><dl>
                    822: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    823: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    824: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    825: </dl></dd>
                    826: </dl></dd>
                    827: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    828: <dd><dl>
                    829: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    830: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    831: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    832: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   833: <dd><dl>
1.4       rillig    834: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.15      rillig    835: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
                    836: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.1       dsieger   837: </dl></dd>
1.4       rillig    838: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    839: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   840: </dl></dd>
                    841: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    842: <dd><dl>
                    843: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    844: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    845: </dl></dd>
                    846: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    847: builds)</a></span></dt>
1.1       dsieger   848: <dd><dl>
1.6       rillig    849: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                    850: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                    851: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                    852: <dd><dl>
                    853: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                    854: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                    855: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                    856: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                    857: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                    858: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                    859: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                    860: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                    861: </dl></dd>
                    862: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig    863: <dd><dl>
                    864: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                    865: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                    866: </dl></dd>
1.6       rillig    867: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    868: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                    869: </dl></dd>
                    870: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    871: <dd><dl>
1.15      rillig    872: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
                    873: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.6       rillig    874: </dl></dd>
                    875: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    876: <dd><dl>
                    877: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    878: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                    879: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                    880: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                    881: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                    882: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    883: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.15      rillig    884: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.6       rillig    885: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.15      rillig    886: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
                    887: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
                    888: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.6       rillig    889: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    890: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    891: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.15      rillig    892: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.6       rillig    893: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.15      rillig    894: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.1       dsieger   895: </dl></dd>
                    896: </dl>
                    897: </div>
                    898: <div class="chapter" lang="en">
                    899: <div class="titlepage"><div><div><h2 class="title">
                    900: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    901: <div class="toc">
                    902: <p><b>Table of Contents</b></p>
                    903: <dl>
                    904: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    905: <dd><dl>
                    906: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
                    907: <dt><span class="sect2"><a href="#getting-via-sup">2.1.2. Via SUP</a></span></dt>
                    908: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.3. Via anonymous CVS</a></span></dt>
                    909: </dl></dd>
                    910: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    911: <dd><dl>
                    912: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    913: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    914: </dl></dd>
                    915: </dl>
                    916: </div>
                    917: <p>Before you download and extract the files, you need to decide
                    918: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    919: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    920: free to install the sources and binary packages wherever you want in
                    921: your filesystem, provided that the pathname does not contain white-space
                    922: or other characters that are interpreted specially by the shell and some
                    923: other programs. A safe bet is to use only letters, digits, underscores
                    924: and dashes.</p>
                    925: <div class="sect1" lang="en">
                    926: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    927: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    928: <p>Before you download any pkgsrc files, you should decide
                    929:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    930:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    931:        quarterly basis from the current branch and only gets modified
                    932:        for security updates. The names of the stable branches are built
                    933:        from the year and the quarter, for example
1.12      weinem    934:        <code class="literal">2007Q4</code>.</p>
1.1       dsieger   935: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
                    936:        want to download pkgsrc. You can get it as a tar file, via SUP,
                    937:        or via CVS. All three ways are described here.</p>
                    938: <div class="sect2" lang="en">
                    939: <div class="titlepage"><div><div><h3 class="title">
                    940: <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
                    941: <p>The primary download location for all pkgsrc files is
1.10      hubertf   942:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
1.1       dsieger   943:        number of subdirectories for different purposes, which are
1.10      hubertf   944:        described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
1.1       dsieger   945: <p>The tar file for the current branch is in the directory
1.10      hubertf   946:        <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.1       dsieger   947:        It is autogenerated daily.</p>
1.12      weinem    948: <p>The tar file for the stable branch 2007Q4 is in the
                    949:        directory <code class="filename">pkgsrc-2007Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2007Q4/pkgsrc-2007Q4.tar.gz" target="_top"><code class="filename">pkgsrc-2007Q4.tar.gz</code></a>.</p>
                    950: <p>To download a pkgsrc stable tarball, run:</p>
                    951: <pre class="screen">
                    952: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-200xQy</code></em>/<em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz</code></strong></pre>
                    953: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the
                    954:        stable branch to be downloaded, for example, 
                    955:        &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;.</p>
                    956: <p>Then, extract it with:</p>
                    957: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-200xQy</code></em>.tar.gz -C /usr</code></strong></pre>
                    958: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    959:        in <code class="filename">/usr/</code> and all the package source will be 
                    960:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    961: <p>To download pkgsrc-current, run:</p>
                    962: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1       dsieger   963: </div>
                    964: <div class="sect2" lang="en">
                    965: <div class="titlepage"><div><div><h3 class="title">
                    966: <a name="getting-via-sup"></a>2.1.2. Via SUP</h3></div></div></div>
                    967: <p>As an alternative to the tar file, you can get pkgsrc via
                    968:        the Software Update Protocol, SUP. To do so, make sure your
                    969:        supfile has a line
                    970: 
                    971: </p>
                    972: <pre class="programlisting">
                    973: release=pkgsrc
                    974: </pre>
                    975: <p>
                    976: 
                    977:        in it, see the examples in
                    978:        <code class="filename">/usr/share/examples/supfiles</code>, and that the
                    979:        <code class="filename">/usr/pkgsrc</code> directory exists. Then, simply
1.13      weinem    980:        run:</p>
                    981: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>sup -v <em class="replaceable"><code>/path/to/your/supfile</code></em></code></strong>.</pre>
1.1       dsieger   982: </div>
                    983: <div class="sect2" lang="en">
                    984: <div class="titlepage"><div><div><h3 class="title">
                    985: <a name="getting-via-cvs"></a>2.1.3. Via anonymous CVS</h3></div></div></div>
1.12      weinem    986: <p>To do an initial (full) checkout of pkgsrc, you first
1.1       dsieger   987:        have to set some environment variables. For the C-Shell,
                    988:        type:</p>
1.13      weinem    989: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>setenv CVSROOT anoncvs@anoncvs.NetBSD.org:/cvsroot</code></strong>
                    990: <code class="prompt">%</code> <strong class="userinput"><code>setenv CVS_RSH ssh</code></strong>
1.1       dsieger   991: </pre>
                    992: <p>Or, the same for the bourne shell:</p>
1.13      weinem    993: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>export CVSROOT="anoncvs@anoncvs.NetBSD.org:/cvsroot"</code></strong>
                    994: <code class="prompt">$</code> <strong class="userinput"><code>export CVS_RSH="ssh"</code></strong>
1.1       dsieger   995: </pre>
1.13      weinem    996: <p>By default, CVS doesn't do things like most people would
1.12      weinem    997:        expect it to do. But there is a
1.13      weinem    998:        way to convince CVS, by creating a file called
1.2       rillig    999:        <code class="filename">.cvsrc</code> in your home directory and saving
                   1000:        the following lines to it. This file will save you lots of
                   1001:        headache and some bug reports, so we strongly recommend it. You
                   1002:        can find an explanation of this file in the CVS
                   1003:        documentation.</p>
                   1004: <pre class="programlisting">
                   1005: # recommended CVS configuration file from the pkgsrc guide
                   1006: checkout -P
1.4       rillig   1007: update -dP
1.2       rillig   1008: release -d
1.4       rillig   1009: diff -upN
1.2       rillig   1010: cvs -q -z3
                   1011: rdiff -u
                   1012: </pre>
1.12      weinem   1013: <p>To fetch a specific pkgsrc stable branch from scratch, run:</p>
                   1014: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.13      weinem   1015: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -r <em class="replaceable"><code>pkgsrc-200xQy</code></em> -P pkgsrc</code></strong></pre>
1.12      weinem   1016: <p>Where <em class="replaceable"><code>pkgsrc-200xQy</code></em> is the stable 
                   1017:        branch to be checked out, for example, &#8220;<span class="quote">pkgsrc-2007Q4</span>&#8221;</p>
                   1018: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1019:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1020:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1021: <p>To fetch the pkgsrc current branch, run:</p>
                   1022: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr</code></strong>
1.13      weinem   1023: <code class="prompt">$</code> <strong class="userinput"><code>cvs checkout -P pkgsrc</code></strong></pre>
1.1       dsieger  1024: </div>
                   1025: </div>
                   1026: <div class="sect1" lang="en">
                   1027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1028: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1029: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1030:        (which also works if you have first installed it via a tar
                   1031:        file). It saves bandwidth and hard disk activity, compared to
                   1032:        downloading the tar file again.</p>
                   1033: <div class="sect2" lang="en">
                   1034: <div class="titlepage"><div><div><h3 class="title">
                   1035: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
                   1036: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1037: <h3 class="title">Warning</h3>
                   1038: <p>When updating from a tar file, you first need to
                   1039:        completely remove the old pkgsrc directory. Otherwise those
                   1040:        files that have been removed from pkgsrc in the mean time will
                   1041:        not be removed on your local disk, resulting in inconsistencies.
                   1042:        When removing the old files, any changes that you have done to
                   1043:        the pkgsrc files will be lost after updating. Therefore updating
                   1044:        via CVS is strongly recommended.</p>
                   1045: </div>
                   1046: <p>Note that by default the distfiles and the binary packages
                   1047:        are saved in the pkgsrc tree, so don't forget to rescue them
                   1048:        before updating. You can also configure pkgsrc to use other than
                   1049:        the default directories by setting the
                   1050:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10      hubertf  1051:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1       dsieger  1052: <p>To update pkgsrc from a tar file, download the tar file as
                   1053:        explained above. Then, make sure that you have not made any
                   1054:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1055:        directory and extract the new tar file. Done.</p>
                   1056: </div>
                   1057: <div class="sect2" lang="en">
                   1058: <div class="titlepage"><div><div><h3 class="title">
                   1059: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
                   1060: <p>To update pkgsrc via CVS, make sure the environment
                   1061:        variable <code class="varname">CVS_RSH</code> is set as above. Then,
1.13      weinem   1062:        change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1063: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   1064: <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1.1       dsieger  1065: <div class="sect3" lang="en">
                   1066: <div class="titlepage"><div><div><h4 class="title">
                   1067: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1068: <p>When updating pkgsrc, the CVS program keeps track of the
                   1069:        branch you selected. But if you, for whatever reason, want to
                   1070:        switch from the stable branch to the current one, you can do it
                   1071:        by adding the option &#8220;<span class="quote">-A</span>&#8221; after the
                   1072:        &#8220;<span class="quote">update</span>&#8221; keyword. To switch from the current branch
                   1073:        back to the stable branch, add the
1.13      weinem   1074:        &#8220;<span class="quote">-rpkgsrc-2007Q4</span>&#8221; option.</p>
1.1       dsieger  1075: </div>
                   1076: <div class="sect3" lang="en">
                   1077: <div class="titlepage"><div><div><h4 class="title">
                   1078: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1079: <p>When you update pkgsrc, the CVS program will only touch
                   1080:        those files that are registered in the CVS repository. That
                   1081:        means that any packages that you created on your own will stay
                   1082:        unmodified. If you change files that are managed by CVS, later
                   1083:        updates will try to merge your changes with those that have been
                   1084:        done by others. See the CVS manual, chapter
                   1085:        &#8220;<span class="quote">update</span>&#8221; for details.</p>
                   1086: </div>
                   1087: </div>
                   1088: </div>
                   1089: </div>
                   1090: <div class="chapter" lang="en">
                   1091: <div class="titlepage"><div><div><h2 class="title">
                   1092: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1093: <div class="toc">
                   1094: <p><b>Table of Contents</b></p>
                   1095: <dl>
                   1096: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1097: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1098: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1099: <dd><dl>
                   1100: <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
                   1101: <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
                   1102: <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
                   1103: <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
                   1104: <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
                   1105: <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
                   1106: <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
                   1107: </dl></dd>
                   1108: </dl>
                   1109: </div>
                   1110: <div class="sect1" lang="en">
                   1111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1112: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10      hubertf  1113: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.1       dsieger  1114: </div>
                   1115: <div class="sect1" lang="en">
                   1116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1117: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
                   1118: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1119: <pre class="screen">
                   1120: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
                   1121: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1122: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1123:     </pre>
1.10      hubertf  1124: <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1.1       dsieger  1125:     pkgsrc before bootstrapping. The given
1.10      hubertf  1126:     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1.1       dsieger  1127:     <code class="filename">/usr/pkg</code> for the
                   1128:     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
                   1129:     and <code class="filename">/var/db/pkg</code> for the package database
                   1130:     directory where pkgsrc will do its internal bookkeeping.
                   1131:     However, these can also be set using command-line
                   1132:     arguments.</p>
                   1133: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1134: <h3 class="title">Note</h3>
1.10      hubertf  1135: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1136:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1137:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.1       dsieger  1138:       instead of &#8220;<span class="quote">make</span>&#8221;.</p>
                   1139: </div>
                   1140: </div>
                   1141: <div class="sect1" lang="en">
                   1142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1143: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
                   1144: <p>Here are some platform-specific notes you should be aware of.</p>
                   1145: <div class="sect2" lang="en">
                   1146: <div class="titlepage"><div><div><h3 class="title">
                   1147: <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
                   1148: <p>Darwin 5.x and up are supported. There are two methods of using
1.10      hubertf  1149:        pkgsrc on Mac OS X, by using a <a class="link" href="#platform.osx-image" title="3.3.1.1. Using a disk image">disk
                   1150:          image</a>, or a <a class="link" href="#platform.osx-part" title="3.3.1.2. Using a UFS or HFSX partition">UFS or HFSX
1.1       dsieger  1151:          partition</a>.</p>
                   1152: <p>Before you start, you will need to download and install the Mac OS X Developer
1.10      hubertf  1153:       Tools from Apple's Developer Connection.  See <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.1       dsieger  1154:       for details.  Also, make sure you install X11 for Mac OS X and the X11 SDK
1.10      hubertf  1155:       from <a class="ulink" href="http://www.apple.com/macosx/x11/download/" target="_top">http://www.apple.com/macosx/x11/download/</a>
1.1       dsieger  1156:       if you intend to build packages that use the X11 Window System.</p>
                   1157: <p>If you already have a UFS or HFSX partition, or have a spare partition
                   1158:       that you can format as UFS or HFSX, it is recommended to use that instead of
                   1159:       the disk image. It'll be somewhat faster and will mount automatically
                   1160:       at boot time, where you must manually mount a disk image.</p>
                   1161: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1162: <h3 class="title">Note</h3>
                   1163: <p>You cannot use an ordinary HFS+ file system for pkgsrc, because pkgsrc currently
                   1164:          requires the file system to be case-sensitive. You can, however, use a case-sensitive HFS+ (aka HFSX) file system as found in Darwin 7.0 and newer.</p>
                   1165: </div>
                   1166: <div class="sect3" lang="en">
                   1167: <div class="titlepage"><div><div><h4 class="title">
                   1168: <a name="platform.osx-image"></a>3.3.1.1. Using a disk image</h4></div></div></div>
                   1169: <p>Create the disk image:</p>
                   1170: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1171: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage create ~/Documents/NetBSD 1024</code></strong> # megabytes - season to taste
                   1172: <code class="prompt">#</code> <strong class="userinput"><code>./darwindiskimage mount ~/Documents/NetBSD</code></strong>
                   1173: <code class="prompt">#</code> <strong class="userinput"><code>sudo chown `id -u`:`id -g` /Volumes/NetBSD</code></strong></pre>
                   1174: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1175: <h3 class="title">Note</h3>
1.9       rillig   1176: <p>darwindiskimage will mount the filesystem nosuid, which will cause problems for packages that depend on setgid.  In the case of UFS, it will also mount the filesystem asynchronous, which is somewhat dangerous according to the mount(8) man page.  In the case of HFSX, it will disable journaling.</p>
1.1       dsieger  1177: </div>
                   1178: <p>Allow suid:</p>
                   1179: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sudo mount -u -o suid /Volumes/NetBSD</code></strong></pre>
1.5       weinem   1180: <p>Changing the build directory:</p>
                   1181: <p>After bootstrapping you need to change the default package build directory to somewhere outside the disk image so it doesn't get filled up in the process of building packages. Add something like that to <code class="filename">mk.conf</code>.</p>
                   1182: <pre class="programlisting">
                   1183:          WRKOBJDIR?=           /tmp/pkgsrc         # build here instead of in pkgsrc
                   1184:        </pre>
1.1       dsieger  1185: </div>
                   1186: <div class="sect3" lang="en">
                   1187: <div class="titlepage"><div><div><h4 class="title">
                   1188: <a name="platform.osx-part"></a>3.3.1.2. Using a UFS or HFSX partition</h4></div></div></div>
                   1189: <p>By default, <code class="filename">/usr</code> will be on your root file
                   1190:        system, normally HFS+. It is possible to use the default
                   1191:        <span class="emphasis"><em>prefix</em></span> of <code class="filename">/usr/pkg</code>
                   1192:        by symlinking <code class="filename">/usr/pkg</code> to a directory on a UFS
                   1193:        or HFSX file system. Obviously, another symlink is required if you want to
                   1194:        place the package database directory outside the
                   1195:        <span class="emphasis"><em>prefix</em></span>. e.g.</p>
                   1196: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --pkgdbdir /usr/pkg/pkgdb</code></strong></pre>
                   1197: <p>If you created your partitions at the time of installing Mac OS X
                   1198:        and formatted the target partition as UFS or HFSX, it should automatically
                   1199:        mount on <code class="filename">/Volumes/&lt;volume name&gt;</code> when the
                   1200:        machine boots. If you are (re)formatting a partition as UFS or HFSX, you need
                   1201:        to ensure that the partition map correctly reflects
                   1202:        &#8220;<span class="quote">Apple_UFS</span>&#8221; or &#8220;<span class="quote">Apple_HFSX</span>&#8221; and not &#8220;<span class="quote">Apple_HFS</span>&#8221;.</p>
                   1203: <p>The problem is that none of the disk tools will let you touch a
                   1204:        disk that is booted from. You can unmount the partition, but even if
                   1205:        you newfs it, the partition type will be incorrect and the
                   1206:        automounter won't mount it. It can be mounted manually, but it won't
                   1207:        appear in Finder.</p>
                   1208: <p>You'll need to boot off of the OS X Installation (User) CD.  When
                   1209:        the Installation program starts, go up to the menu and select Disk
                   1210:        Utility.  Now, you will be able to select the partition you want
                   1211:        to be UFS or HFSX, and Format it Apple UFS or HFSX. Quit the Disk Utility, quit the
                   1212:        installer which will reboot your machine. The new UFS or HFSX file system
                   1213:        will appear in Finder.</p>
                   1214: <p>Be aware that the permissions on the new file system will be writable
                   1215:        by root only.</p>
                   1216: <p>This note is as of 10.2 (Jaguar) and applies to earlier versions.
                   1217:        Hopefully Apple will fix Disk Utility in 10.3 (Panther).</p>
                   1218: </div>
                   1219: </div>
                   1220: <div class="sect2" lang="en">
                   1221: <div class="titlepage"><div><div><h3 class="title">
                   1222: <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
                   1223: <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
                   1224:       other versions may work.</p>
                   1225: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1226:       with the FreeBSD userland tools. There are several steps:</p>
                   1227: <div class="orderedlist"><ol type="1">
                   1228: <li><p>FreeBSD stores its ports pkg database in
                   1229:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1230:          recommended that you choose a different location (e.g.
                   1231:          <code class="filename">/usr/pkgdb</code>) by
                   1232:          using the --pkgdbdir option to the bootstrap script.</p></li>
                   1233: <li>
                   1234: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
                   1235:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1236: <pre class="screen">
                   1237: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1238: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1239: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1240: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1241: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1242:          </pre>
                   1243: </li>
1.10      hubertf  1244: <li><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1245:          <code class="filename">/etc/mk.conf.example</code> file
                   1246:          when you use the bootstrap script.</p></li>
                   1247: </ol></div>
                   1248: </div>
                   1249: <div class="sect2" lang="en">
                   1250: <div class="titlepage"><div><div><h3 class="title">
                   1251: <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
                   1252: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
                   1253:       providing a Unix-like environment with a tighter kernel integration than
                   1254:       available with Cygwin.  It is part of the Windows Services for Unix
                   1255:       package, available for free for any licensed copy of Windows 2000, XP
1.10      hubertf  1256:       (not including XP Home), or 2003.  SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.1       dsieger  1257: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1258:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1259:       of pthreads, but other parts of libc may also be lacking.)</p>
                   1260: <p>Services for Unix Applications (aka SUA) is an integrated component
                   1261:       of Windows Server 2003 R2 and Windows Vista.  As of this writing, SUA's
                   1262:       Interix 5.x subsystem has not yet been tested with pkgsrc.</p>
                   1263: <div class="sect3" lang="en">
                   1264: <div class="titlepage"><div><div><h4 class="title">
                   1265: <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
                   1266: <p>At an absolute minimum, the following packages must be installed from
                   1267:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
                   1268: <div class="itemizedlist"><ul type="disc">
                   1269: <li><p>Utilities -&gt; Base Utilities</p></li>
                   1270: <li><p>Interix GNU Components -&gt; (all)</p></li>
                   1271: <li><p>Remote Connectivity</p></li>
                   1272: <li><p>Interix SDK</p></li>
                   1273: </ul></div>
                   1274: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
                   1275:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1276:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1277:        pkgsrc (or from a binary package).</p>
                   1278: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
                   1279:        not need to be installed, but Remote Connectivity itself should be
                   1280:        installed in order to have a working inetd.</p>
                   1281: <p>During installation you may be asked whether to enable setuid
                   1282:        behavior for Interix programs, and whether to make pathnames default to
                   1283:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1284:        enabled.  (Without case-sensitivity, a large number of packages including
                   1285:        perl will not build.)</p>
                   1286: <p>NOTE:  Newer Windows service packs change the way binary execution
                   1287:        works (via the Data Execution Prevention feature).  In order to use
                   1288:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1289:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1290:        must be installed.  Hotfixes are available from Microsoft through a
1.14      jmcneill 1291:        support contract; however, Debian Interix Port has made most Interix
                   1292:        hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.1       dsieger  1293: <p>In addition to the hotfix noted above, it may be necessary to
                   1294:        disable Data Execution Prevention entirely to make Interix functional.
                   1295:        This may happen only with certain types of CPUs; the cause is not fully
                   1296:        understood at this time.  If gcc or other applications still segfault
                   1297:        repeatedly after installing one of the hotfixes note above, the
                   1298:        following option can be added to the appropriate "boot.ini" line on the
                   1299:        Windows boot drive:  /NoExecute=AlwaysOff
                   1300:        (WARNING, this will disable DEP completely, which may be a security
                   1301:        risk if applications are often run as a user in the Administrators
                   1302:        group!)</p>
                   1303: </div>
                   1304: <div class="sect3" lang="en">
                   1305: <div class="titlepage"><div><div><h4 class="title">
                   1306: <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
                   1307: <p>If SFU is already installed and you wish to alter these settings to work
                   1308:        with pkgsrc, note the following things.</p>
                   1309: <div class="itemizedlist"><ul type="disc">
                   1310: <li><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
                   1311:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1312:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
                   1313: <li>
                   1314: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
                   1315:            change the following registry key:</p>
                   1316: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1317: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1318: </li>
                   1319: <li>
                   1320: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
                   1321:            following registry key:</p>
                   1322: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1323: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1324: </li>
                   1325: </ul></div>
                   1326: </div>
                   1327: <div class="sect3" lang="en">
                   1328: <div class="titlepage"><div><div><h4 class="title">
                   1329: <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
                   1330: <p>The package manager (either the pkgsrc "su" user, or the user
                   1331:        running "pkg_add") must be a member of the local Administrators
                   1332:        group.  Such a user must also be used to run the bootstrap.  This is
                   1333:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
                   1334: <p>The package manager should use a umask of 002.  "make install" will
                   1335:        automatically complain if this is not the case.  This ensures that
                   1336:        directories written in /var/db/pkg are Administrators-group writeable.</p>
                   1337: <p>The popular Interix binary packages from http://www.interopsystems.com/
                   1338:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1339:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1340:        the same time as the pkgsrc packages, ensure that you use the proper
                   1341:        pkg_* tools for each type of binary package.</p>
                   1342: <p>The TERM setting used for DOS-type console windows (including those
                   1343:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1344:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1345:        entry provides adequate emulation in most cases:</p>
                   1346: <pre class="programlisting">
                   1347: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
                   1348:        </pre>
                   1349: </div>
                   1350: <div class="sect3" lang="en">
                   1351: <div class="titlepage"><div><div><h4 class="title">
                   1352: <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
                   1353: <p>Though Interix suffices as a familiar and flexible substitute
                   1354:        for a full Unix-like platform, it has some drawbacks that should
                   1355:        be noted for those desiring to make the most of Interix.</p>
                   1356: <div class="itemizedlist"><ul type="disc">
                   1357: <li>
                   1358: <p><span class="strong"><strong>X11:</strong></span></p>
                   1359: <p>Interix comes with the standard set of X11R6 client libraries,
                   1360:          and can run X11 based applications, but it does
                   1361:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.10      hubertf  1362:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1363:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.1       dsieger  1364:          (available in a trimmed version for Interix from Interop Systems as the
1.10      hubertf  1365:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.1       dsieger  1366:          and the free X11 server included with
1.10      hubertf  1367:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.1       dsieger  1368: </li>
                   1369: <li>
                   1370: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1371: <p>Because Interix runs in a completely different NT subsystem from
                   1372:          Win32 applications, it does not currently support various X11
                   1373:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1374:          Most interactive applications to a local X server will run
                   1375:          reasonably fast, but full motion video and other graphics
                   1376:          intensive applications may require a faster-than-expected CPU.</p>
                   1377: </li>
                   1378: <li>
                   1379: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1380: <p>Interix has no native support for audio output.  For audio
1.10      hubertf  1381:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.1       dsieger  1382:          audio system on Interix.  Unlike on most platforms, the
                   1383:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.10      hubertf  1384:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.1       dsieger  1385:          server component.  To output audio via an Interix host, the
                   1386:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
                   1387:          must also be installed.</p>
                   1388: </li>
                   1389: <li>
                   1390: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1391: <p>Direct device access is not currently supported in Interix, so it
                   1392:          is not currently possible to access CD/DVD drives, USB devices,
                   1393:          or SCSI devices through non-filesystem means.  Among other things,
                   1394:          this makes it impossible to use Interix directly for CD/DVD
                   1395:          burning.</p>
                   1396: </li>
                   1397: <li>
                   1398: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1399: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
                   1400:          drives are also not directly accessible in Interix.  However,
                   1401:          support is in work to make tape drive access possible by using
                   1402:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1403:          esound server).</p>
                   1404: </li>
                   1405: </ul></div>
                   1406: </div>
                   1407: <div class="sect3" lang="en">
                   1408: <div class="titlepage"><div><div><h4 class="title">
                   1409: <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
                   1410: <p>It is not necessary, in general, to have a "root" user on the
                   1411:        Windows system; any member of the local Administrators group will
                   1412:        suffice.  However, some packages currently assume that the user
                   1413:        named "root" is the privileged user.  To accommodate these, you
                   1414:        may create such a user; make sure it is in the local group
                   1415:        Administrators (or your language equivalent).</p>
1.10      hubertf  1416: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.1       dsieger  1417:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1418:        time being, install packages as the local Administrator (or
                   1419:        your language equivalent), or run the following command after
                   1420:        installing a package to work around the issue:</p>
                   1421: <pre class="screen">
                   1422: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1423:        </pre>
                   1424: </div>
                   1425: </div>
                   1426: <div class="sect2" lang="en">
                   1427: <div class="titlepage"><div><div><h3 class="title">
                   1428: <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
                   1429: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
                   1430:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1431:       according to your preference.  If you do not have a license for the MIPSpro
1.10      hubertf  1432:       compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.1       dsieger  1433: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.10      hubertf  1434:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.1       dsieger  1435:       etc.</p>
                   1436: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
                   1437:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1438:        you start out using "abi=n32", that's what all your packages will be built
                   1439:        with.</p>
                   1440: <p>Therefore, please make sure that you have no conflicting
                   1441:       <code class="varname">CFLAGS</code> in your environment or the
1.10      hubertf  1442:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.1       dsieger  1443:       try to link n32 object files with lib64 or vice versa.  Check your
                   1444:       <code class="filename">/etc/compiler.defaults</code>!</p>
                   1445: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
                   1446:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1447:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1448:       link over a network-mounted file system.</p>
                   1449: <p>The bootstrapping process should set all the right options for programs such
                   1450:       as imake(1), but you may want to set some options depending on your local
                   1451:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1452:       course, your compiler's man pages for details.</p>
                   1453: <p>If you are using SGI's MIPSPro compiler, please set
                   1454: 
                   1455:       </p>
                   1456: <pre class="programlisting">
                   1457: PKGSRC_COMPILER=        mipspro
                   1458:       </pre>
                   1459: <p>
                   1460: 
1.10      hubertf  1461:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.1       dsieger  1462:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1463:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1464:       default.</p>
                   1465: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
                   1466:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
                   1467:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1468:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1469:       '--preserve-path' flag.</p>
                   1470: </div>
                   1471: <div class="sect2" lang="en">
                   1472: <div class="titlepage"><div><div><h3 class="title">
                   1473: <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
                   1474: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1475:       either libtermcap or libcurses (libncurses).  Installing the
                   1476:       distributions libncurses-dev package (or equivalent) should fix
                   1477:       the problem.</p>
                   1478: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1479:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1480:       i386 have been tested.</p>
                   1481: <p>To bootstrap using icc, assuming the default icc installation
                   1482:       directory:</p>
                   1483: <pre class="programlisting">
                   1484: env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
                   1485: ac_cv___attribute__=yes ./bootstrap
                   1486:       </pre>
                   1487: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1488: <h3 class="title">Note</h3>
                   1489: <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
                   1490: </div>
                   1491: <p>icc supports __attribute__, but the GNU configure test uses a nested
                   1492:       function, which icc does not support. #undef'ing __attribute__ has the
                   1493:       unfortunate side-effect of breaking many of the Linux header files, which
                   1494:       cannot be compiled properly without __attribute__. The test must be
                   1495:       overridden so that __attribute__ is assumed supported by the
                   1496:       compiler.</p>
                   1497: <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1.10      hubertf  1498:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1499: <pre class="programlisting">
                   1500: PKGSRC_COMPILER=        icc
                   1501:       </pre>
                   1502: <p>The default installation directory for icc is
                   1503:       <code class="filename">/opt/intel_cc_80</code>, which
                   1504:       is also the pkgsrc default. If you have installed it into a different
                   1505:       directory, set <code class="varname">ICCBASE</code> in
1.10      hubertf  1506:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1507: <pre class="programlisting">
                   1508: ICCBASE=                /opt/icc
                   1509:       </pre>
                   1510: <p>pkgsrc uses the static linking method of the runtime libraries
                   1511:       provided by icc, so binaries can be run on other systems which do not
                   1512:       have the shared libraries installed.</p>
                   1513: <p>Libtool, however, extracts a list of libraries from the
1.10      hubertf  1514:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ld+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> command run when linking a C++ shared library and
1.1       dsieger  1515:       records it, throwing away the -Bstatic and -Bdynamic options
                   1516:       interspersed between the libraries.  This means that
                   1517:       libtool-linked C++ shared libraries will have a runtime
                   1518:       dependency on the icc libraries until this is fixed in
                   1519:       libtool.</p>
                   1520: </div>
                   1521: <div class="sect2" lang="en">
                   1522: <div class="titlepage"><div><div><h3 class="title">
                   1523: <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
                   1524: <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
                   1525: <p>Care should be taken so that the tools that this kit installs do not conflict
                   1526:       with the OpenBSD userland tools. There are several steps:</p>
                   1527: <div class="orderedlist"><ol type="1">
                   1528: <li><p>OpenBSD stores its ports pkg database in
                   1529:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1530:          recommended that you choose a different location (e.g.
                   1531:          <code class="filename">/usr/pkgdb</code>) by
                   1532:          using the --pkgdbdir option to the bootstrap script.</p></li>
                   1533: <li>
                   1534: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
                   1535:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1536: <pre class="screen">
                   1537: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
                   1538: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1539: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1540: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
                   1541: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1542:          </pre>
                   1543: </li>
                   1544: <li>
1.10      hubertf  1545: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.1       dsieger  1546:          <code class="filename">/etc/mk.conf.example</code> file
                   1547:          when you use the bootstrap script. OpenBSD's make program uses
1.10      hubertf  1548:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  1549:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1550:          of the file with:</p>
                   1551: <pre class="programlisting">
                   1552: .ifdef BSD_PKG_MK
                   1553: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1554: .else
                   1555: # OpenBSD stuff
                   1556: .endif
                   1557:          </pre>
                   1558: </li>
                   1559: </ol></div>
                   1560: </div>
                   1561: <div class="sect2" lang="en">
                   1562: <div class="titlepage"><div><div><h3 class="title">
                   1563: <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
                   1564: <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
                   1565:       You will need a working C compiler. Both gcc 2.95.3 and
                   1566:       Sun WorkShop 5 have been tested.</p>
                   1567: <p>The following packages are required on Solaris 8 for the bootstrap
                   1568:       process and to build packages.</p>
                   1569: <div class="itemizedlist"><ul type="disc">
                   1570: <li><p>SUNWsprot</p></li>
                   1571: <li><p>SUNWarc</p></li>
                   1572: <li><p>SUNWbtool</p></li>
                   1573: <li><p>SUNWtoo</p></li>
                   1574: <li><p>SUNWlibm</p></li>
                   1575: </ul></div>
                   1576: <p>Please note that the use of GNU binutils on Solaris is
                   1577:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
                   1578: <p>Whichever compiler you use, please ensure the compiler tools and
                   1579:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1580:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1581:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
                   1582: <div class="sect3" lang="en">
                   1583: <div class="titlepage"><div><div><h4 class="title">
                   1584: <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
                   1585: <p>It makes life much simpler if you only use the same gcc consistently
                   1586:        for building all packages.</p>
                   1587: <p>It is recommended that an external gcc be used only for bootstrapping,
                   1588:        then either build gcc from
                   1589:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc/README.html" target="_top"><code class="filename">lang/gcc</code></a> or install a binary gcc
                   1590:        package, then remove gcc used during bootstrapping.</p>
1.10      hubertf  1591: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.1       dsieger  1592: </div>
                   1593: <div class="sect3" lang="en">
                   1594: <div class="titlepage"><div><div><h4 class="title">
                   1595: <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
                   1596: <p>You will need at least the following packages installed (from WorkShop
                   1597:        5.0)</p>
                   1598: <div class="itemizedlist"><ul type="disc">
                   1599: <li><p>SPROcc
                   1600:          - Sun WorkShop Compiler C 5.0</p></li>
                   1601: <li><p>SPROcpl
                   1602:          - Sun WorkShop Compiler C++ 5.0</p></li>
                   1603: <li><p>SPROild
                   1604:          - Sun WorkShop Incremental Linker</p></li>
                   1605: <li><p>SPROlang
                   1606:          - Sun WorkShop Compilers common components</p></li>
                   1607: </ul></div>
                   1608: <p>You should set the following variables in your
1.10      hubertf  1609:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1610: <pre class="programlisting">
                   1611: CC=     cc
                   1612: CXX=    CC
                   1613: CPP=    cc -E
                   1614: CXXCPP= CC -E
                   1615: </pre>
                   1616: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1617: <h3 class="title">Note</h3>
                   1618: <p>The <code class="varname">CPP</code> setting might break some
                   1619:        packages that use the C preprocessor for processing things other
                   1620:        than C source code.</p>
                   1621: </div>
                   1622: </div>
                   1623: <div class="sect3" lang="en">
                   1624: <div class="titlepage"><div><div><h4 class="title">
                   1625: <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
                   1626: <p>To build 64-bit packages, you just need to have the
1.10      hubertf  1627:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.1       dsieger  1628: <pre class="programlisting">
                   1629: PKGSRC_COMPILER=        sunpro
                   1630: ABI=                    64
                   1631: </pre>
                   1632: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1633: <h3 class="title">Note</h3>
                   1634: <p>This setting has been tested for the SPARC
                   1635:        architecture. Intel and AMD machines need some more
                   1636:        work.</p>
                   1637: </div>
                   1638: </div>
                   1639: <div class="sect3" lang="en">
                   1640: <div class="titlepage"><div><div><h4 class="title">
                   1641: <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1.10      hubertf  1642: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.1       dsieger  1643:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1644:       The workaround is to use another shell for the configure
                   1645:       scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.10      hubertf  1646:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  1647: <pre class="programlisting">
                   1648: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1649: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
                   1650:       </pre>
                   1651: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
                   1652: </div>
                   1653: </div>
                   1654: </div>
                   1655: </div>
                   1656: <div class="chapter" lang="en">
                   1657: <div class="titlepage"><div><div><h2 class="title">
                   1658: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1659: <div class="toc">
                   1660: <p><b>Table of Contents</b></p>
                   1661: <dl>
                   1662: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1663: <dd><dl>
                   1664: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1665: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                   1666: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1667: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1668: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1669: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                   1670: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1671: <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
                   1672: </dl></dd>
                   1673: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1674: <dd><dl>
                   1675: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1676: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1677: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1678: </dl></dd>
                   1679: </dl>
                   1680: </div>
                   1681: <p>Basically, there are two ways of using pkgsrc. The first
                   1682: is to only install the package tools and to use binary packages
                   1683: that someone else has prepared. This is the &#8220;<span class="quote">pkg</span>&#8221;
                   1684: in pkgsrc. The second way is to install the &#8220;<span class="quote">src</span>&#8221;
                   1685: of pkgsrc, too. Then you are able to build your own packages,
                   1686: and you can still use binary packages from someone else.</p>
                   1687: <div class="sect1" lang="en">
                   1688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1689: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10      hubertf  1690: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9       rillig   1691:   server and its mirrors, there are collections of binary packages,
                   1692:   ready to be installed. These binary packages have been built using the
                   1693:   default settings for the directories, that is:</p>
                   1694: <div class="itemizedlist"><ul type="disc">
                   1695: <li><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1696: <li><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1697: <li><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
                   1698: </ul></div>
                   1699: <p>If you cannot use these directories for whatever reasons (maybe
                   1700:   because you're not root), you cannot use these binary packages, but
1.10      hubertf  1701:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.1       dsieger  1702: <div class="sect2" lang="en">
                   1703: <div class="titlepage"><div><div><h3 class="title">
                   1704: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1705: <p>To install binary packages, you first need to know from where
                   1706:     to get them. The first place where you should look is on the main
1.10      hubertf  1707:     pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5       weinem   1708: <p>This directory contains binary packages for multiple
                   1709:     platforms. First, select your operating system. (Ignore the
                   1710:     directories with version numbers attached to it, they just exist for
                   1711:     legacy reasons.) Then, select your hardware architecture, and in the
1.9       rillig   1712:     third step, the OS version and the &#8220;<span class="quote">version</span>&#8221; of pkgsrc.</p>
                   1713: <p>In this directory, you often find a file called
                   1714:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1715:     management tools. If the file is missing, it is likely that your
                   1716:     operating system already provides those tools. Download the file and
                   1717:     extract it in the <code class="filename">/</code> directory. It will create
                   1718:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1719:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1720:     (the database of installed packages).</p>
1.1       dsieger  1721: </div>
                   1722: <div class="sect2" lang="en">
                   1723: <div class="titlepage"><div><div><h3 class="title">
                   1724: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1725: <p>In the directory from the last section, there is a
                   1726:     subdirectory called <code class="filename">All</code>, which contains all the
                   1727:     binary packages that are available for the platform, excluding those
                   1728:     that may not be distributed via FTP or CDROM (depending on which
                   1729:     medium you are using), and the ones that have vulnerabilities and
                   1730:     therefore are considered insecure to install without thinking
                   1731:     before.</p>
                   1732: <p>To install packages directly from an FTP or HTTP server, run
                   1733:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1734:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1735: <pre class="screen">
                   1736: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
                   1737: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All"</code></strong>
                   1738: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1739: </pre>
                   1740: <p>Instead of URLs, you can also use local paths, for example if
                   1741:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1742:     repository. If you want to install packages from multiple sources,
                   1743:     you can separate them by a semicolon in
                   1744:     <code class="varname">PKG_PATH</code>.</p>
                   1745: <p>After these preparations, installing a package is very
                   1746:     easy:</p>
                   1747: <pre class="screen">
                   1748: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1749: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1750: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1751: </pre>
1.1       dsieger  1752: <p>Note that any prerequisite packages needed to run the
                   1753:     package in question will be installed, too, assuming they are
                   1754:     present where you install from.</p>
1.9       rillig   1755: <p>As mentioned above, packages for which vulnerabilities get
                   1756:     known are not stored in the <code class="filename">All</code> subdirectory.
                   1757:     They don't get deleted since that could be very frustrating if many
                   1758:     other packages depend on it. Instead, they are moved to the
                   1759:     <code class="filename">vulnerable</code> subdirectory. So you may need to add
                   1760:     this directory to the <code class="varname">PKG_PATH</code> variable. 
1.14      jmcneill 1761:     However, you should run <span class="command"><strong>audit-packages</strong></span>
                   1762:     regularly, especially after installing new packages, and verify
                   1763:     that the vulnerabilities are acceptable for your configuration.</p>
1.1       dsieger  1764: <p>After you've installed packages, be sure to have
                   1765:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1766:     <code class="varname">PATH</code> so you can actually start the just
                   1767:     installed program.</p>
                   1768: </div>
                   1769: <div class="sect2" lang="en">
                   1770: <div class="titlepage"><div><div><h3 class="title">
                   1771: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1772: <p>To deinstall a package, it does not matter whether it was
                   1773:     installed from source code or from a binary package. The
1.10      hubertf  1774:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1775:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1       dsieger  1776:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1777:     name can be given with or without version number. Wildcards can
                   1778:     also be used to deinstall a set of packages, for example
                   1779:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1780:     so that the shell does not expand them before
                   1781:     <code class="literal">pkg_delete</code> sees them.</p>
                   1782: <p>The <code class="option">-r</code> option is very powerful: it
                   1783:     removes all the packages that require the package in question
                   1784:     and then removes the package itself. For example:
                   1785: 
                   1786:     </p>
                   1787: <pre class="screen">
                   1788: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1789:     </pre>
                   1790: <p>
                   1791: 
                   1792:     will remove jpeg and all the packages that used it; this allows
                   1793:     upgrading the jpeg package.</p>
                   1794: </div>
                   1795: <div class="sect2" lang="en">
                   1796: <div class="titlepage"><div><div><h3 class="title">
                   1797: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1798: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1       dsieger  1799:     installed packages or binary package files.</p>
                   1800: </div>
                   1801: <div class="sect2" lang="en">
                   1802: <div class="titlepage"><div><div><h3 class="title">
                   1803: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1804: <p>
                   1805:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1806:       known security vulnerabilities to packages which are (or have been)
                   1807:       included in pkgsrc.  The list is available from the NetBSD
1.10      hubertf  1808:       FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1       dsieger  1809:     </p>
                   1810: <p>
                   1811:       Through <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>,
                   1812:       this list can be downloaded
                   1813:       automatically, and a security audit of all packages installed on a system
                   1814:       can take place.
                   1815:     </p>
                   1816: <p>
                   1817:       There are two components to
                   1818:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.  The first
                   1819:       component, &#8220;<span class="quote">download-vulnerability-list</span>&#8221;, is for downloading
                   1820:       the list of vulnerabilities from the NetBSD FTP site.  The second
                   1821:       component, &#8220;<span class="quote">audit-packages</span>&#8221;, checks to see if any of your
                   1822:       installed packages are vulnerable.  If a package is vulnerable, you
                   1823:       will see output similar to the following:
                   1824:     </p>
                   1825: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1826:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
                   1827: <p>
                   1828:       One can set up <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a> to download the
1.10      hubertf  1829:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.1       dsieger  1830:       file daily, and include a package audit in the daily security script.
1.10      hubertf  1831:       Details on this are located in the <a class="ulink" href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/security/audit-packages/MESSAGE?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top">MESSAGE</a>
1.1       dsieger  1832:       file for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/audit-packages/README.html" target="_top"><code class="filename">security/audit-packages</code></a>.
                   1833:     </p>
                   1834: </div>
                   1835: <div class="sect2" lang="en">
                   1836: <div class="titlepage"><div><div><h3 class="title">
                   1837: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1838: <p>
1.12      weinem   1839:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.10      hubertf  1840:       <span class="command"><strong>lintpkgsrc</strong></span> with the &#8220;<span class="quote">-i</span>&#8221;
1.1       dsieger  1841:       argument to check if your packages are up-to-date, e.g.
                   1842:     </p>
                   1843: <pre class="screen">
                   1844: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1845: ...
                   1846: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1847:     </pre>
1.10      hubertf  1848: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1       dsieger  1849:     package on your system and rebuild any dependencies.
                   1850:     </p>
                   1851: </div>
                   1852: <div class="sect2" lang="en">
                   1853: <div class="titlepage"><div><div><h3 class="title">
                   1854: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10      hubertf  1855: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1856:     administrative functions on the package system.</p>
                   1857: </div>
                   1858: <div class="sect2" lang="en">
                   1859: <div class="titlepage"><div><div><h3 class="title">
                   1860: <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
                   1861: <p>Please pay very careful attention to the warnings
1.10      hubertf  1862:     expressed in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> manual page about the
1.1       dsieger  1863:     inherent dangers of installing binary packages which you did
                   1864:     not create yourself, and the security holes that can be
                   1865:     introduced onto your system by indiscriminate adding of such
                   1866:     files.</p>
                   1867: <p>The same warning of course applies to every package you
                   1868:     install from source when you haven't completely read and
                   1869:     understood the source code of the package, the compiler that
                   1870:     is used to build the package and all the other tools that are
                   1871:     involved.</p>
                   1872: </div>
                   1873: </div>
                   1874: <div class="sect1" lang="en">
                   1875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1876: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
                   1877: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1878:   directory now contains a set of packages, organized into
                   1879:   categories. You can browse the online index of packages, or run
1.10      hubertf  1880:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1881:   directory to build local <code class="filename">README.html</code> files for
                   1882:   all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
                   1883: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1884:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1885:   should do so by setting <code class="varname">LOCALBASE</code> in
1.10      hubertf  1886:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1887:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1888:   system (inside a chroot is an exception). </p>
                   1889: <p>The rest of this chapter assumes that the package is already
1.10      hubertf  1890:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.1       dsieger  1891:   instructions how to create your own packages.</p>
                   1892: <div class="sect2" lang="en">
                   1893: <div class="titlepage"><div><div><h3 class="title">
                   1894: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
                   1895: <p>To build packages from source, you need a working C
                   1896:     compiler. On NetBSD, you need to install the
                   1897:     &#8220;<span class="quote">comp</span>&#8221; and the &#8220;<span class="quote">text</span>&#8221; distribution
                   1898:     sets. If you want to build X11-related packages, the
                   1899:     &#8220;<span class="quote">xbase</span>&#8221; and &#8220;<span class="quote">xcomp</span>&#8221; distribution
                   1900:     sets are required, too.</p>
                   1901: </div>
                   1902: <div class="sect2" lang="en">
                   1903: <div class="titlepage"><div><div><h3 class="title">
                   1904: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1905: <p>The first step for building a package is downloading the
                   1906:     distfiles (i.e. the unmodified source). If they have not yet been
                   1907:     downloaded, pkgsrc will fetch them automatically.</p>
                   1908: <p>If you have all files that you need in the
                   1909:     <code class="filename">distfiles</code> directory,
                   1910:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1911:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1912:     </p>
                   1913: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1914: <p>
1.10      hubertf  1915:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1916: <p>By default a list of distribution sites will be randomly
                   1917:     intermixed to prevent huge load on servers which holding popular
                   1918:     packages (for example, SourceForge.net mirrors). Thus, every
                   1919:     time when you need to fetch yet another distfile all the mirrors
                   1920:     will be tried in new (random) order. You can turn this feature
                   1921:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1922:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1923: <p>You can overwrite some of the major distribution sites to
                   1924:     fit to sites that are close to your own.  By setting one or two
                   1925:     variables you can modify the order in which the master sites are
                   1926:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1927:     delimited list of domain suffixes.
                   1928:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1929:     contains a whitespace delimited list of regular expressions.  It
                   1930:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1931:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1932:     some examples.  This may save some of your bandwidth and
                   1933:     time.</p>
                   1934: <p>You can change these settings either in your shell's environment, or,
                   1935:     if you want to keep the settings, by editing the
1.10      hubertf  1936:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1937:     and adding the definitions there.</p>
                   1938: <p>
                   1939:       If a package depends on many other packages (such as
                   1940:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
                   1941:       alternate between periods of
                   1942:       downloading source, and compiling. To ensure you have all the source
                   1943:       downloaded initially you can run the command:
                   1944:       </p>
                   1945: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1946: <p>
                   1947:       which will output and run a set of shell commands to fetch the
                   1948:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1949:       also choose to download the files manually.
                   1950:     </p>
                   1951: </div>
                   1952: <div class="sect2" lang="en">
                   1953: <div class="titlepage"><div><div><h3 class="title">
                   1954: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
                   1955: <p>
                   1956:       Once the software has downloaded, any patches will be applied, then it
                   1957:       will be compiled for you. This may take some time depending on your
                   1958:       computer, and how many other packages the software depends on and their
                   1959:       compile time.
                   1960:     </p>
                   1961: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1962: <h3 class="title">Note</h3>
                   1963: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1964:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.1       dsieger  1965:     &#8220;<span class="quote">make</span>&#8221; in the examples in this guide.</p>
                   1966: </div>
                   1967: <p>For example, type</p>
                   1968: <pre class="screen">
                   1969: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1970: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1971:     </pre>
                   1972: <p>at the shell prompt to build the various components of the
                   1973:     package.</p>
                   1974: <p>The next stage is to actually install the newly compiled
                   1975:     program onto your system. Do this by entering:
                   1976: 
                   1977:     </p>
                   1978: <pre class="screen">
                   1979: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1980:     </pre>
                   1981: <p>
                   1982: 
                   1983:     while you are still in the directory for whatever package you
                   1984:     are installing.</p>
                   1985: <p>Installing the package on your system may require you to
                   1986:     be root.  However, pkgsrc has a
                   1987:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1988:     to only become root for the actual installation step.</p>
                   1989: <p>That's it, the software should now be installed and setup for use.
                   1990:     You can now enter:
                   1991: 
                   1992:     </p>
                   1993: <pre class="screen">
                   1994: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1995:     </pre>
                   1996: <p>
                   1997: 
                   1998:     to remove the compiled files in the work directory, as you shouldn't need
                   1999:     them any more. If other packages were also added to your system
                   2000:     (dependencies) to allow your program to compile, you can tidy these up
                   2001:     also with the command:</p>
                   2002: <pre class="screen">
                   2003: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2004:     </pre>
                   2005: <p>Taking the figlet utility as an example, we can install it on our
1.10      hubertf  2006:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1       dsieger  2007: <p>The program is installed under the default root of the
                   2008:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2009:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2010:     variable in your environment, and it will use that value as the
                   2011:     root of your packages tree. So, to use
                   2012:     <code class="filename">/usr/local</code>, set
                   2013:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2014:     Please note that you should use a directory which is dedicated to
                   2015:     packages and not shared with other programs (i.e., do not try and
                   2016:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2017:     to add any of your own files or directories (such as
                   2018:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2019:     <code class="filename">pkgsrc/</code>) below the
                   2020:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2021:     conflicts between programs and other files installed by the
                   2022:     package system and whatever else may have been installed
                   2023:     there.</p>
1.10      hubertf  2024: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  2025:     alter some configuration options at build time.  Have a look at
                   2026:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2027:     of what will be set there by default.  Environment variables such
                   2028:     as <code class="varname">LOCALBASE</code> can be set in
1.10      hubertf  2029:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  2030:     set them each time you want to use pkgsrc.</p>
                   2031: <p>Occasionally, people want to &#8220;<span class="quote">look under the
                   2032:     covers</span>&#8221; to see what is going on when a package is building
                   2033:     or being installed. This may be for debugging purposes, or out of
                   2034:     simple curiosity. A number of utility values have been added to
                   2035:     help with this.</p>
                   2036: <div class="orderedlist"><ol type="1">
                   2037: <li>
1.10      hubertf  2038: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1       dsieger  2039:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2040:        information will be displayed. For example,</p>
                   2041: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   2042: <p>will show all the commands that are invoked, up to and
                   2043:        including the &#8220;<span class="quote">patch</span>&#8221; stage.</p>
                   2044: </li>
                   2045: <li>
1.10      hubertf  2046: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1       dsieger  2047:        definition, then the <code class="varname">VARNAME</code> definition
                   2048:        should be used, in conjunction with the show-var
1.10      hubertf  2049:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1       dsieger  2050:        variable <code class="varname">LOCALBASE</code>:</p>
                   2051: <pre class="screen">
                   2052: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   2053: /usr/pkg
                   2054: <code class="prompt">%</code>
                   2055:        </pre>
                   2056: </li>
                   2057: </ol></div>
                   2058: <p>If you want to install a binary package that you've either
                   2059:     created yourself (see next section), that you put into
                   2060:     pkgsrc/packages manually or that is located on a remote FTP
                   2061:     server, you can use the "bin-install" target. This target will
1.10      hubertf  2062:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
                   2063:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  2064:     sites searched is kept in the variable
                   2065:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.10      hubertf  2066:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1       dsieger  2067:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2068:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2069:     details.</p>
                   2070: <p>A final word of warning: If you set up a system that has a
                   2071:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2072:     set that before any packages are installed, as you cannot use
                   2073:     several directories for the same purpose. Doing so will result in
                   2074:     pkgsrc not being able to properly detect your installed packages,
                   2075:     and fail miserably. Note also that precompiled binary packages are
                   2076:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2077:     <code class="filename">/usr/pkg</code>, and that you should
                   2078:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2079:     <code class="varname">LOCALBASE</code>.</p>
                   2080: </div>
                   2081: </div>
                   2082: </div>
                   2083: <div class="chapter" lang="en">
                   2084: <div class="titlepage"><div><div><h2 class="title">
                   2085: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2086: <div class="toc">
                   2087: <p><b>Table of Contents</b></p>
                   2088: <dl>
                   2089: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2090: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig   2091: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig   2092: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger  2093: <dd><dl>
1.4       rillig   2094: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.15      rillig   2095: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (CFLAGS)</a></span></dt>
                   2096: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (LDFLAGS)</a></span></dt>
1.1       dsieger  2097: </dl></dd>
1.4       rillig   2098: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2099: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger  2100: </dl>
                   2101: </div>
1.4       rillig   2102: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  2103: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2104: that file depends on the installation. On NetBSD, when you use
1.10      hubertf  2105: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1       dsieger  2106: <code class="filename">/etc/</code>. In all other cases the default location is
                   2107: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2108: bootstrap program to install the binary packages.</p>
                   2109: <p>During the bootstrap, an example configuration file is created. To
                   2110: use that, you have to create the directory
                   2111: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2112: there.</p>
                   2113: <p>The format of the configuration file is that of the usual
                   2114: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2115: is done by setting variables in this file. Note that you can define all
                   2116: kinds of variables, and no special error checking (for example for
                   2117: spelling mistakes) takes place, so you have to try it out to see if it
                   2118: works.</p>
                   2119: <div class="sect1" lang="en">
                   2120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2121: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2122: <p>In this section, you can find some variables that apply to all
                   2123:     pkgsrc packages. A complete list of the variables that can be
                   2124:     configured by the user is available in
                   2125:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2126:     comments that describe each variable's intent.</p>
                   2127: <div class="itemizedlist"><ul type="disc">
                   2128: <li><p><code class="varname">LOCALBASE</code>: Where
                   2129:            packages will be installed. The default is
                   2130:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   2131:            with different <code class="varname">LOCALBASE</code>s!</p></li>
                   2132: <li><p><code class="varname">CROSSBASE</code>: Where
                   2133:            &#8220;<span class="quote">cross</span>&#8221; category packages will be
                   2134:            installed. The default is
                   2135:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
                   2136: <li><p><code class="varname">X11BASE</code>: Where
                   2137:            X11 is installed on the system. The default is
                   2138:            <code class="filename">/usr/X11R6</code>.</p></li>
                   2139: <li><p><code class="varname">DISTDIR</code>: Where to store the
                   2140:            downloaded copies of the original source distributions used
                   2141:            for building pkgsrc packages. The default is
                   2142:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
                   2143: <li><p><code class="varname">PKG_DBDIR</code>: Where the
                   2144:            database about installed packages is stored.  The default is
                   2145:            <code class="filename">/var/db/pkg</code>.</p></li>
                   2146: <li><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
                   2147:            If set, override the packages'
                   2148:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
                   2149: <li><p><code class="varname">MASTER_SITE_BACKUP</code>:
                   2150:            Backup location(s) for distribution files and patch files
                   2151:            if not found locally or in
                   2152:            <code class="filename">${MASTER_SITES}</code> or
                   2153:            <code class="filename">${PATCH_SITES}</code> respectively.
                   2154:            The defaults are
                   2155:            <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
                   2156:            and
                   2157:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
                   2158: <li><p><code class="varname">BINPKG_SITES</code>:
                   2159:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2160:            <em class="replaceable"><code>arch</code></em> are replaced with OS
                   2161:            release (&#8220;<span class="quote">2.0</span>&#8221;, etc.) and architecture
                   2162:            (&#8220;<span class="quote">mipsel</span>&#8221;, etc.).</p></li>
                   2163: <li><p><code class="varname">ACCEPTABLE_LICENSES</code>:
                   2164:            List of acceptable licenses. Whenever you try to build a package
                   2165:            whose license is not in this list, you will get an error message
                   2166:            that includes instructions on how to change this variable.</p></li>
                   2167: </ul></div>
                   2168: </div>
                   2169: <div class="sect1" lang="en">
                   2170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2171: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
                   2172: <p>XXX
                   2173:       </p>
                   2174: <div class="itemizedlist"><ul type="disc">
                   2175: <li><p><code class="varname">PACKAGES</code>: The top level
                   2176:            directory for the binary packages. The default is
                   2177:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
                   2178: <li><p><code class="varname">WRKOBJDIR</code>:
                   2179:            The top level directory where, if defined, the separate
                   2180:            working directories will get created, and symbolically
                   2181:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   2182:            This is useful for building packages on several
                   2183:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2184:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   2185:            is local to every architecture. (It should be noted that
                   2186:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14      jmcneill 2187:            &mdash; it is an internal definition which refers to the
1.1       dsieger  2188:            root of the pkgsrc tree. It is possible to have many
                   2189:            pkgsrc tree instances.)</p></li>
                   2190: <li><p><code class="varname">LOCALPATCHES</code>:
                   2191:            Directory for local patches that aren't part of pkgsrc.
1.10      hubertf  2192:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
1.1       dsieger  2193:            information.</p></li>
                   2194: <li><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  2195:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  2196:            BSD-style Makefile. If this is not set,
                   2197:            <code class="varname">MAKECONF</code> is set to
                   2198:            <code class="filename">/dev/null</code> to avoid picking up
                   2199:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
                   2200: <li><p><code class="varname">DEPENDS_TARGET</code>:
                   2201:            By default, dependencies are only installed, and no binary
                   2202:            package is created for them. You can set this variable to
                   2203:            <code class="literal">package</code> to automatically create binary
                   2204:            packages after installing dependencies.</p></li>
                   2205: </ul></div>
                   2206: </div>
                   2207: <div class="sect1" lang="en">
                   2208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9       rillig   2209: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.4       rillig   2210: <p>A growing number of packages support installation into a
                   2211:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2212:     to be built, before the actual filesystem is touched. DESTDIR
                   2213:     support exists in two variations:</p>
                   2214: <div class="itemizedlist"><ul type="disc">
                   2215: <li><p>Basic DESTDIR support means that the package
                   2216:       installation and packaging is still run as
                   2217:       root.</p></li>
                   2218: <li><p>Full DESTDIR support can run the complete build,
                   2219:       installation and packaging as normal user. Root privileges are
                   2220:       only needed to add packages.</p></li>
                   2221: </ul></div>
                   2222: <p>To use the DESTDIR support, set either
                   2223:     <code class="varname">USE_DESTDIR=yes</code> to use the basic support for
                   2224:     packages that offer it or <code class="varname">USE_DESTDIR=full</code> to
                   2225:     get the full support with fallback to basic
                   2226:     support. <code class="varname">USE_DESTDIR=full</code> needs <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> version 20070802 (or
                   2227:     newer). It might become the default DESTDIR support later.</p>
                   2228: <p>DESTDIR support changes the behaviour of various targets
                   2229:     slightly. To install a package after building it, use
                   2230:     <code class="literal">package-install</code>. <code class="literal">package</code> and
                   2231:     <code class="literal">install</code> don't do that any
                   2232:     longer. <code class="literal">package-install</code> can be used as
                   2233:     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
                   2234:     will ask for the root password to install the package and fail,
                   2235:     <code class="literal">package-install</code> will ask again.</p>
                   2236: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2237:     clean</code></strong> needs to be run as root.</p>
1.17    ! imil     2238: <p>Considering the <code class="filename">foo/bar</code> package,
        !          2239:     DESTDIR full support can be tested using the following commands
        !          2240: 
        !          2241: </p>
        !          2242: <pre class="programlisting">
        !          2243: <code class="prompt">$</code> id
        !          2244: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
        !          2245: <code class="prompt">$</code> mkdir $HOME/packages
        !          2246: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
        !          2247: </pre>
        !          2248: <p>
        !          2249: 
        !          2250:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
        !          2251:     should be needed
        !          2252: 
        !          2253: </p>
        !          2254: <pre class="programlisting">
        !          2255: <code class="prompt">$</code> make USE_DESTDIR=full install
        !          2256: </pre>
        !          2257: <p>
        !          2258: 
        !          2259:     Create a package without root privileges
        !          2260: 
        !          2261: </p>
        !          2262: <pre class="programlisting">
        !          2263: <code class="prompt">$</code> make USE_DESTDIR=full PACKAGES=$HOME/packages package
        !          2264: </pre>
        !          2265: <p>
        !          2266: 
        !          2267:     For the following command, you must be able to gain root
        !          2268:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
        !          2269: 
        !          2270: </p>
        !          2271: <pre class="programlisting">
        !          2272: <code class="prompt">$</code> make USE_DESTDIR=full PACKAGES=$HOME/packages package-install
        !          2273: </pre>
        !          2274: <p>
        !          2275: 
        !          2276:     Then, as a simple user
        !          2277: 
        !          2278: </p>
        !          2279: <pre class="programlisting">
        !          2280: <code class="prompt">$</code> make clean
        !          2281: </pre>
        !          2282: <p>
        !          2283: 
        !          2284:     </p>
1.4       rillig   2285: </div>
                   2286: <div class="sect1" lang="en">
                   2287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2288: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.1       dsieger  2289: <div class="sect2" lang="en">
                   2290: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2291: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  2292: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2293:     overridden by setting the following variables in /etc/mk.conf:</p>
                   2294: <div class="variablelist"><dl>
                   2295: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2296: <dd>
                   2297: <p>This is a list of values specifying the chain of
                   2298:          compilers to invoke when building packages.  Valid values
                   2299:          are:</p>
                   2300: <div class="itemizedlist"><ul type="disc">
                   2301: <li><p><code class="varname">distcc</code>:
                   2302:            distributed C/C++ (chainable)</p></li>
                   2303: <li><p><code class="varname">ccache</code>:
                   2304:            compiler cache (chainable)</p></li>
                   2305: <li><p><code class="varname">gcc</code>:
                   2306:            GNU C/C++ Compiler</p></li>
                   2307: <li><p><code class="varname">mipspro</code>:
                   2308:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
                   2309: <li><p><code class="varname">mipspro</code>:
                   2310:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
                   2311: <li><p><code class="varname">sunpro</code>:
                   2312:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
                   2313: </ul></div>
                   2314: <p>The default is
                   2315:          &#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;.  You can use
                   2316:          <code class="varname">ccache</code> and/or
                   2317:          <code class="varname">distcc</code> with an appropriate
                   2318:          <code class="varname">PKGSRC_COMPILER</code> setting,
                   2319:          e.g. &#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;.  This
                   2320:          variable should always be terminated with a value for
                   2321:          a real compiler.  Note that only one real compiler
                   2322:          should be listed (e.g. &#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;
                   2323:          is not allowed).</p>
                   2324: </dd>
                   2325: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2326: <dd><p>This specifies the minimum version of GCC to use
                   2327:          when building packages.  If the system GCC doesn't
                   2328:          satisfy this requirement, then pkgsrc will build and
                   2329:          install one of the GCC packages to use instead.</p></dd>
                   2330: </dl></div>
                   2331: </div>
                   2332: <div class="sect2" lang="en">
                   2333: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2334: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1       dsieger  2335: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2336:        please make sure to use the <code class="literal">+=</code> operator
                   2337:        instead of the <code class="literal">=</code> operator:</p>
                   2338: <pre class="programlisting">
                   2339: CFLAGS+=        -your -flags
                   2340: </pre>
                   2341: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.16      jnemeth  2342:        &#8220;<span class="quote">+</span>&#8221;) may lead to problems with packages that
                   2343:        need to add their own flags.  You may want to take a look
                   2344:        at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
                   2345:        package if you're interested in optimization for the current
                   2346:        CPU.  Setting <code class="varname">USE_CPUFLAGS</code> to yes in
                   2347:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use cpuflags.</p>
1.1       dsieger  2348: </div>
                   2349: <div class="sect2" lang="en">
                   2350: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   2351: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1       dsieger  2352: <p>If you want to pass flags to the linker, both in the configure
                   2353: step and the build step, you can do this in two ways.  Either set
                   2354: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2355: between the two is that <code class="varname">LIBS</code> will be appended to
                   2356: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2357: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2358: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2359: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2360: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2361: settings, use the <code class="literal">+=</code> operator:</p>
                   2362: <pre class="programlisting">
                   2363: LDFLAGS+=        -your -linkerflags
                   2364: </pre>
                   2365: </div>
                   2366: </div>
                   2367: <div class="sect1" lang="en">
                   2368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2369: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.1       dsieger  2370: <p>XXX
                   2371:       </p>
                   2372: <div class="itemizedlist"><ul type="disc">
                   2373: <li>
                   2374: <p><code class="varname">PKG_DEVELOPER</code>:
                   2375:            Run some sanity checks that package developers want:
                   2376:            </p>
                   2377: <div class="itemizedlist"><ul type="circle">
                   2378: <li><p>make sure patches apply with zero
                   2379:              fuzz</p></li>
                   2380: <li><p>run check-shlibs to see that all
                   2381:              binaries will find their shared libs.</p></li>
                   2382: </ul></div>
                   2383: <p>
                   2384:        </p>
                   2385: </li>
                   2386: <li><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
                   2387:        of debugging output which is displayed whilst making and
                   2388:        installing the package.  The default value for this is 0,
                   2389:        which will not display the commands as they are executed
                   2390:        (normal, default, quiet operation); the value 1 will display
                   2391:        all shell commands before their invocation, and the value 2
                   2392:        will display both the shell commands before their invocation,
1.10      hubertf  2393:        and their actual execution progress with <span class="command"><strong>set
1.1       dsieger  2394:        -x</strong></span> will be displayed.</p></li>
                   2395: </ul></div>
                   2396: <p>
                   2397:     </p>
                   2398: </div>
                   2399: <div class="sect1" lang="en">
                   2400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   2401: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  2402: <p>Some packages have build time options, usually to select
                   2403:     between different dependencies, enable optional support for big
                   2404:     dependencies or enable experimental features.</p>
                   2405: <p>To see which options, if any, a package supports, and which
1.10      hubertf  2406:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  2407:     show-options</strong></span>, for example:</p>
                   2408: <pre class="programlisting">
                   2409:     The following options are supported by this package:
                   2410:         ssl      Enable SSL support.
                   2411:     Exactly one of the following gecko options is required:
                   2412:         firefox  Use firefox as gecko rendering engine.
                   2413:         mozilla  Use mozilla as gecko rendering engine.
                   2414:     At most one of the following database options may be selected:
                   2415:         mysql    Enable support for MySQL database.
                   2416:         pgsql    Enable support for PostgreSQL database.
                   2417: 
                   2418:     These options are enabled by default: firefox
                   2419:     These options are currently enabled: mozilla ssl
                   2420: </pre>
                   2421: <p>The following variables can be defined in
1.10      hubertf  2422:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  2423:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2424:     which can be used to select or disable options for all packages
                   2425:     that support them, and
                   2426:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2427:     which can be used to select or disable options specifically for
                   2428:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
                   2429:     these variables are selected, options preceded by &#8220;<span class="quote">-</span>&#8221;
                   2430:     are disabled. A few examples:</p>
                   2431: <pre class="screen">
1.10      hubertf  2432: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1       dsieger  2433: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2434: PKG_OPTIONS.kdebase=    debug -sasl
                   2435: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   2436: <p>It is important to note that options that were specifically
                   2437:     suggested by the package maintainer must be explicitely removed if
                   2438:     you do not wish to include the option.  If you are unsure you can view
                   2439:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger  2440: <p>The following settings are consulted in the order given, and
                   2441:     the last setting that selects or disables an option is
                   2442:     used:</p>
                   2443: <div class="orderedlist"><ol type="1">
                   2444: <li><p>the default options as suggested by the package
                   2445:       maintainer</p></li>
                   2446: <li><p>the options implied by the settings of legacy
                   2447:       variables (see below)</p></li>
                   2448: <li><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2449: <li><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
                   2450: </ol></div>
                   2451: <p>For groups of mutually exclusive options, the last option
                   2452:     selected is used, all others are automatically disabled.  If an
                   2453:     option of the group is explicitly disabled, the previously
                   2454:     selected option, if any, is used.  It is an error if no option
                   2455:     from a required group of options is selected, and building the
                   2456:     package will fail.</p>
                   2457: <p>Before the options framework was introduced, build options
                   2458:     were selected by setting a variable (often named
                   2459:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10      hubertf  2460:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  2461:     transition to the options framework for the user, these legacy
                   2462:     variables are converted to the appropriate options setting
                   2463:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2464:     automatically.  A warning is issued to prompt the user to update
1.10      hubertf  2465:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  2466:     directly.  Support for the legacy variables will be removed
                   2467:     eventually.</p>
                   2468: </div>
                   2469: </div>
                   2470: <div class="chapter" lang="en">
                   2471: <div class="titlepage"><div><div><h2 class="title">
                   2472: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2473: <div class="toc">
                   2474: <p><b>Table of Contents</b></p>
                   2475: <dl>
                   2476: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2477: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2478: </dl>
                   2479: </div>
                   2480: <div class="sect1" lang="en">
                   2481: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2482: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
                   2483: <p>Once you have built and installed a package, you can create
                   2484:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.10      hubertf  2485:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1       dsieger  2486:     the same package on a group of hosts and wasting CPU time. It also
                   2487:     provides a simple means for others to install your package, should
                   2488:     you distribute it.</p>
                   2489: <p>To create a binary package, change into the appropriate
1.10      hubertf  2490:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  2491:     package</strong></span>:</p>
                   2492: <pre class="screen">
                   2493: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2494: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2495:     </pre>
                   2496: <p>This will build and install your package (if not already done),
                   2497:     and then build a binary package from what was installed. You can
1.10      hubertf  2498:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2499:     it. Binary packages are created by default in
                   2500:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10      hubertf  2501:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.1       dsieger  2502:     continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.10      hubertf  2503: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1       dsieger  2504:     such a binary package.</p>
                   2505: </div>
                   2506: <div class="sect1" lang="en">
                   2507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2508: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10      hubertf  2509: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.6       rillig   2510: </div>
                   2511: </div>
                   2512: <div class="chapter" lang="en">
                   2513: <div class="titlepage"><div><div><h2 class="title">
                   2514: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2515: builds)</h2></div></div></div>
                   2516: <div class="toc">
                   2517: <p><b>Table of Contents</b></p>
                   2518: <dl>
                   2519: <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
                   2520: <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
                   2521: <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
                   2522: <dd><dl>
                   2523: <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
                   2524: <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
                   2525: <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
                   2526: <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
                   2527: <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
                   2528: <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
                   2529: <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
                   2530: <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
                   2531: </dl></dd>
                   2532: <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
1.15      rillig   2533: <dd><dl>
                   2534: <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
                   2535: <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
                   2536: </dl></dd>
1.6       rillig   2537: <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2538: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
                   2539: </dl>
                   2540: </div>
                   2541: <p>When you have multiple machines that should run the same packages,
                   2542: it is wasted time if they all build their packages themselves from
                   2543: source. There are two ways of getting a set of binary packages: The old
                   2544: bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
                   2545: system. This chapter describes how to set them up so that the packages
                   2546: are most likely to be usable later.</p>
                   2547: <div class="sect1" lang="en">
                   2548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2549: <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
                   2550: <p>Since a bulk build takes several days or even weeks to finish, you
                   2551: should think about the setup before you start everything. Pay attention
                   2552: to at least the following points:</p>
                   2553: <div class="itemizedlist"><ul type="disc">
                   2554: <li>
                   2555: <p>If you want to upload the binary packages to
                   2556: ftp.NetBSD.org, make sure the setup complies to the requirements for binary
                   2557: packages:</p>
                   2558: <div class="itemizedlist"><ul type="circle">
                   2559: <li><p>To end up on ftp.NetBSD.org, the packages must be built
                   2560: by a NetBSD developer on a trusted machine (that is, where you and only
                   2561: you have root access).</p></li>
                   2562: <li><p>Packages on ftp.NetBSD.org should only be created from
                   2563: the stable branches (like 2007Q1), so that users browsing the available
                   2564: collections can see at a glance how old the packages
                   2565: are.</p></li>
                   2566: <li><p>The packages must be built as root, since some packages
                   2567: require set-uid binaries at runtime, and creating those packages as
                   2568: unprivileged user doesn't work well at the moment.</p></li>
                   2569: </ul></div>
                   2570: </li>
                   2571: <li><p>Make sure that the bulk build cannot break anything in
                   2572: your system. Most bulk builds run as root, so they should be run at least
                   2573: in a chroot environment or something even more restrictive, depending on
                   2574: what the operating system provides. There have been numerous cases where
                   2575: certain packages tried to install files outside the
                   2576: <code class="filename">LOCALBASE</code> or wanted to edit some files in
                   2577: <code class="filename">/etc</code>. Furthermore, the bulk builds install and
                   2578: deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
                   2579: <code class="filename">LOCALBASE</code> is) during their operation, so be sure
                   2580: that you don't need any package during the build.</p></li>
                   2581: </ul></div>
                   2582: </div>
                   2583: <div class="sect1" lang="en">
                   2584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2585: <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
                   2586: <p>A complete bulk build requires lots of disk space. Some of the
                   2587: disk space can be read-only, some other must be writable. Some can be on
                   2588: remote filesystems (such as NFS) and some should be local. Some can be
                   2589: temporary filesystems, others must survive a sudden reboot.</p>
                   2590: <div class="itemizedlist"><ul type="disc">
                   2591: <li><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2592: <li><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2593: <li><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2594: <li><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
                   2595: <li><p>5 GB for the log files (read-write, remote, permanent)</p></li>
                   2596: <li><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2597: </ul></div>
1.1       dsieger  2598: </div>
                   2599: <div class="sect1" lang="en">
                   2600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2601: <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
1.15      rillig   2602: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2603: <h3 class="title">Note</h3>
                   2604: <p>There are two ways of doing a bulk build. The old-style
                   2605: one and the new-style &#8220;<span class="quote">pbulk</span>&#8221;. The latter is the recommended
                   2606: way.</p>
1.6       rillig   2607: </div>
1.1       dsieger  2608: <div class="sect2" lang="en">
                   2609: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2610: <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
1.1       dsieger  2611: <div class="sect3" lang="en">
                   2612: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2613: <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
1.1       dsieger  2614: </h4></div></div></div>
                   2615: <p>The <code class="filename">build.conf</code> file is the main
                   2616:        configuration file for bulk builds. You can configure how your
                   2617:        copy of pkgsrc is kept up to date, how the distfiles are
                   2618:        downloaded, how the packages are built and how the report is
                   2619:        generated. You can find an annotated example file in
                   2620:        <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
                   2621:        it, copy <code class="filename">build.conf-example</code> to
                   2622:        <code class="filename">build.conf</code> and edit it, following the
                   2623:        comments in that file.</p>
                   2624: </div>
                   2625: <div class="sect3" lang="en">
                   2626: <div class="titlepage"><div><div><h4 class="title">
1.10      hubertf  2627: <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.4       rillig   2628: </h4></div></div></div>
1.10      hubertf  2629: <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.1       dsieger  2630:        Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
                   2631:        details of the default settings. You will want to ensure that
                   2632:        <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
                   2633:        As used in this example, <code class="varname">_ACCEPTABLE=yes</code>
1.4       rillig   2634:        completely bypasses the license check.</p>
1.1       dsieger  2635: <pre class="programlisting">
                   2636: PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
                   2637: WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
                   2638: BSDSRCDIR=      /usr/src
                   2639: BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
                   2640: OBJHOSTNAME?=   yes               # use work.`hostname`
                   2641: FAILOVER_FETCH= yes               # insist on the correct checksum
                   2642: PKG_DEVELOPER?= yes
                   2643: _ACCEPTABLE=    yes
                   2644: </pre>
                   2645: <p>Some options that are especially useful for bulk builds
                   2646:        can be found at the top lines of the file
                   2647:        <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
                   2648:        options of these are briefly described here.</p>
                   2649: <div class="itemizedlist"><ul type="disc">
                   2650: <li><p>If you are on a slow machine, you may want to
                   2651:          set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
                   2652:          &#8220;<span class="quote">no</span>&#8221;.</p></li>
                   2653: <li><p>If you are doing bulk builds from a read-only
                   2654:          copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
                   2655:          to the directory where all log files are created. Otherwise the
                   2656:          log files are created in the pkgsrc directory.</p></li>
                   2657: <li><p>Another important variable is
                   2658:          <code class="varname">BULK_PREREQ</code>, which is a list of packages that
                   2659:          should be always available while building other
                   2660:          packages.</p></li>
                   2661: </ul></div>
                   2662: <p>Some other options are scattered in the pkgsrc
                   2663:        infrastructure:</p>
                   2664: <div class="itemizedlist"><ul type="disc">
                   2665: <li><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
                   2666:          should be set to <code class="literal">yes</code>. The purpose of the bulk
                   2667:          builds is creating binary packages, no matter if they are
                   2668:          vulnerable or not. When uploading the packages to a public
                   2669:          server, the vulnerable packages will be put into a directory of
                   2670:          their own. Leaving this variable unset would prevent the bulk
                   2671:          build system from even trying to build them, so possible
                   2672:          building errors would not show up.</p></li>
                   2673: <li><p><code class="varname">CHECK_FILES</code>
                   2674:          (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
                   2675:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed set of files
                   2676:          matches the <code class="filename">PLIST</code>.</p></li>
                   2677: <li><p><code class="varname">CHECK_INTERPRETER</code>
                   2678:          (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
                   2679:          &#8220;<span class="quote">yes</span>&#8221; to check that the installed
                   2680:          &#8220;<span class="quote">#!</span>&#8221;-scripts will find their
                   2681:          interpreter.</p></li>
                   2682: <li><p><code class="varname">PKGSRC_RUN_TEST</code> can be
                   2683:          set to &#8220;<span class="quote"><code class="literal">yes</code></span>&#8221; to run each
                   2684:          package's self-test before installing it. Note that some
                   2685:          packages make heavy use of &#8220;<span class="quote">good</span>&#8221; random
                   2686:          numbers, so you need to assure that the machine on which you
                   2687:          are doing the bulk builds is not completely idle. Otherwise
                   2688:          some test programs will seem to hang, while they are just
                   2689:          waiting for new random data to be
                   2690:          available.</p></li>
                   2691: </ul></div>
                   2692: </div>
                   2693: <div class="sect3" lang="en">
                   2694: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   2695: <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
1.1       dsieger  2696: </h4></div></div></div>
                   2697: <p>It is possible to configure the bulk build to perform
                   2698:        certain site-specific tasks at the end of the pre-build
                   2699:        stage.  If the file
                   2700:        <code class="filename">pre-build.local</code> exists in
                   2701:        <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
1.10      hubertf  2702:        (as a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a> script) at the end of the usual pre-build
1.1       dsieger  2703:        stage.  An example use of
                   2704:        <code class="filename">pre-build.local</code> is to have the line:</p>
                   2705: <pre class="screen">echo "I do not have enough disk space to build this pig." \
                   2706:        &gt; misc/openoffice/$BROKENF</pre>
                   2707: <p>to prevent the system from trying to build a particular package
                   2708:        which requires nearly 3 GB of disk space.</p>
                   2709: </div>
                   2710: </div>
                   2711: <div class="sect2" lang="en">
                   2712: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2713: <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
1.1       dsieger  2714: <p>As <code class="filename">/usr/pkg</code> will be completely
                   2715:       deleted at the start of bulk builds, make sure your login
                   2716:       shell is placed somewhere else. Either drop it into
                   2717:       <code class="filename">/usr/local/bin</code> (and adjust your login
                   2718:       shell in the passwd file), or (re-)install it via
1.10      hubertf  2719:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> from <code class="filename">/etc/rc.local</code>, so
1.1       dsieger  2720:       you can login after a reboot (remember that your current
                   2721:       process won't die if the package is removed, you just can't
                   2722:       start any new instances of the shell any more).  Also, if you
                   2723:       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
                   2724:       version of ssh for some reason, be sure to install ssh before
                   2725:       starting it from <code class="filename">rc.local</code>:</p>
                   2726: <pre class="programlisting">
                   2727: (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
                   2728: if [ -f /usr/pkg/etc/rc.d/sshd ]; then
                   2729:   /usr/pkg/etc/rc.d/sshd
                   2730: fi
                   2731: </pre>
                   2732: <p>Not doing so will result in you being not able to log in
                   2733:       via ssh after the bulk build is finished or if the machine
                   2734:       gets rebooted or crashes. You have been warned! :)</p>
                   2735: </div>
                   2736: <div class="sect2" lang="en">
                   2737: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2738: <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
1.1       dsieger  2739: <p>Make sure you don't need any of the packages still
                   2740:       installed.</p>
                   2741: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2742: <h3 class="title">Warning</h3>
                   2743: <p>During the bulk build, <span class="emphasis"><em>all packages, their
                   2744:        configuration files and some more files from
                   2745:        <code class="filename">/var</code>, <code class="filename">/home</code> and
                   2746:        possibly other locations will be removed! So don't run a bulk
                   2747:        build with privileges that might harm your
                   2748:        system.</em></span></p>
                   2749: </div>
                   2750: <p>Be sure to remove all other things that might
                   2751:       interfere with builds, like some libs installed in
                   2752:       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
                   2753: <pre class="screen">
                   2754: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2755: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
                   2756:       </pre>
                   2757: <p>If for some reason your last build didn't complete (power
                   2758:       failure, system panic, ...), you can continue it by
                   2759:       running:</p>
                   2760: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
                   2761: <p>At the end of the bulk build, you will get a summary via mail,
                   2762:       and find build logs in the directory specified by
                   2763:       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
                   2764:       file.</p>
                   2765: </div>
                   2766: <div class="sect2" lang="en">
                   2767: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2768: <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
1.1       dsieger  2769: <p>The bulk builds consist of three steps:</p>
                   2770: <div class="variablelist"><dl>
                   2771: <dt><span class="term">1. pre-build</span></dt>
                   2772: <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
                   2773:            cleans out any broken distfiles, and removes all
                   2774:            packages installed.</p></dd>
                   2775: <dt><span class="term">2. the bulk build</span></dt>
                   2776: <dd><p>This is basically &#8220;<span class="quote">make bulk-package</span>&#8221; with
                   2777:            an optimised order in which packages will be
                   2778:            built. Packages that don't require other packages will
                   2779:            be built first, and packages with many dependencies will
                   2780:            be built later.</p></dd>
                   2781: <dt><span class="term">3. post-build</span></dt>
                   2782: <dd><p>Generates a report that's placed in the directory
                   2783:            specified in the <code class="filename">build.conf</code> file
                   2784:            named <code class="filename">broken.html</code>, a short version
                   2785:            of that report will also be mailed to the build's
                   2786:            admin.</p></dd>
                   2787: </dl></div>
                   2788: <p>During the build, a list of broken packages will be compiled
                   2789:       in <code class="filename">/usr/pkgsrc/.broken</code> (or
                   2790:       <code class="filename">.../.broken.${MACHINE}</code> if
                   2791:       <code class="varname">OBJMACHINE</code> is set), individual build logs
                   2792:       of broken builds can be found in the package's
                   2793:       directory. These files are used by the bulk-targets to mark
                   2794:       broken builds to not waste time trying to rebuild them, and
                   2795:       they can be used to debug these broken package builds
                   2796:       later.</p>
                   2797: </div>
                   2798: <div class="sect2" lang="en">
                   2799: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2800: <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
1.1       dsieger  2801: <p>Currently, roughly the following requirements are valid for
                   2802:       NetBSD 2.0/i386:</p>
                   2803: <div class="itemizedlist"><ul type="disc">
                   2804: <li><p>10 GB - distfiles (NFS ok)</p></li>
                   2805: <li><p>8 GB - full set of all binaries (NFS ok)</p></li>
                   2806: <li><p>5 GB - temp space for compiling (local disk recommended)</p></li>
                   2807: </ul></div>
                   2808: <p>Note that all pkgs will be de-installed as soon as they are
                   2809:       turned into a binary package, and that sources are removed,
                   2810:       so there is no excessively huge demand to disk
                   2811:       space. Afterwards, if the package is needed again, it will
1.10      hubertf  2812:       be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> instead of building again, so
1.1       dsieger  2813:       there are no cycles wasted by recompiling.</p>
                   2814: </div>
                   2815: <div class="sect2" lang="en">
                   2816: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2817: <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
1.1       dsieger  2818: <p>If you don't want all the packages nuked from a machine
                   2819:       (rendering it useless for anything but pkg compiling), there
                   2820:       is the possibility of doing the package bulk build inside a
                   2821:       chroot environment.</p>
                   2822: <p>The first step is to set up a chroot sandbox,
                   2823:       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
                   2824:       using null mounts, or manually.</p>
                   2825: <p>There is a shell script called
                   2826:       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
                   2827:       up the sandbox environment using null mounts. It will also
                   2828:       create a script called <code class="filename">sandbox</code> in the
                   2829:       root of the sandbox environment, which will allow the null
1.10      hubertf  2830:       mounts to be activated using the <span class="command"><strong>sandbox
1.1       dsieger  2831:       mount</strong></span> command and deactivated using the
1.10      hubertf  2832:       <span class="command"><strong>sandbox umount</strong></span> command.</p>
1.1       dsieger  2833: <p>To set up a sandbox environment by hand, after extracting all
1.10      hubertf  2834:       the sets from a NetBSD installation or doing a <span class="command"><strong>make
1.1       dsieger  2835:       distribution DESTDIR=/usr/sandbox</strong></span> in
                   2836:       <code class="filename">/usr/src/etc</code>, be sure the following items
                   2837:       are present and properly configured:</p>
                   2838: <div class="procedure"><ol type="1">
                   2839: <li>
                   2840: <p>Kernel</p>
                   2841: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
                   2842: </li>
                   2843: <li>
                   2844: <p><code class="filename">/dev/*</code></p>
                   2845: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
                   2846: </li>
                   2847: <li>
                   2848: <p><code class="filename">/etc/resolv.conf</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a> and mail):</p>
                   2849: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
                   2850: </li>
                   2851: <li>
                   2852: <p>Working(!) mail config (hostname, sendmail.cf):</p>
                   2853: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
                   2854: </li>
                   2855: <li>
                   2856: <p><code class="filename">/etc/localtime</code> (for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/smtpd/README.html" target="_top"><code class="filename">security/smtpd</code></a>):</p>
                   2857: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
                   2858: </li>
                   2859: <li>
                   2860: <p><code class="filename">/usr/src</code> (system sources,
1.14      jmcneill 2861:          e.&nbsp;g. for <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/aperture/README.html" target="_top"><code class="filename">sysutils/aperture</code></a>):</p>
1.1       dsieger  2862: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
                   2863:          <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
                   2864: </li>
                   2865: <li>
                   2866: <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
                   2867: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
                   2868: </li>
                   2869: <li>
                   2870: <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
                   2871: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
                   2872: </li>
                   2873: <li>
                   2874: <p>Checkout pkgsrc via cvs into
                   2875:          <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
                   2876: <pre class="screen">
                   2877: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
                   2878: <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
                   2879:          </pre>
                   2880: <p>Do not mount/link this to the copy of your pkgsrc tree
                   2881:          you do development in, as this will likely cause problems!</p>
                   2882: </li>
                   2883: <li><p>Make
                   2884:          <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
                   2885:          <code class="filename">.../distfiles</code> point somewhere
                   2886:          appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
1.15      rillig   2887: <li><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. ???">Section 7.3.1.2, &#8220;???&#8221;</a>.</p></li>
1.1       dsieger  2888: <li><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
                   2889: </ol></div>
                   2890: <p>When the chroot sandbox is set up, you can start
                   2891:       the build with the following steps:</p>
                   2892: <pre class="screen">
                   2893: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2894: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
                   2895:       </pre>
                   2896: <p>This will just jump inside the sandbox and start building.  At
                   2897:        the end of the build, mail will be sent with the results of
                   2898:        the build. Created binary pkgs will be in
                   2899:        <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
                   2900:       (wherever that points/mounts to/from).</p>
                   2901: </div>
                   2902: <div class="sect2" lang="en">
                   2903: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2904: <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
1.1       dsieger  2905: <p>In addition to building a complete set of all packages in
                   2906:       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
                   2907:       may be used to build a subset of the packages contained in
                   2908:       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
1.10      hubertf  2909:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
1.1       dsieger  2910: <div class="itemizedlist"><ul type="disc">
                   2911: <li><p>SITE_SPECIFIC_PKGS</p></li>
                   2912: <li><p>HOST_SPECIFIC_PKGS</p></li>
                   2913: <li><p>GROUP_SPECIFIC_PKGS</p></li>
                   2914: <li><p>USER_SPECIFIC_PKGS</p></li>
                   2915: </ul></div>
                   2916: <p>will define the set of packages which should be built.
                   2917:       The bulk build code will also include any packages which are
                   2918:       needed as dependencies for the explicitly listed packages.</p>
                   2919: <p>One use of this is to do a bulk build with
                   2920:       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
                   2921:       periodically to have a complete set of the binary packages
                   2922:       needed for your site available without the overhead of
                   2923:       building extra packages that are not needed.</p>
                   2924: </div>
                   2925: <div class="sect2" lang="en">
                   2926: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   2927: <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
1.1       dsieger  2928: <p>This section describes how pkgsrc developers can upload binary
                   2929:       pkgs built by bulk builds to ftp.NetBSD.org.</p>
                   2930: <p>If you would like to automatically create checksum files for the
                   2931:       binary packages you intend to upload, remember to set
                   2932:       <code class="varname">MKSUMS=yes</code> in your
                   2933:       <code class="filename">mk/bulk/build.conf</code>.</p>
                   2934: <p>If you would like to PGP sign the checksum files (highly
                   2935:       recommended!), remember to set
                   2936:       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
                   2937:       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
                   2938:       your GPG password to sign the files before uploading everything.</p>
                   2939: <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
                   2940:       set properly in your <code class="filename">mk/bulk/build.conf</code>
                   2941:       file, i.e. adjust it to something like one of the following:</p>
                   2942: <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload </pre>
                   2943: <p>Please use appropriate values for "packages-200xQy",
                   2944:       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
                   2945:       is different from your local login, write your login directly
                   2946:       into the variable, e.g. my local account is "feyrer", but for my
                   2947:       login "hubertf", I use:</p>
                   2948: <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</pre>
                   2949: <p>A separate <code class="filename">upload</code> directory is used
                   2950:       here to allow "closing" the directory during upload. To do
                   2951:       so, run the following command on ftp.NetBSD.org next:</p>
                   2952: <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
                   2953: <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
                   2954:       only appropriate for packages for the NetBSD operating
                   2955:       system. Binary packages for other operating systems should go
                   2956:       into <code class="filename">/pub/pkgsrc</code>.</p>
                   2957: <p>Before uploading the binary pkgs, ssh authentication needs
                   2958:       to be set up. This example shows how to set up temporary keys
                   2959:       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
                   2960:       (assuming that no keys should be present there usually):</p>
                   2961: <pre class="screen">
                   2962: <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
                   2963: chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
                   2964: chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
                   2965: chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
                   2966:       </pre>
                   2967: <p>Now take the output of <code class="filename">id-dsa.pub</code> and
                   2968:       append it to your <code class="filename">~/.ssh/authorized_keys</code>
                   2969:       file on ftp.NetBSD.org. You can remove the key after the
                   2970:       upload is done!</p>
                   2971: <p>Next, test if your ssh connection really works:</p>
                   2972: <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
                   2973: <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
                   2974: <p>Now after all this works, you can exit the sandbox and start
                   2975:       the upload:</p>
                   2976: <pre class="screen">
                   2977: chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
                   2978: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
                   2979: <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
                   2980:       </pre>
1.10      hubertf  2981: <p>The upload process may take quite some time. Use <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ls+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ls</span>(1)</span></a> or
                   2982:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?du+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">du</span>(1)</span></a> on the FTP server to monitor progress of the
1.1       dsieger  2983:       upload. The upload script will take care of not uploading
                   2984:       restricted packages and putting vulnerable packages into the
                   2985:       <code class="filename">vulnerable</code> subdirectory.</p>
                   2986: <p>After the upload has ended, first thing is to revoke ssh access:</p>
                   2987: <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
                   2988:       Gdd:x! </pre>
                   2989: <p>Use whatever is needed to remove the key you've entered
                   2990:       before! Last, move the uploaded packages out of the
                   2991:       <code class="filename">upload</code> directory to have them accessible
                   2992:       to everyone:</p>
                   2993: <pre class="screen">
                   2994: nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-200xQy/NetBSD-a.b.c/arch</code></strong>
                   2995: nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
                   2996: nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
                   2997: nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
                   2998:       </pre>
                   2999: </div>
                   3000: </div>
                   3001: <div class="sect1" lang="en">
                   3002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3003: <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
1.15      rillig   3004: <p>Running a pbulk-style bulk build works roughly as follows:</p>
                   3005: <div class="itemizedlist"><ul type="disc">
                   3006: <li><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   3007: <li><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
                   3008: </ul></div>
                   3009: <div class="sect2" lang="en">
                   3010: <div class="titlepage"><div><div><h3 class="title">
                   3011: <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
                   3012: <p>First, you need to create a pkgsrc installation for the pbulk infrastructure. No matter on which platform you are (even on NetBSD), you should bootstrap into its own directory. Let's take the directory <code class="filename">/usr/pbulk</code> or <code class="filename">$HOME/pbulk</code> for it. This installation will be bootstrapped and all the tools that are required for the bulk build will be installed there.</p>
                   3013: <pre class="screen">
                   3014: $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3015: $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
                   3016: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
                   3017: </pre>
                   3018: <p>Now the basic environment for the pbulk infrastructure is installed. The specific tools are still missing. This is a good time to edit the pkgsrc configuration file <code class="filename">/usr/pbulk/etc/mk.conf</code> to fit your needs. Typical things you might set now are:</p>
                   3019: <div class="itemizedlist"><ul type="disc">
                   3020: <li><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
                   3021: <li><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
                   3022: <li><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
                   3023: <li><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
                   3024: <li><p><code class="literal"><code class="varname">_ACCEPTABLE</code>=yes</code>, to accept all licenses, no matter how restrictive they are.</p></li>
                   3025: </ul></div>
                   3026: <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
                   3027: <pre class="screen">
                   3028: $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
                   3029: $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
                   3030: $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
                   3031: </pre>
                   3032: <p>Now the pbulk infrastructure is built and installed. It still needs to be configured, and after some more preparation, we will be able to start the real bulk build.</p>
                   3033: </div>
1.6       rillig   3034: <div class="sect2" lang="en">
                   3035: <div class="titlepage"><div><div><h3 class="title">
1.15      rillig   3036: <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
1.14      jmcneill 3037: <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
1.15      rillig   3038: <p>TODO: continue writing</p>
1.6       rillig   3039: </div>
                   3040: </div>
                   3041: <div class="sect1" lang="en">
                   3042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3043: <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  3044: <p>After your pkgsrc bulk-build has completed, you may wish to
                   3045:     create a CD-ROM set of the resulting binary packages to assist
                   3046:     in installing packages on other machines.  The
                   3047:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
                   3048:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  3049:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  3050:     way that keeps all the dependencies for a given package on the same
                   3051:     CD as that package.</p>
                   3052: <div class="sect2" lang="en">
                   3053: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3054: <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  3055: <p>Complete documentation for cdpack is found in the cdpack(1)
                   3056:       man page. The following short example assumes that the binary
                   3057:       packages are left in
                   3058:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   3059:       sufficient disk space exists in <code class="filename">/u2</code> to
                   3060:       hold the ISO 9660 images.</p>
                   3061: <pre class="screen">
                   3062: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   3063: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   3064: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   3065:       </pre>
                   3066: <p>If you wish to include a common set of files
                   3067:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   3068:       etc.) on each CD in the collection, then you need to create a
                   3069:       directory which contains these files. e.g.</p>
                   3070: <pre class="screen">
                   3071: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   3072: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   3073: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   3074: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   3075: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   3076: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   3077: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   3078:       </pre>
                   3079: <p>Now create the images:</p>
                   3080: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   3081: <p>Each image will contain <code class="filename">README</code>,
                   3082:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   3083:       in their root directories.</p>
                   3084: </div>
                   3085: </div>
                   3086: </div>
                   3087: <div class="chapter" lang="en">
                   3088: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3089: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  3090: <div class="toc">
                   3091: <p><b>Table of Contents</b></p>
                   3092: <dl>
1.15      rillig   3093: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in ${LOCALBASE}</a></span></dt>
                   3094: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in ${VARBASE}</a></span></dt>
1.1       dsieger  3095: </dl>
                   3096: </div>
                   3097: <p>The files that are installed by pkgsrc are organized in a way that
                   3098: is similar to what you find in the <code class="filename">/usr</code> directory
                   3099: of the base system. But some details are different. This is because
                   3100: pkgsrc initially came from FreeBSD and had adopted its file system
                   3101: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   3102: which operating system you are using pkgsrc with, you can expect the
                   3103: same layout for pkgsrc.</p>
                   3104: <p>There are mainly four root directories for pkgsrc, which are all
                   3105: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   3106: When pkgsrc has been installed as root, the default locations
                   3107: are:</p>
                   3108: <pre class="programlisting">
                   3109: LOCALBASE=              /usr/pkg
                   3110: PKG_SYSCONFBASE=        /usr/pkg/etc
                   3111: VARBASE=                /var
                   3112: PKG_DBDIR=              /var/db/pkg
                   3113: </pre>
                   3114: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   3115: user), the default locations are:</p>
                   3116: <pre class="programlisting">
                   3117: LOCALBASE=              ${HOME}/pkg
                   3118: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   3119: VARBASE=                ${HOME}/pkg/var
                   3120: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
                   3121: </pre>
                   3122: <p>What these four directories are for, and what they look like is
                   3123: explained below.</p>
                   3124: <div class="itemizedlist"><ul type="disc">
                   3125: <li><p><code class="varname">LOCALBASE</code> corresponds to the
                   3126: <code class="filename">/usr</code> directory in the base system. It is the
                   3127: &#8220;<span class="quote">main</span>&#8221; directory where the files are installed and contains
                   3128: the well-known subdirectories like <code class="filename">bin</code>,
                   3129: <code class="filename">include</code>, <code class="filename">lib</code>,
                   3130: <code class="filename">share</code> and
                   3131: <code class="filename">sbin</code>.</p></li>
                   3132: <li><p><code class="varname">VARBASE</code> corresponds to
                   3133: <code class="filename">/var</code> in the base system. Some programs (especially
                   3134: games, network daemons) need write access to it during normal
                   3135: operation.</p></li>
                   3136: <li><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
                   3137: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      hubertf  3138: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  3139: itself.</p></li>
                   3140: </ul></div>
                   3141: <div class="sect1" lang="en">
                   3142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3143: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  3144: </h2></div></div></div>
                   3145: <p>The following directories exist in a typical pkgsrc installation
                   3146: in <code class="filename">${LOCALBASE}</code>.</p>
                   3147: <div class="variablelist"><dl>
                   3148: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   3149: <dd><p>Contains executable programs that are intended to be
                   3150: directly used by the end user.</p></dd>
                   3151: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   3152: <dd><p>Contains files for the emulation layers of various other
                   3153: operating systems, especially for
                   3154: NetBSD.</p></dd>
                   3155: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   3156: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   3157: <dd><p>Contains
                   3158: the configuration files.</p></dd>
                   3159: <dt><span class="term"><code class="filename">include</code></span></dt>
                   3160: <dd><p>Contains headers for the C and C++ programming
                   3161: languages.</p></dd>
                   3162: <dt><span class="term"><code class="filename">info</code></span></dt>
                   3163: <dd><p>Contains GNU info files of various
                   3164: packages.</p></dd>
                   3165: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   3166: <dd><p>Contains shared and static
                   3167: libraries.</p></dd>
                   3168: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   3169: <dd><p>Contains data files that don't change after
                   3170: installation. Other data files belong into
                   3171: <code class="filename">${VARBASE}</code>.</p></dd>
                   3172: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   3173: <dd><p>Contains programs that are not intended to be used by
                   3174: end users, such as helper programs or network
                   3175: daemons.</p></dd>
                   3176: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   3177: <dd><p>Contains programs that are intended to be executed as
                   3178: CGI scripts by a web server.</p></dd>
                   3179: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   3180: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   3181: <dd><p>Contains brief
                   3182: documentation in form of manual pages.</p></dd>
                   3183: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   3184: <dd><p>Contains programs that are intended to be used only by
                   3185: the super-user.</p></dd>
                   3186: <dt><span class="term"><code class="filename">share</code></span></dt>
                   3187: <dd><p>Contains platform-independent data files that don't
                   3188: change after installation.</p></dd>
                   3189: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   3190: <dd><p>Contains documentation files provided by the
                   3191: packages.</p></dd>
                   3192: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   3193: <dd><p>Contains example files provided by the packages. Among
                   3194: others, the original configuration files are saved here and copied to
                   3195: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   3196: installation.</p></dd>
                   3197: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   3198: <dd><p>Contains the original files for rc.d
                   3199: scripts.</p></dd>
                   3200: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   3201: <code class="filename">${VARBASE}</code>)</span></dt>
                   3202: <dd><p>Contains files
                   3203: that may be modified after
                   3204: installation.</p></dd>
                   3205: </dl></div>
                   3206: </div>
                   3207: <div class="sect1" lang="en">
                   3208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3209: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  3210: </h2></div></div></div>
                   3211: <div class="variablelist"><dl>
                   3212: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   3213: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   3214: <dd><p>Contains
                   3215: information about the currently installed
                   3216: packages.</p></dd>
                   3217: <dt><span class="term"><code class="filename">games</code></span></dt>
                   3218: <dd><p>Contains highscore
                   3219: files.</p></dd>
                   3220: <dt><span class="term"><code class="filename">log</code></span></dt>
                   3221: <dd><p>Contains log files.</p></dd>
                   3222: <dt><span class="term"><code class="filename">run</code></span></dt>
                   3223: <dd><p>Contains informational files about daemons that are
                   3224: currently running.</p></dd>
                   3225: </dl></div>
                   3226: </div>
                   3227: </div>
                   3228: <div class="chapter" lang="en">
                   3229: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3230: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  3231: <div class="toc">
                   3232: <p><b>Table of Contents</b></p>
                   3233: <dl>
1.6       rillig   3234: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   3235: <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
                   3236: <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
                   3237: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
                   3238: <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
                   3239: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                   3240: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
1.15      rillig   3241: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell make fetch to do passive FTP?</a></span></dt>
1.6       rillig   3242: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
1.15      rillig   3243: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does Don't know how to make
                   3244: /usr/share/tmac/tmac.andoc mean?</a></span></dt>
                   3245: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does Could not find bsd.own.mk mean?</a></span></dt>
1.6       rillig   3246: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   3247: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   3248: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
1.15      rillig   3249: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my CFLAGS?</a></span></dt>
1.6       rillig   3250: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
1.15      rillig   3251: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does Makefile appears to contain unresolved cvs/rcs/??? merge conflicts mean?</a></span></dt>
1.1       dsieger  3252: </dl>
                   3253: </div>
                   3254: <p>This section contains hints, tips &amp; tricks on special things in
                   3255: pkgsrc that we didn't find a better place for in the previous chapters, and
                   3256: it contains items for both pkgsrc users and developers.</p>
                   3257: <div class="sect1" lang="en">
                   3258: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3259: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  3260: <p>The following mailing lists may be of interest to pkgsrc users:</p>
                   3261: <div class="itemizedlist"><ul type="disc">
1.10      hubertf  3262: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1       dsieger  3263:          This is a general purpose list for most issues regarding
                   3264:          pkgsrc, regardless of platform, e.g. soliciting user help
                   3265:          for pkgsrc configuration, unexpected build failures, using
                   3266:          particular packages, upgrading pkgsrc installations,
                   3267:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   3268:          proposals for changes that impact the pkgsrc user community,
                   3269:          e.g. major infrastructure changes, new features, package
                   3270:          removals, etc., may also be posted.</p></li>
1.10      hubertf  3271: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1       dsieger  3272:          A list where the results of pkgsrc bulk builds are sent and
                   3273:          discussed.</p></li>
1.10      hubertf  3274: <li><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1       dsieger  3275:          This list is for those who are interested in getting a
                   3276:          commit message for every change committed to pkgsrc. It is
                   3277:          also available in digest form, meaning one daily message
                   3278:          containing all commit messages for changes to the package
                   3279:          source tree in that 24 hour period.</p></li>
                   3280: </ul></div>
                   3281: <p>To subscribe, do:</p>
                   3282: <pre class="programlisting">
                   3283: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   3284: </pre>
                   3285: <p>Archives for all these mailing lists are available from
1.10      hubertf  3286: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  3287: </div>
                   3288: <div class="sect1" lang="en">
                   3289: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3290: <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
1.1       dsieger  3291: <p>Pkgviews is tightly integrated with buildlink.  You can find a
                   3292: pkgviews User's guide in
                   3293: <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
                   3294: </div>
                   3295: <div class="sect1" lang="en">
                   3296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3297: <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  3298: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   3299: a number of useful utilities for both users and developers of pkgsrc.  This
                   3300: section attempts only to make the reader aware of the utilities and when
                   3301: they might be useful, and not to duplicate the documentation that comes
                   3302: with each package.</p>
                   3303: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
                   3304: <div class="itemizedlist"><ul type="disc"><li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
                   3305:       Symlinks for use by buildlink.</p></li></ul></div>
                   3306: <p>OS tool augmentation (automatically installed when needed):</p>
                   3307: <div class="itemizedlist"><ul type="disc">
                   3308: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
                   3309:       Calculates various kinds of checksums (including SHA1).</p></li>
                   3310: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
                   3311:       Compatibility library for pkgsrc tools.</p></li>
                   3312: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
                   3313:       non-BSD systems due to lack of native mtree.</p></li>
                   3314: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
                   3315:       Up-to-date replacement for
                   3316:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   3317:       systems where pkg_install is not present.</p></li>
                   3318: </ul></div>
                   3319: <p>Utilities used by pkgsrc (not automatically installed):</p>
                   3320: <div class="itemizedlist"><ul type="disc">
                   3321: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
                   3322:       Create a binary package from an
1.10      hubertf  3323:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  3324:       save the old package.</p></li>
                   3325: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
                   3326:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   3327:       from multiple locations. It currently supports the following
                   3328:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
                   3329: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
                   3330:       packages someplace else (enabled by default).</p></li>
1.16      jnemeth  3331: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
                   3332:       the best compiler flags to optimise code for your current
                   3333:       CPU and compiler. Setting <code class="varname">USE_CPUFLAGS</code> to
                   3334:       yes in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> will cause pkgsrc to automatically use
                   3335:       cpuflags. </p></li>
1.1       dsieger  3336: </ul></div>
                   3337: <p>Utilities for keeping track of installed packages, being up to date,
                   3338: etc:</p>
                   3339: <div class="itemizedlist"><ul type="disc">
                   3340: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
                   3341:       packages whose installed versions do not match the latest pkgsrc
                   3342:       entries.</p></li>
                   3343: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
                   3344:       dependency graphs of packages, to aid in choosing a strategy for
                   3345:       updating.</p></li>
                   3346: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   3347:       graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   3348: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12      weinem   3349:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
                   3350: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1       dsieger  3351:       does various checks on the complete pkgsrc system.</p></li>
                   3352: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
                   3353:       packages you have installed.</p></li>
                   3354: </ul></div>
                   3355: <p>Utilities for people maintaining or creating individual packages:</p>
                   3356: <div class="itemizedlist"><ul type="disc">
                   3357: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
                   3358:       making and maintaining patches for a package (includes pkgdiff,
                   3359:       pkgvi, mkpatches, etc.).</p></li>
                   3360: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
                   3361:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
                   3362:       converting to pkgsrc.</p></li>
                   3363: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
                   3364:       pkgsrc to a Solaris package.</p></li>
                   3365: </ul></div>
                   3366: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   3367: utilities)</p>
                   3368: <div class="itemizedlist"><ul type="disc">
                   3369: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
                   3370:       packages in a chrooted area.</p></li>
                   3371: <li><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
                   3372:       kernel version for chrooted cross builds.</p></li>
                   3373: </ul></div>
                   3374: </div>
                   3375: <div class="sect1" lang="en">
                   3376: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3377: <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
1.1       dsieger  3378: <p>If you want to use pkgsrc as non-root user, you can set some
                   3379: variables to make pkgsrc work under these conditions.  At the very least,
                   3380: you need to set <code class="varname">UNPRIVILEGED</code> to &#8220;<span class="quote">yes</span>&#8221;; this
                   3381: will turn on unprivileged mode and set multiple related variables to allow
                   3382: installation of packages as non-root.</p>
                   3383: <p>In case the defaults are not enough, you may want to tune some other
                   3384: variables used.  For example, if the automatic user/group detection leads
                   3385: to incorrect values (or not the ones you would like to use), you can change
                   3386: them by setting <code class="varname">UNPRIVILEGED_USER</code> and
                   3387: <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
                   3388: <p>As regards bootstrapping, please note that the
1.10      hubertf  3389: <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
1.1       dsieger  3390: given the &#8220;<span class="quote">--ignore-user-check</span>&#8221; flag, as it will choose and
                   3391: use multiple default directories under <code class="filename">~/pkg</code> as the
                   3392: installation targets.  These directories can be overridden by the
                   3393: &#8220;<span class="quote">--prefix</span>&#8221; flag provided by the script, as well as some others
                   3394: that allow finer tuning of the tree layout.</p>
                   3395: </div>
                   3396: <div class="sect1" lang="en">
                   3397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3398: <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  3399: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3400: enable this feature by adding the option
                   3401: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10      hubertf  3402: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  3403: distfile is found, pkgsrc will try to resume it.</p>
                   3404: <p>You can also
1.10      hubertf  3405: use a different program than the default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> by changing the
1.16      jnemeth  3406: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3407: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3408: by using the value manual.  A value of custom disables the system defaults
                   3409: and dependency tracking for the fetch program.  In that case you have to
                   3410: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3411: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3412: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1       dsieger  3413: <p>For example, if you want to use
1.16      jnemeth  3414: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  3415: like:</p>
                   3416: <pre class="programlisting">
1.16      jnemeth  3417: FETCH_USING=   wget
1.1       dsieger  3418: </pre>
                   3419: </div>
                   3420: <div class="sect1" lang="en">
                   3421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3422: <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4       rillig   3423: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  3424: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   3425: you will have to add the following line into
1.10      hubertf  3426: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  3427: <pre class="programlisting">
1.4       rillig   3428: X11_TYPE=modular
1.1       dsieger  3429: </pre>
                   3430: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   3431: <h3 class="title">Note</h3>
1.4       rillig   3432: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3433: </p>
1.1       dsieger  3434: </div>
                   3435: </div>
                   3436: <div class="sect1" lang="en">
                   3437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3438: <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  3439: <p>If you are sitting behind a firewall which does not allow direct
                   3440: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3441: relevant proxy hosts.  This is done using an environment variable in the
                   3442: form of a URL, e.g. in Amdahl, the machine
                   3443: &#8220;<span class="quote">orpheus.amdahl.com</span>&#8221; is one of the firewalls, and it uses
                   3444: port 80 as the proxy port number.  So the proxy environment variables
                   3445: are:</p>
                   3446: <pre class="programlisting">
                   3447: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3448: http_proxy=http://orpheus.amdahl.com:80/
                   3449: </pre>
                   3450: </div>
                   3451: <div class="sect1" lang="en">
                   3452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  3453: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1       dsieger  3454: <p>This depends on which utility is used to retrieve distfiles.  From
                   3455: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   3456: the first available command from the following list:</p>
                   3457: <div class="itemizedlist"><ul type="disc">
                   3458: <li><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3459: <li><p><code class="filename">/usr/bin/ftp</code></p></li>
                   3460: </ul></div>
                   3461: <p>On a default NetBSD installation, this will be
                   3462: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   3463: connections first, and falls back to active connections if the server
                   3464: refuses to do passive.  For the other tools, add the following to your
1.10      hubertf  3465: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  3466: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3467: <p>Having that option present will prevent
                   3468: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   3469: transfers.</p>
                   3470: </div>
                   3471: <div class="sect1" lang="en">
                   3472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3473: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  3474: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  3475: from work or university, where you can't run a <span class="command"><strong>make
                   3476: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1       dsieger  3477: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  3478: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  3479: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   3480: resulting list to your machine at work/school and use it there.  If you
1.10      hubertf  3481: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1       dsieger  3482: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3483: URL:</p>
                   3484: <p>At home:</p>
                   3485: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3486: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3487: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3488: <p>At work:</p>
                   3489: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   3490: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   3491: home.</p>
                   3492: <p>If you have a machine running NetBSD, and you want to get
                   3493: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3494: machine architecture), you can do so by using the above-mentioned
1.10      hubertf  3495: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  3496: directly by running:</p>
                   3497: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3498: <p>If you even decide to ignore
                   3499: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3500: by running:</p>
                   3501: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3502: </div>
                   3503: <div class="sect1" lang="en">
                   3504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3505: <a name="tmac.andoc-missing"></a>9.10. What does &#8220;<span class="quote">Don't know how to make
1.1       dsieger  3506: /usr/share/tmac/tmac.andoc</span>&#8221; mean?</h2></div></div></div>
                   3507: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
                   3508: package, you get the error from make that it doesn't know how to make
                   3509: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
                   3510: you don't have installed the &#8220;<span class="quote">text</span>&#8221; set (nroff, ...) from
                   3511: the NetBSD base distribution on your machine.  It is recommended to do
                   3512: that to format man pages.</p>
                   3513: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
                   3514: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  3515: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  3516: </div>
                   3517: <div class="sect1" lang="en">
                   3518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3519: <a name="bsd.own.mk-missing"></a>9.11. What does &#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221; mean?</h2></div></div></div>
1.1       dsieger  3520: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   3521: when you installed your NetBSD machine.  Please get and install it, by
                   3522: extracting it in <code class="filename">/</code>:</p>
                   3523: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3524: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   3525: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  3526: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  3527: -r</strong></span>).</p>
                   3528: </div>
                   3529: <div class="sect1" lang="en">
                   3530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3531: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  3532: <p>When installing packages as non-root user and using the just-in-time
1.10      hubertf  3533: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.1       dsieger  3534: password for each required package installed.  To avoid this, the sudo
                   3535: package can be used, which does password caching over a limited time.  To
                   3536: use it, install sudo (either as binary package or from
                   3537: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10      hubertf  3538: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  3539: <span class="emphasis"><em>after</em></span> the definition of the
                   3540: <code class="varname">LOCALBASE</code> variable:</p>
                   3541: <pre class="programlisting">
                   3542: .if exists(${LOCALBASE}/bin/sudo)
                   3543: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3544: .endif
                   3545: </pre>
                   3546: </div>
                   3547: <div class="sect1" lang="en">
                   3548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3549: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  3550: <p>As the system administrator, you can choose where configuration files
                   3551: are installed.  The default settings make all these files go into
                   3552: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   3553: be suboptimal depending on your expectations (e.g., a read-only,
                   3554: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3555: configuration of the provided packages).</p>
                   3556: <p>In order to change the defaults, you can modify the
                   3557: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10      hubertf  3558: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  3559: directory; some common examples include <code class="filename">/etc</code> or
                   3560: <code class="filename">/etc/pkg</code>.</p>
                   3561: <p>Furthermore, you can change this value on a per-package basis by
                   3562: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3563: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3564: package you would like to modify, that is, the contents of
                   3565: <code class="varname">PKGBASE</code>.</p>
                   3566: <p>Note that after changing these settings, you must rebuild and
                   3567: reinstall any affected packages.</p>
                   3568: </div>
                   3569: <div class="sect1" lang="en">
                   3570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3571: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1       dsieger  3572: <p>Please be aware that there can often be bugs in third-party software,
                   3573: and some of these bugs can leave a machine vulnerable to exploitation by
                   3574: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3575: maintains a database of known-exploits to packages which have at one time
                   3576: been included in pkgsrc.  The database can be downloaded automatically, and
                   3577: a security audit of all packages installed on a system can take place.  To
1.14      jmcneill 3578: do this, refer to the following two tools (installed as part of the
                   3579: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.1       dsieger  3580: <div class="orderedlist"><ol type="1">
                   3581: <li>
1.10      hubertf  3582: <p><span class="command"><strong>download-vulnerability-list</strong></span>, an easy way to
1.1       dsieger  3583:     download a list of the security vulnerabilities information.  This list
                   3584:     is kept up to date by the NetBSD security officer and the NetBSD
                   3585:     packages team, and is distributed from the NetBSD ftp server:</p>
1.10      hubertf  3586: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/pkg-vulnerabilities</a></p>
1.1       dsieger  3587: </li>
1.10      hubertf  3588: <li><p><span class="command"><strong>audit-packages</strong></span>, an easy way to audit the
1.1       dsieger  3589:     current machine, checking each vulnerability which is known.  If a
                   3590:     vulnerable package is installed, it will be shown by output to stdout,
                   3591:     including a description of the type of vulnerability, and a URL
                   3592:     containing more information.</p></li>
                   3593: </ol></div>
1.14      jmcneill 3594: <p>Use of these tools is strongly recommended!  After
                   3595: &#8220;<span class="quote">pkg_install</span>&#8221; is installed, please read
1.1       dsieger  3596: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.14      jmcneill 3597: pkg_install</code></strong>.</p>
1.1       dsieger  3598: <p>If this package is installed, pkgsrc builds will use it to
1.10      hubertf  3599: perform a security check before building any package.  See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, &#8220;Variables affecting the build process&#8221;</a> for ways to control this
1.1       dsieger  3600: check.</p>
                   3601: </div>
                   3602: <div class="sect1" lang="en">
                   3603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3604: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1       dsieger  3605: <p>When you add your own preferences to the
                   3606:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  3607:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  3608:        environment variables to the <code class="filename">./configure</code>
1.10      hubertf  3609:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1       dsieger  3610:        <code class="varname">CFLAGS</code> from the environment variable by
                   3611:        overriding them in the <code class="filename">Makefile</code>s of their
                   3612:        package.</p>
                   3613: <p>Currently there is no solution to this problem. If you
                   3614:        really need the package to use your <code class="varname">CFLAGS</code>
1.10      hubertf  3615:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  3616:        directory and then inspect any <code class="filename">Makefile</code> and
                   3617:        <code class="filename">Makefile.in</code> for whether they define
                   3618:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
                   3619:        these lines. But be aware that some &#8220;<span class="quote">smart</span>&#8221;
                   3620:        programmers write so bad code that it only works for the
                   3621:        specific combination of <code class="varname">CFLAGS</code> they have
                   3622:        chosen.</p>
                   3623: </div>
                   3624: <div class="sect1" lang="en">
                   3625: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3626: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.1       dsieger  3627: <div class="procedure"><ol type="1">
                   3628: <li><p>Make sure that your copy of pkgsrc is consistent. A
                   3629:        case that occurs often is that people only update pkgsrc in
                   3630:        parts, because of performance reasons. Since pkgsrc is one large
                   3631:        system, not a collection of many small systems, there are
                   3632:        sometimes changes that only work when the whole pkgsrc tree is
                   3633:        updated.</p></li>
                   3634: <li><p>Make sure that you don't have any CVS conflicts.
                   3635:        Search for &#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221; or
                   3636:        &#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221; in all your pkgsrc
                   3637:        files.</p></li>
                   3638: <li><p>Make sure that you don't have old copies of the packages
1.10      hubertf  3639:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  3640:        verify this.</p></li>
                   3641: <li><p>If the problem still exists, write a mail to the
                   3642:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3643: </ol></div>
                   3644: </div>
                   3645: <div class="sect1" lang="en">
                   3646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3647: <a name="faq.rcs-conflicts"></a>9.17. What does &#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221; mean?</h2></div></div></div>
1.1       dsieger  3648: <p>You have modified a file from pkgsrc, and someone else has
                   3649: modified that same file afterwards in the CVS repository. Both changes
                   3650: are in the same region of the file, so when you updated pkgsrc, the
                   3651: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3652: file. Because of these markers, the file is no longer a valid
                   3653: <code class="filename">Makefile</code>.</p>
                   3654: <p>Have a look at that file, and if you don't need your local changes
1.10      hubertf  3655: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  3656: -dP</strong></span> in that directory to download the current version.</p>
                   3657: </div>
                   3658: </div>
                   3659: </div>
                   3660: <div class="part" lang="en">
                   3661: <div class="titlepage"><div><div><h1 class="title">
                   3662: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
                   3663: <div class="partintro" lang="en">
                   3664: <div></div>
                   3665: <p>This part of the book deals with creating and
                   3666:        modifying packages. It starts with a &#8220;<span class="quote">HOWTO</span>&#8221;-like
                   3667:        guide on creating a new package. The remaining chapters are more
                   3668:        like a reference manual for pkgsrc.</p>
                   3669: <div class="toc">
                   3670: <p><b>Table of Contents</b></p>
                   3671: <dl>
1.6       rillig   3672: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger  3673: <dd><dl>
1.6       rillig   3674: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3675: <dd><dl>
1.6       rillig   3676: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3677: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17    ! imil     3678: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3679: </dl></dd>
1.6       rillig   3680: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3681: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   3682: </dl></dd>
                   3683: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3684: <dd><dl>
1.15      rillig   3685: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
                   3686: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.6       rillig   3687: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   3688: <dd><dl>
                   3689: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3690: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3691: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3692: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3693: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3694: </dl></dd>
                   3695: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3696: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3697: <dd><dl>
                   3698: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3699: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3700: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3701: </dl></dd>
1.15      rillig   3702: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
                   3703: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.6       rillig   3704: </dl></dd>
1.15      rillig   3705: <dt><span class="chapter"><a href="#makefile">12. Programming in Makefiles</a></span></dt>
1.6       rillig   3706: <dd><dl>
                   3707: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.15      rillig   3708: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.6       rillig   3709: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3710: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3711: <dd><dl>
                   3712: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   3713: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   3714: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   3715: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   3716: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
                   3717: </dl></dd>
                   3718: </dl></dd>
                   3719: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3720: <dd><dl>
                   3721: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.15      rillig   3722: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
                   3723: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.6       rillig   3724: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3725: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.15      rillig   3726: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.6       rillig   3727: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   3728: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
                   3729: </dl></dd>
                   3730: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3731: <dd><dl>
                   3732: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.15      rillig   3733: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.6       rillig   3734: <dd><dl>
                   3735: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.15      rillig   3736: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files</a></span></dt>
1.6       rillig   3737: </dl></dd>
1.15      rillig   3738: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.6       rillig   3739: <dd><dl>
1.15      rillig   3740: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.6       rillig   3741: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3742: </dl></dd>
                   3743: </dl></dd>
                   3744: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3745: <dd><dl>
                   3746: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3747: <dd><dl>
                   3748: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3749: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3750: </dl></dd>
                   3751: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3752: <dd><dl>
1.15      rillig   3753: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.6       rillig   3754: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3755: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3756: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3757: </dl></dd>
                   3758: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3759: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   3760: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3761: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3762: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3763: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3764: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                   3765: </dl></dd>
                   3766: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3767: <dd><dl>
                   3768: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.15      rillig   3769: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.6       rillig   3770: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   3771: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig   3772: </dl></dd>
                   3773: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3774: <dd><dl>
                   3775: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3776: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3777: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3778: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.15      rillig   3779: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.6       rillig   3780: <dd><dl>
                   3781: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3782: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3783: </dl></dd>
1.15      rillig   3784: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
                   3785: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
                   3786: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
                   3787: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
                   3788: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
                   3789: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
                   3790: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
                   3791: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
                   3792: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
                   3793: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.6       rillig   3794: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3795: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3796: </dl></dd>
                   3797: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3798: <dd><dl>
                   3799: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3800: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3801: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3802: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3803: </dl></dd>
                   3804: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3805: <dd><dl>
                   3806: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3807: <dd><dl>
                   3808: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.15      rillig   3809: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from ???</a></span></dt>
1.6       rillig   3810: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   3811: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   3812: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   3813: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   3814: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   3815: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   3816: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   3817: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   3818: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3819: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3820: </dl></dd>
1.15      rillig   3821: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.6       rillig   3822: <dd><dl>
                   3823: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3824: <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                   3825: </dl></dd>
1.15      rillig   3826: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.6       rillig   3827: <dd><dl>
                   3828: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3829: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3830: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3831: </dl></dd>
                   3832: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3833: <dd><dl>
                   3834: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3835: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3836: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   3837: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   3838: </dl></dd>
1.15      rillig   3839: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.6       rillig   3840: <dd><dl>
                   3841: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3842: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.15      rillig   3843: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.6       rillig   3844: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3845: </dl></dd>
1.15      rillig   3846: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.6       rillig   3847: <dd><dl>
                   3848: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3849: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3850: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3851: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3852: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3853: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3854: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3855: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   3856: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6       rillig   3857: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                   3858: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3859: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3860: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3861: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3862: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3863: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3864: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3865: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  3866:     emulation</a></span></dt>
1.6       rillig   3867: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3868: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  3869: </dl></dd>
1.6       rillig   3870: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3871: </dl></dd>
1.6       rillig   3872: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3873: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger  3874: <dd><dl>
1.6       rillig   3875: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3876: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3877: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3878: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   3879: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   3880: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
                   3881: </dl></dd>
                   3882: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3883: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3884: <dd><dl>
                   3885: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3886: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3887: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3888: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  3889: </dl></dd>
                   3890: </dl>
                   3891: </div>
                   3892: </div>
                   3893: <div class="chapter" lang="en">
                   3894: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3895: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1       dsieger  3896: <div class="toc">
                   3897: <p><b>Table of Contents</b></p>
                   3898: <dl>
1.6       rillig   3899: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3900: <dd><dl>
1.6       rillig   3901: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
                   3902: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
1.17    ! imil     3903: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3904: </dl></dd>
1.6       rillig   3905: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3906: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1       dsieger  3907: </dl>
                   3908: </div>
                   3909: <p>When you find a package that is not yet in pkgsrc, you
                   3910: most likely have a URL from where you can download the source
                   3911: code. Starting with this URL, creating a package involves only a
                   3912: few steps.</p>
                   3913: <div class="procedure"><ol type="1">
                   3914: <li><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
                   3915: <li><p>Then, choose one of the top-level directories as the
                   3916: category in which you want to place your package. You can also create a
                   3917: directory of your own (maybe called <code class="filename">local</code>). In that
                   3918: category directory, create another directory for your package and change
                   3919: into it.</p></li>
1.10      hubertf  3920: <li><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1       dsieger  3921: you for a URL. Enter the URL of the distribution file (in most cases a
                   3922: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3923: of your package are created automatically. The distribution file is
                   3924: extracted automatically to fill in some details in the
                   3925: <code class="filename">Makefile</code> that would otherwise have to be done
                   3926: manually.</p></li>
                   3927: <li>
                   3928: <p>Examine the extracted files to determine the dependencies of
                   3929: your package. Ideally, this is mentioned in some
                   3930: <code class="filename">README</code> file, but things may differ. For each of
                   3931: these dependencies, look where it exists in pkgsrc, and if there is a
                   3932: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3933: line to your package <code class="filename">Makefile</code> which includes that
                   3934: file just before the last line. If the
                   3935: <code class="filename">buildlink3.mk</code> file does not exist, add a
                   3936: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3937: version of the dependency and where it can be found in pkgsrc. This line
                   3938: should be placed in the third paragraph. If the dependency is only
                   3939: needed for building the package, but not when using it, use
                   3940: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3941: Your package may then look like this:</p>
                   3942: <pre class="programlisting">
                   3943: [...]
                   3944: 
                   3945: BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
                   3946: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3947: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3948: 
                   3949: [...]
                   3950: 
                   3951: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3952: .include "../../devel/glib2/buildlink3.mk"
                   3953: .include "../../mk/bsd.pkg.mk"
                   3954: </pre>
                   3955: </li>
1.10      hubertf  3956: <li><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.1       dsieger  3957: to be done to make your package a &#8220;<span class="quote">good</span>&#8221; one. If you don't
1.10      hubertf  3958: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3959: --explain</strong></span> or <span class="command"><strong>pkglint
1.1       dsieger  3960: -e</strong></span>, which outputs additional
                   3961: explanations.</p></li>
                   3962: <li><p>In many cases the package is not yet ready to build. You can
1.10      hubertf  3963: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.1       dsieger  3964: over there, you can hopefully continue here.</p></li>
1.10      hubertf  3965: <li><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1       dsieger  3966: directory from the extracted files. Besides these files, a lot of cache
                   3967: files and other system information has been saved in the working
                   3968: directory, which may become wrong after you edited the
                   3969: <code class="filename">Makefile</code>.</p></li>
1.10      hubertf  3970: <li><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   3971: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.1       dsieger  3972: <li><p>When the package builds fine, the next step is to install
1.10      hubertf  3973: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1       dsieger  3974: everything works.</p></li>
                   3975: <li><p>Up to now, the file <code class="filename">PLIST</code>, which
                   3976: contains a list of the files that are installed by the package, is
1.10      hubertf  3977: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1       dsieger  3978: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3979: the file using your preferred text editor to see if the list of
                   3980: files looks plausible.</p></li>
1.10      hubertf  3981: <li><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1       dsieger  3982: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.10      hubertf  3983: <li><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1       dsieger  3984: has been registered in the database of installed files, but with an
1.10      hubertf  3985: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3986: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1       dsieger  3987: registered with the list of files from
                   3988: <code class="filename">PLIST</code>.</p></li>
1.10      hubertf  3989: <li><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1       dsieger  3990: package from the set of installed files.</p></li>
                   3991: </ol></div>
                   3992: <div class="sect1" lang="en">
                   3993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3994: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.1       dsieger  3995: <div class="sect2" lang="en">
                   3996: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3997: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1       dsieger  3998: <p>Simple Perl modules are handled automatically by
1.10      hubertf  3999: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1       dsieger  4000: </div>
                   4001: <div class="sect2" lang="en">
                   4002: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4003: <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
1.1       dsieger  4004: <p>KDE applications should always include
                   4005: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
                   4006: settings that are typical of KDE packages.</p>
                   4007: </div>
1.17    ! imil     4008: <div class="sect2" lang="en">
        !          4009: <div class="titlepage"><div><div><h3 class="title">
        !          4010: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
        !          4011: <p>Python modules and programs packages are easily created using a
        !          4012: set of predefined variables.</p>
        !          4013: <p>Most Python packages use either &#8220;<span class="quote">distutils</span>&#8221; or
        !          4014: easy-setup (&#8220;<span class="quote">eggs</span>&#8221;).
        !          4015: If the software uses &#8220;<span class="quote">distutils</span>&#8221;, set the
        !          4016: <code class="varname">PYDISTUTILSPKG</code> variable to &#8220;<span class="quote">yes</span>&#8221; so
        !          4017: pkgsrc will make use of this framework.
        !          4018: &#8220;<span class="quote">distutils</span>&#8221; uses a script called <code class="filename">setup.py</code>,
        !          4019: if the &#8220;<span class="quote">distutils</span>&#8221; driver is not called
        !          4020: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
        !          4021: to the name of the script.</p>
        !          4022: <p>
        !          4023: If the default Python versions are not supported by the software, set the
        !          4024: <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
        !          4025: the software is known to work with, from the most recent to the older
        !          4026: one, e.g.
        !          4027: </p>
        !          4028: <pre class="programlisting">
        !          4029: PYTHON_VERSIONS_ACCEPTED=       25 24 23
        !          4030: </pre>
        !          4031: <p>
        !          4032: If the packaged software is a Python module, include
        !          4033: &#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;.
        !          4034: In this case, the package directory should be called
        !          4035: &#8220;<span class="quote">py-software</span>&#8221; and <code class="varname">PKGNAME</code> should be set to
        !          4036: &#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;, e.g.
        !          4037: </p>
        !          4038: <pre class="programlisting">
        !          4039: DISTNAME=   foopymodule-1.2.10
        !          4040: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
        !          4041: </pre>
        !          4042: <p>If it is an application, also include
        !          4043: &#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;
        !          4044: before &#8220;<span class="quote">extension.mk</span>&#8221;.</p>
        !          4045: <p>If the packaged software, either it is an application or a module, is
        !          4046: egg-aware, you only need to include
        !          4047: &#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;.</p>
        !          4048: <p>In order to correctly set the path to the Python interpreter, use the
        !          4049: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
        !          4050: that must be corrected. For example :
        !          4051: </p>
        !          4052: <pre class="programlisting">
        !          4053: REPLACE_PYTHON=   ${WRKSRC}/*.py
        !          4054: </pre>
        !          4055: </div>
1.1       dsieger  4056: </div>
                   4057: <div class="sect1" lang="en">
                   4058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4059: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.1       dsieger  4060: <div class="sect2" lang="en">
                   4061: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4062: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.1       dsieger  4063: <div class="sect3" lang="en">
                   4064: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4065: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1       dsieger  4066: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   4067: that the &#8220;<span class="quote">nvu</span>&#8221; package has not yet been imported into
                   4068: pkgsrc. As the description says it has to do with the web, the obvious
                   4069: choice for the category is &#8220;<span class="quote">www</span>&#8221;.</p>
                   4070: <pre class="programlisting">
                   4071: <code class="prompt">$</code> mkdir www/nvu
                   4072: <code class="prompt">$</code> cd www/nvu
                   4073: </pre>
                   4074: <p>The web site says that the sources are available as a tar file, so
1.10      hubertf  4075: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1       dsieger  4076: <pre class="programlisting">
                   4077: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4078: </pre>
                   4079: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   4080: below the <code class="varname">DISTNAME</code> line, as the package name should
                   4081: not have the word &#8220;<span class="quote">sources</span>&#8221; in it. I also filled in the
                   4082: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   4083: <code class="varname">COMMENT</code> fields. Then the package
                   4084: <code class="filename">Makefile</code> looked like that:</p>
                   4085: <pre class="programlisting">
                   4086: # $NetBSD$
                   4087: #
                   4088: 
                   4089: DISTNAME=       nvu-1.0-sources
                   4090: PKGNAME=        nvu-1.0
                   4091: CATEGORIES=     www
                   4092: MASTER_SITES=   http://cvs.nvu.com/download/
                   4093: EXTRACT_SUFX=   .tar.bz2
                   4094: 
                   4095: MAINTAINER=     rillig@NetBSD.org
                   4096: HOMEPAGE=       http://cvs.nvu.com/
                   4097: COMMENT=        Web Authoring System
                   4098: 
                   4099: # url2pkg-marker (please do not remove this line.)
                   4100: .include "../../mk/bsd.pkg.mk"
                   4101: </pre>
                   4102: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   4103: source archive:</p>
                   4104: <pre class="programlisting">
                   4105: url2pkg&gt; Running "make makesum" ...
                   4106: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4107: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   4108: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   4109: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   4110: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   4111: url2pkg&gt; Running "make extract" ...
                   4112: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4113: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4114: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4115: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   4116: ===&gt; Installing dependencies for nvu-1.0
                   4117: ===&gt; Overriding tools for nvu-1.0
                   4118: ===&gt; Extracting for nvu-1.0
                   4119: url2pkg&gt; Adjusting the Makefile.
                   4120: 
                   4121: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   4122: 
                   4123: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   4124: </pre>
                   4125: </div>
                   4126: <div class="sect3" lang="en">
                   4127: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4128: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1       dsieger  4129: <p>Now that the package has been extracted, let's see what's inside
                   4130: it. The package has a <code class="filename">README.txt</code>, but that only
                   4131: says something about mozilla, so it's probably useless for seeing what
                   4132: dependencies this package has. But since there is a GNU configure script
                   4133: in the package, let's hope that it will complain about everything it
                   4134: needs.</p>
                   4135: <pre class="programlisting">
                   4136: <code class="prompt">$</code> bmake
                   4137: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   4138: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   4139: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   4140: ===&gt; Patching for nvu-1.0
                   4141: ===&gt; Creating toolchain wrappers for nvu-1.0
                   4142: ===&gt; Configuring for nvu-1.0
                   4143: [...]
                   4144: configure: error: Perl 5.004 or higher is required.
                   4145: [...]
                   4146: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   4147: [...]
                   4148: </pre>
                   4149: <p>That worked quite well. So I opened the package Makefile in my
                   4150: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   4151: just appended &#8220;<span class="quote">perl</span>&#8221; to it. Since the dependencies of the
                   4152: package have changed now, and since a perl wrapper is automatically
                   4153: installed in the &#8220;<span class="quote">tools</span>&#8221; phase, I need to build the package
                   4154: from scratch.</p>
                   4155: <pre class="programlisting">
                   4156: <code class="prompt">$</code> bmake clean
                   4157: ===&gt; Cleaning for nvu-1.0
                   4158: <code class="prompt">$</code> bmake
                   4159: [...]
                   4160: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   4161: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   4162: [...]
                   4163: </pre>
                   4164: <p>So I added &#8220;<span class="quote">gmake</span>&#8221; to the
                   4165: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   4166: <pre class="programlisting">
                   4167: [...]
                   4168: checking for GTK - version &gt;= 1.2.0... no
                   4169: *** Could not run GTK test program, checking why...
                   4170: [...]
                   4171: </pre>
                   4172: <p>Now to the other dependencies. The first question is: Where is the
                   4173: GTK package hidden in pkgsrc?</p>
                   4174: <pre class="programlisting">
                   4175: <code class="prompt">$</code> echo ../../*/gtk*
                   4176: [many packages ...]
                   4177: <code class="prompt">$</code> echo ../../*/gtk
                   4178: ../../x11/gtk
                   4179: <code class="prompt">$</code> echo ../../*/gtk2
                   4180: ../../x11/gtk2
                   4181: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   4182: ../../x11/gtk2/buildlink3.mk
                   4183: </pre>
                   4184: <p>The first try was definitely too broad. The second one had exactly
                   4185: one result, which is very good. But there is one pitfall with GNOME
                   4186: packages. Before GNOME 2 had been released, there were already many
                   4187: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   4188: packages, the GNOME 2 packages were imported as separate packages, and
                   4189: their names usually have a &#8220;<span class="quote">2</span>&#8221; appended. So I checked
                   4190: whether this was the case here, and indeed it was.</p>
                   4191: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   4192: file, adding the dependency is very easy. I just inserted an
                   4193: <code class="literal">.include</code> line before the last line of the package
                   4194: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   4195: <pre class="programlisting">
                   4196: [...]
                   4197: .include "../../x11/gtk2/buildlink3.mk"
                   4198: .include "../../mk/bsd.pkg.mk
                   4199: </pre>
1.10      hubertf  4200: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.1       dsieger  4201: was:</p>
                   4202: <pre class="programlisting">
                   4203: [...]
                   4204: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   4205: checking for GTK - version &gt;= 1.2.0... no
                   4206: *** Could not run GTK test program, checking why...
                   4207: *** The test program failed to compile or link. See the file config.log for the
                   4208: *** exact error that occured. This usually means GTK was incorrectly installed
                   4209: *** or that you have moved GTK since it was installed. In the latter case, you
                   4210: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   4211: configure: error: Test for GTK failed.
                   4212: [...]
                   4213: </pre>
                   4214: <p>In this particular case, the assumption that &#8220;<span class="quote">every package
                   4215: prefers GNOME 2</span>&#8221; had been wrong. The first of the lines above
                   4216: told me that this package really wanted to have the GNOME 1 version of
                   4217: GTK. If the package had looked for GTK2, it would have looked for
1.10      hubertf  4218: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1       dsieger  4219: So I changed the <code class="literal">x11/gtk2</code> to
                   4220: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   4221: and tried again.</p>
                   4222: <pre class="programlisting">
                   4223: [...]
                   4224: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"   -I../../../dist/include/xpcom -I../../../dist/include -I/tmp/roland/pkgsrc/www/nvu/work.bacc/mozilla/dist/include/nspr -I/usr/X11R6/include   -fPIC -DPIC -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -Wall -W -Wno-unused -Wpointer-arith -Wcast-align -Wno-long-long -pedantic -O2 -I/home/roland/pkg/include -I/usr/include -Dunix -pthread -pipe  -DDEBUG -D_DEBUG -DDEBUG_roland -DTRACING -g -I/home/roland/pkg/include/glib/glib-1.2 -I/home/roland/pkg/lib/glib/include -I/usr/pkg/include/orbit-1.0   -I/home/roland/pkg/include -I/usr/include  -I/usr/X11R6/include -include ../../../mozilla-config.h -DMOZILLA_CLIENT -Wp,-MD,.deps/xpidl.pp xpidl.c
                   4225: In file included from xpidl.c:42:
                   4226: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   4227: In file included from xpidl.c:42:
                   4228: xpidl.h:132: error: parse error before "IDL_ns"
                   4229: [...]
                   4230: </pre>
                   4231: <p>The package still does not find all of its dependencies. Now the
                   4232: question is: Which package provides the
                   4233: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   4234: <pre class="programlisting">
                   4235: <code class="prompt">$</code> echo ../../*/*idl*
                   4236: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   4237: <code class="prompt">$</code> echo ../../*/*IDL*
                   4238: ../../net/libIDL
                   4239: </pre>
                   4240: <p>Let's take the one from the second try. So I included the
                   4241: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   4242: again. But the error didn't change. After digging through some of the
                   4243: code, I concluded that the build process of the package was broken and
                   4244: couldn't have ever worked, but since the Mozilla source tree is quite
                   4245: large, I didn't want to fix it. So I added the following to the package
                   4246: <code class="filename">Makefile</code> and tried again:</p>
                   4247: <pre class="programlisting">
                   4248: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   4249: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   4250: </pre>
                   4251: <p>The latter line is needed because the package expects the library
                   4252: <code class="filename">libIDL.so</code>, but only
                   4253: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   4254: wrapper to rewrite that on the fly.</p>
                   4255: <p>The next problem was related to a recent change of the FreeType
                   4256: interface. I looked up in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
                   4257: which patch files were relevant for this issue and copied them to the
                   4258: <code class="filename">patches</code> directory. Then I retried, fixed the
                   4259: patches so that they applied cleanly and retried again. This time,
                   4260: everything worked.</p>
                   4261: </div>
                   4262: <div class="sect3" lang="en">
                   4263: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   4264: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  4265: <pre class="programlisting">
                   4266: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   4267: [...]
                   4268: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   4269: <code class="prompt">$</code> bmake deinstall
                   4270: <code class="prompt">$</code> bmake install
                   4271: </pre>
                   4272: </div>
                   4273: </div>
                   4274: </div>
                   4275: </div>
                   4276: <div class="chapter" lang="en">
                   4277: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4278: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  4279: <div class="toc">
                   4280: <p><b>Table of Contents</b></p>
                   4281: <dl>
1.15      rillig   4282: <dt><span class="sect1"><a href="#components.Makefile">11.1. Makefile</a></span></dt>
                   4283: <dt><span class="sect1"><a href="#components.distinfo">11.2. distinfo</a></span></dt>
1.6       rillig   4284: <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
                   4285: <dd><dl>
                   4286: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   4287: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   4288: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   4289: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   4290: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   4291: </dl></dd>
                   4292: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   4293: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   4294: <dd><dl>
                   4295: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   4296: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   4297: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  4298: </dl></dd>
1.15      rillig   4299: <dt><span class="sect1"><a href="#work-dir">11.6. work*</a></span></dt>
                   4300: <dt><span class="sect1"><a href="#files-dir">11.7. files/*</a></span></dt>
1.1       dsieger  4301: </dl>
                   4302: </div>
                   4303: <p>Whenever you're preparing a package, there are a number of
                   4304: files involved which are described in the following
                   4305: sections.</p>
                   4306: <div class="sect1" lang="en">
                   4307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4308: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1       dsieger  4309: </h2></div></div></div>
                   4310: <p>Building, installation and creation of a binary package are all
                   4311:   controlled by the package's <code class="filename">Makefile</code>.
                   4312:   The <code class="filename">Makefile</code> describes various things about
                   4313:   a package, for example from where to get it, how to configure,
                   4314:   build, and install it.</p>
                   4315: <p>A package <code class="filename">Makefile</code> contains several
                   4316:   sections that describe the package.</p>
                   4317: <p>In the first section there are the following variables, which
                   4318:   should appear exactly in the order given here.  The order and
                   4319:   grouping of the variables is mostly historical and has no further
                   4320:   meaning.</p>
                   4321: <div class="itemizedlist"><ul type="disc">
                   4322: <li><p><code class="varname">DISTNAME</code> is the basename of the
                   4323:     distribution file to be downloaded from the package's
                   4324:     website.</p></li>
                   4325: <li><p><code class="varname">PKGNAME</code> is the name of the
                   4326:     package, as used by pkgsrc. You only need to provide it if
                   4327:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   4328:     name for the package in pkgsrc.  Usually it is the pkgsrc
                   4329:     directory name together with the version number. It must match the
                   4330:     regular expression
                   4331:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   4332:     starts with a letter or digit, and contains only letters, digits,
                   4333:     dashes, underscores, dots and plus signs.</p></li>
                   4334: <li><p><code class="varname">SVR4_PKGNAME</code> is the name of
                   4335:     the package file to create if the <code class="varname">PKGNAME</code>
                   4336:     isn't unique on a SVR4 system. The default is
                   4337:     <code class="varname">PKGNAME</code>, which may be shortened when you use
                   4338:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>. Only add
                   4339:     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
                   4340:     does not produce an unique package name on a SVR4 system.
                   4341:     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
                   4342:     characters.</p></li>
                   4343: <li>
                   4344: <p><code class="varname">CATEGORIES</code> is a list of categories
                   4345:     which the package fits in. You can choose any of the top-level
                   4346:     directories of pkgsrc for it.</p>
                   4347: <p>Currently the following values are available for
                   4348:     <code class="varname">CATEGORIES</code>. If more than
                   4349:     one is used, they need to be separated by spaces:</p>
                   4350: <pre class="programlisting">
                   4351: archivers     cross         geography     meta-pkgs     security
                   4352: audio         databases     graphics      misc          shells
                   4353: benchmarks    devel         ham           multimedia    sysutils
                   4354: biology       editors       inputmethod   net           textproc
                   4355: cad           emulators     lang          news          time
                   4356: chat          finance       mail          parallel      wm
                   4357: comms         fonts         math          pkgtools      www
                   4358: converters    games         mbone         print         x11
                   4359: </pre>
                   4360: </li>
                   4361: <li><p><code class="varname">MASTER_SITES</code>,
                   4362:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4363:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4364:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.15      rillig   4365:     <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, &#8220;The fetch phase&#8221;</a>.</p></li>
1.1       dsieger  4366: </ul></div>
                   4367: <p>The second section contains information about separately
                   4368:   downloaded patches, if any.
                   4369:   </p>
                   4370: <div class="itemizedlist"><ul type="disc">
                   4371: <li><p><code class="varname">PATCHFILES:</code>
                   4372:     Name(s) of additional files that contain distribution patches.
                   4373:     There is no default. pkgsrc will look for them at
                   4374:     <code class="varname">PATCH_SITES</code>.
                   4375:     They will automatically be uncompressed before patching if
                   4376:     the names end with <code class="filename">.gz</code> or
                   4377:     <code class="filename">.Z</code>.</p></li>
                   4378: <li><p><code class="varname">PATCH_SITES</code>:
                   4379:     Primary location(s) for distribution patch files (see
                   4380:     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
                   4381: </ul></div>
                   4382: <p>The third section contains the following variables.
                   4383:   </p>
                   4384: <div class="itemizedlist"><ul type="disc">
1.14      jmcneill 4385: <li><p><code class="varname">MAINTAINER</code> is the email
                   4386:     address of the person who feels responsible for this package,
                   4387:     and who is most likely to look at problems or questions regarding
                   4388:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
                   4389:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4390:     before making changes to the package, but are not required to
                   4391:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4392:     to yourself. If you really can't maintain the package for future
                   4393:     updates, set it to
1.10      hubertf  4394:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.14      jmcneill 4395: <li><p><code class="varname">OWNER</code> should be used instead
                   4396:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4397:     developers to update or change the package without contacting
                   4398:     you first. A package Makefile should contain one of
                   4399:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4400:     not both.  </p></li>
1.1       dsieger  4401: <li><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   4402:     find more information about the package.</p></li>
                   4403: <li><p><code class="varname">COMMENT</code> is a one-line
                   4404:     description of the package (should not include the package
                   4405:     name).</p></li>
                   4406: </ul></div>
                   4407: <p>Other variables that affect the build:
                   4408:   </p>
                   4409: <div class="itemizedlist"><ul type="disc"><li>
                   4410: <p><code class="varname">WRKSRC</code>: The directory where the
                   4411:       interesting distribution files of the package are found. The
                   4412:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4413:       works for most packages.</p>
                   4414: <p>If a package doesn't create a subdirectory for itself
                   4415:       (most GNU software does, for instance), but extracts itself in
                   4416:       the current directory, you should set
                   4417:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4418: <p>If a package doesn't create a subdirectory with the
                   4419:       name of <code class="varname">DISTNAME</code> but some different name,
                   4420:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4421:       <code class="filename">${WRKDIR}</code>, for example
                   4422:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
                   4423:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
                   4424: <p>The name of the working directory created by pkgsrc is
                   4425:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4426:       variable. By default, its value is
                   4427:       <code class="filename">work</code>. If you want to use the same
                   4428:       pkgsrc tree for building different kinds of binary packages,
                   4429:       you can change the variable according to your needs. Two
                   4430:       other variables handle common cases of setting
                   4431:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4432:       <code class="varname">OBJHOSTNAME</code> is defined in
1.10      hubertf  4433:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1       dsieger  4434:       the host's name is attached to the directory name. If
                   4435:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4436:       is attached, which might look like
                   4437:       <code class="filename">work.i386</code> or
                   4438:       <code class="filename">work.sparc</code>.</p>
                   4439: </li></ul></div>
                   4440: <p>Please pay attention to the following gotchas:</p>
                   4441: <div class="itemizedlist"><ul type="disc">
                   4442: <li><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   4443:       installed in compressed form by the package.  For packages using
                   4444:       BSD-style makefiles which honor MANZ, there is
                   4445:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   4446: <li><p>Replace <code class="filename">/usr/local</code> with
                   4447:       &#8220;<span class="quote">${PREFIX}</span>&#8221; in all files (see patches,
                   4448:       below).</p></li>
1.10      hubertf  4449: <li><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.1       dsieger  4450: </ul></div>
                   4451: </div>
                   4452: <div class="sect1" lang="en">
                   4453: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4454: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1       dsieger  4455: </h2></div></div></div>
                   4456: <p>The <code class="filename">distinfo</code> file contains the message
                   4457:   digest, or checksum, of each distfile needed for the package. This
                   4458:   ensures that the distfiles retrieved from the Internet have not been
                   4459:   corrupted during transfer or altered by a malign force to introduce
                   4460:   a security hole. Due to recent rumor about weaknesses of digest
                   4461:   algorithms, all distfiles are protected using both SHA1 and RMD160
                   4462:   message digests, as well as the file size.</p>
                   4463: <p>The <code class="filename">distinfo</code> file also contains the
                   4464:   checksums for all the patches found in the
1.10      hubertf  4465:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a>).</p>
1.1       dsieger  4466: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.10      hubertf  4467:   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
1.1       dsieger  4468:   command.</p>
                   4469: <p>Some packages have different sets of distfiles depending on
                   4470:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/navigator/README.html" target="_top"><code class="filename">www/navigator</code></a>). These are kept in the same
                   4471:   <code class="filename">distinfo</code> file and care should be taken when
                   4472:   upgrading such a package to ensure distfile information is not
                   4473:   lost.</p>
                   4474: </div>
                   4475: <div class="sect1" lang="en">
                   4476: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4477: <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
1.1       dsieger  4478: <p>Many packages still don't work out-of-the box on the various
                   4479:   platforms that are supported by pkgsrc. Therefore, a number of custom
                   4480:   patch files are needed to make the package work. These patch files are
                   4481:   found in the <code class="filename">patches/</code> directory.</p>
                   4482: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4483:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.10      hubertf  4484:   extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
1.1       dsieger  4485:   order</a>, so <code class="filename">patch-aa</code> is applied before
                   4486:   <code class="filename">patch-ab</code>, etc.</p>
                   4487: <div class="sect2" lang="en">
                   4488: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4489: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1       dsieger  4490: <p>The <code class="filename">patch-*</code> files should be in
1.10      hubertf  4491:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1       dsieger  4492:   problems. (To force patches to apply with fuzz you can set
                   4493:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   4494:   should contain only changes for a single file, and no file should be
                   4495:   patched by more than one patch file. This helps to keep future
                   4496:   modifications simple.</p>
                   4497: <p>Each patch file is structured as follows: In the first line,
                   4498:   there is the RCS Id of the patch itself. The second line should be
                   4499:   empty for aesthetic reasons. After that, there should be a comment for
                   4500:   each change that the patch does. There are a number of standard
                   4501:   cases:</p>
                   4502: <div class="itemizedlist"><ul type="disc">
                   4503: <li><p>Patches that replace the <code class="literal">==</code>
1.10      hubertf  4504:   operator for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?test+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">test</span>(1)</span></a> with <code class="literal">=</code> in shell scripts
1.11      rillig   4505:   are so common that they don't need a comment at all.</p></li>
1.1       dsieger  4506: <li><p>Patches for commonly known vulnerabilities should
                   4507:   mention the vulnerability ID (CAN, CVE).</p></li>
                   4508: <li><p>Patches that change source code should mention the
                   4509:   platform and other environment (for example, the compiler) that the
                   4510:   patch is needed for.</p></li>
                   4511: </ul></div>
                   4512: <p>In all other cases, the patch should be commented so that any
                   4513:   developer who knows the code of the application can make some use of
                   4514:   the patch. Special care should be taken for the upstream developers,
                   4515:   since we generally want that they accept our patches, so we have less
                   4516:   work in the future.</p>
                   4517: </div>
                   4518: <div class="sect2" lang="en">
                   4519: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4520: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1       dsieger  4521: <p>One important thing to mention is to pay attention that no RCS
                   4522:   IDs get stored in the patch files, as these will cause problems when
                   4523:   later checked into the NetBSD CVS tree. Use the
1.10      hubertf  4524:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.1       dsieger  4525:   problems.</p>
                   4526: <p>For even more automation, we recommend using
1.10      hubertf  4527:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1       dsieger  4528:   whole set of patches. You just have to backup files before you
                   4529:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.10      hubertf  4530:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4531:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1       dsieger  4532:   you upgrade a package this way, you can easily compare the new
                   4533:   set of patches with the previously existing one with
1.10      hubertf  4534:   <span class="command"><strong>patchdiff</strong></span>. Copy the patches you want to use
1.1       dsieger  4535:   or update from the <code class="filename">work/.newpatches</code>
                   4536:   directory to <code class="filename">patches/</code>.</p>
                   4537: <p>When you have finished a package, remember to generate
1.10      hubertf  4538:   the checksums for the patch files by using the <span class="command"><strong>make
1.15      rillig   4539:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, &#8220;distinfo&#8221;</a>.</p>
1.1       dsieger  4540: <p>When adding a patch that corrects a problem in the
                   4541:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4542:   man pages should go), send the patch as a bug report to the
                   4543:   maintainer.  This benefits non-pkgsrc users of the package,
                   4544:   and usually makes it possible to remove the patch in future
                   4545:   version.</p>
1.2       rillig   4546: <p>The file names of the patch files are usually of the form
                   4547:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>.</p>
1.1       dsieger  4548: </div>
                   4549: <div class="sect2" lang="en">
                   4550: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4551: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1       dsieger  4552: <p>If you want to share patches between multiple packages
                   4553:   in pkgsrc, e.g. because they use the same distfiles, set
                   4554:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4555:   can be found, e.g.:</p>
                   4556: <pre class="programlisting">
                   4557: PATCHDIR= ${.CURDIR}/../xemacs/patches
                   4558: </pre>
                   4559: <p>Patch files that are distributed by the author or other
                   4560:     maintainers can be listed in
                   4561:     <code class="varname">PATCHFILES</code>.</p>
                   4562: <p>If it is desired to store any patches that should not be
                   4563:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4564:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4565:     directory tree there is expected to have the same
                   4566:     &#8220;<span class="quote">category/package</span>&#8221; structure as pkgsrc, and
                   4567:     patches are expected to be stored inside these dirs (also
                   4568:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4569:     example, if you want to keep a private patch for
                   4570:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4571:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4572:     files in the named directory are expected to be patch files,
                   4573:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4574:     applied</em></span>.</p>
                   4575: </div>
                   4576: <div class="sect2" lang="en">
                   4577: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4578: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1       dsieger  4579: <p>When fixing a portability issue in the code do not use
                   4580:       preprocessor magic to check for the current operating system nor
                   4581:       platform.  Doing so hurts portability to other platforms because
                   4582:       the OS-specific details are not abstracted appropriately.</p>
                   4583: <p>The general rule to follow is: instead of checking for the
                   4584:       operating system the application is being built on, check for the
                   4585:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4586:       instead of assuming that kqueue is available under NetBSD and
                   4587:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14      jmcneill 4588:       kqueue support, add a check that detects kqueue itself &mdash;
1.1       dsieger  4589:       yes, this generally involves patching the
1.10      hubertf  4590:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.1       dsieger  4591:       that prevents some OSes from adopting interfaces from other OSes
                   4592:       (e.g. Linux implementing kqueue), something that the above checks
                   4593:       cannot take into account.</p>
                   4594: <p>Of course, checking for features generally involves more
                   4595:       work on the developer's side, but the resulting changes are
                   4596:       cleaner and there are chances they will work on many other
                   4597:       platforms.  Not to mention that there are higher chances of being
                   4598:       later integrated into the mainstream sources.  Remember:
                   4599:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4600: <p>Some typical examples:</p>
                   4601: <div class="table">
1.6       rillig   4602: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.1       dsieger  4603: <div class="table-contents"><table summary="Patching examples" border="1">
                   4604: <colgroup>
                   4605: <col>
                   4606: <col>
                   4607: <col>
                   4608: </colgroup>
                   4609: <thead><tr>
                   4610: <th>Where</th>
                   4611: <th>Incorrect</th>
                   4612: <th>Correct</th>
                   4613: </tr></thead>
                   4614: <tbody>
                   4615: <tr>
                   4616: <td>configure script</td>
                   4617: <td>
                   4618: <pre class="programlisting">
                   4619: case ${target_os} in
                   4620: netbsd*) have_kvm=yes ;;
                   4621: *)       have_kvm=no  ;;
                   4622: esac
                   4623: </pre>
                   4624:              </td>
                   4625: <td>
                   4626: <pre class="programlisting">
                   4627: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4628: </pre>
                   4629:              </td>
                   4630: </tr>
                   4631: <tr>
                   4632: <td>C source file</td>
                   4633: <td>
                   4634: <pre class="programlisting">
                   4635: #if defined(__NetBSD__)
                   4636: #  include &lt;sys/event.h&gt;
                   4637: #endif
                   4638: </pre>
                   4639:              </td>
                   4640: <td>
                   4641: <pre class="programlisting">
                   4642: #if defined(HAVE_SYS_EVENT_H)
                   4643: #  include &lt;sys/event.h&gt;
                   4644: #endif
                   4645: </pre>
                   4646:              </td>
                   4647: </tr>
                   4648: <tr>
                   4649: <td>C source file</td>
                   4650: <td>
                   4651: <pre class="programlisting">
                   4652: int
                   4653: monitor_file(...)
                   4654: {
                   4655: #if defined(__NetBSD__)
                   4656:         int fd = kqueue();
                   4657:         ...
                   4658: #else
                   4659:         ...
                   4660: #endif
                   4661: }
                   4662: </pre>
                   4663:              </td>
                   4664: <td>
                   4665: <pre class="programlisting">
                   4666: int
                   4667: monitor_file(...)
                   4668: {
                   4669: #if defined(HAVE_KQUEUE)
                   4670:         int fd = kqueue();
                   4671:         ...
                   4672: #else
                   4673:        ...
                   4674: #endif
                   4675: }
                   4676: </pre>
                   4677:              </td>
                   4678: </tr>
                   4679: </tbody>
                   4680: </table></div>
                   4681: </div>
                   4682: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10      hubertf  4683:       packager-friendly software</em></span> article (<a class="ulink" href="http://www.onlamp.com/pub/a/onlamp/2005/03/31/packaging.html" target="_top">part
                   4684:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1       dsieger  4685:       2</a>).  It summarizes multiple details on how to make
                   4686:       software easier to package; all the suggestions in it were
                   4687:       collected from our experience in pkgsrc work, so they are possibly
                   4688:       helpful when creating patches too.</p>
                   4689: </div>
                   4690: <div class="sect2" lang="en">
                   4691: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4692: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1       dsieger  4693: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4694:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4695:       improvements you do to a package to the mainstream developers.
                   4696:       This is the only way to get their attention on portability issues
                   4697:       and to ensure that future versions can be built out-of-the box on
                   4698:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4699:       the fixes straight from the packaged code.</p>
                   4700: <p>This generally involves cleaning up the patches
                   4701:       (because sometimes the patches that are
                   4702:       added to pkgsrc are quick hacks), filling bug reports in the
                   4703:       appropriate trackers for the projects and working with the
                   4704:       mainstream authors to accept your changes.  It is
                   4705:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4706:       the packages in pkgsrc are kept simple and thus further changes
                   4707:       can be done without much hassle.</p>
                   4708: <p>Support the idea of free software!</p>
                   4709: </div>
                   4710: </div>
                   4711: <div class="sect1" lang="en">
                   4712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4713: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.1       dsieger  4714: <div class="variablelist"><dl>
                   4715: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   4716: <dd><p>A multi-line description of the piece of software.  This should include
                   4717:          any credits where they are due.  Please bear in mind that others do not
                   4718:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4719:          will read everything that you write here.</p></dd>
                   4720: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   4721: <dd><p>This file governs the files that are installed on your
                   4722:          system: all the binaries, manual pages, etc. There are other
                   4723:          directives which may be entered in this file, to control the
                   4724:          creation and deletion of directories, and the location of
1.10      hubertf  4725:          inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1       dsieger  4726:          information.</p></dd>
                   4727: </dl></div>
                   4728: </div>
                   4729: <div class="sect1" lang="en">
                   4730: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4731: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.1       dsieger  4732: <div class="sect2" lang="en">
                   4733: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4734: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.1       dsieger  4735: <div class="variablelist"><dl>
                   4736: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.10      hubertf  4737: <dd><p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1       dsieger  4738:            First time after package extraction and before files are
                   4739:            moved in place, the second time after the files to install
                   4740:            are moved in place. This can be used to do any custom
                   4741:            procedures not possible with @exec commands in
1.10      hubertf  4742:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4743:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.</p></dd>
1.1       dsieger  4744: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4745: <dd><p>This script is executed before and after any files are removed.  It is
                   4746:            this script's responsibility to clean up any additional messy details
                   4747:            around the package's installation, since all pkg_delete knows is how to
                   4748:            delete the files created in the original distribution.
1.10      hubertf  4749:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4750:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.</p></dd>
1.1       dsieger  4751: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4752: <dd>
                   4753: <p>This file is displayed after installation of the package.
                   4754:            Useful for things like legal notices on almost-free
                   4755:            software and hints for updating config files after
                   4756:            installing modules for apache, PHP etc.
                   4757:            Please note that you can modify variables in it easily by using
                   4758:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4759:            <code class="filename">Makefile</code>:</p>
                   4760: <pre class="programlisting">
                   4761: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4762: </pre>
                   4763: <p>replaces "${SOMEVAR}" with &#8220;<span class="quote">somevalue</span>&#8221; in
                   4764:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4765:            performed for <code class="varname">PKGNAME</code>,
                   4766:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   4767:            <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
                   4768:            <code class="varname">X11BASE</code>,
                   4769:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4770:            <code class="varname">ROOT_GROUP</code>, and
1.16      jnemeth  4771:            <code class="varname">ROOT_USER</code>.</p>
1.1       dsieger  4772: <p>You can display a different or additional files by
                   4773:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4774:            default is <code class="filename">MESSAGE</code>, if the file
                   4775:            exists.</p>
                   4776: </dd>
                   4777: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   4778: <dd><p>FIXME: There is no documentation on the
                   4779:        alternatives framework.</p></dd>
                   4780: </dl></div>
                   4781: </div>
                   4782: <div class="sect2" lang="en">
                   4783: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4784: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.1       dsieger  4785: <div class="variablelist"><dl>
                   4786: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4787: <dd><p>This file contains arbitrary things that could
                   4788:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4789:        to be used by more than one package. This file should only be
                   4790:        used when the packages that will use the file are known in
                   4791:        advance. For other purposes it is often better to write a
                   4792:        <code class="filename">*.mk</code> file and give it a good name that
                   4793:        describes what it does.</p></dd>
                   4794: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4795: <dd><p>This file contains the dependency information
1.10      hubertf  4796:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1       dsieger  4797: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4798: <dd><p>This file contains workarounds for compiler bugs
                   4799:        and similar things. It is included automatically by the pkgsrc
                   4800:        infrastructure, so you don't need an extra
                   4801:        <code class="literal">.include</code> line for
                   4802:        it.</p></dd>
                   4803: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4804: <dd><p>This file contains the code for the
1.10      hubertf  4805:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1       dsieger  4806:        selected by the user. If a package has only one or two options,
                   4807:        it is equally acceptable to put the code directly into the
                   4808:        <code class="filename">Makefile</code>.</p></dd>
                   4809: </dl></div>
                   4810: </div>
                   4811: <div class="sect2" lang="en">
                   4812: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4813: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.1       dsieger  4814: <div class="variablelist"><dl>
                   4815: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4816: <dd><p>These files do not take place in the creation of
                   4817:        a package and thus are purely informative to the package
                   4818:        developer.</p></dd>
                   4819: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4820: <dd><p>This file contains things that need to be done
                   4821:        to make the package even
                   4822:        better.</p></dd>
                   4823: </dl></div>
                   4824: </div>
                   4825: </div>
                   4826: <div class="sect1" lang="en">
                   4827: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4828: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1       dsieger  4829: </h2></div></div></div>
1.10      hubertf  4830: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1       dsieger  4831:     unpacked into the directory denoted by
                   4832:     <code class="varname">WRKDIR</code>. It can be removed by running
1.10      hubertf  4833:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1       dsieger  4834:     directory is also used to keep various timestamp files.
                   4835:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4836:     The default is <code class="filename">${.CURDIR}/work</code>
                   4837:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4838:     if <code class="varname">OBJMACHINE</code> is set.</p>
                   4839: </div>
                   4840: <div class="sect1" lang="en">
                   4841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4842: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1       dsieger  4843: </h2></div></div></div>
                   4844: <p>If you have any files that you wish to be placed in the package prior
                   4845:     to configuration or building, you could place these files here and use
1.10      hubertf  4846:     a <span class="command"><strong>${CP}</strong></span> command in the
1.1       dsieger  4847:     &#8220;<span class="quote">pre-configure</span>&#8221; target to achieve
                   4848:     this. Alternatively, you could simply diff the file against
                   4849:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4850:     the creation of this file.</p>
                   4851: <p>If you want to share files in this way with other
                   4852:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4853:     to the other package's <code class="filename">files</code> directory,
                   4854:     e.g.:</p>
                   4855: <pre class="programlisting">
                   4856: FILESDIR=${.CURDIR}/../xemacs/files
                   4857: </pre>
                   4858: </div>
                   4859: </div>
                   4860: <div class="chapter" lang="en">
                   4861: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4862: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  4863: <div class="toc">
                   4864: <p><b>Table of Contents</b></p>
                   4865: <dl>
1.6       rillig   4866: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.15      rillig   4867: <dt><span class="sect1"><a href="#makefile.variables">12.2. Makefile variables</a></span></dt>
1.6       rillig   4868: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4869: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4870: <dd><dl>
                   4871: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
                   4872: <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
                   4873: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
                   4874: <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
                   4875: <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
1.1       dsieger  4876: </dl></dd>
                   4877: </dl>
                   4878: </div>
                   4879: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   4880:   each of which forms a well-defined part of the pkgsrc system. Using
1.10      hubertf  4881:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1       dsieger  4882:   like pkgsrc requires some discipline to keep the code correct and
                   4883:   understandable.</p>
                   4884: <p>The basic ingredients for <code class="filename">Makefile</code>
                   4885:   programming are variables (which are actually macros) and shell
                   4886:   commands. Among these shell commands may even be more complex ones
1.10      hubertf  4887:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1       dsieger  4888:   as intended it is necessary to quote all variables correctly when they
                   4889:   are used.</p>
                   4890: <p>This chapter describes some patterns, that appear quite often in
                   4891:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   4892:   with them.</p>
                   4893: <div class="sect1" lang="en">
                   4894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4895: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.1       dsieger  4896: <div class="itemizedlist"><ul type="disc"><li>
                   4897: <p>When you are creating a file as a
                   4898:     target of a rule, always write the data to a temporary file first
                   4899:     and finally rename that file. Otherwise there might occur an error
                   4900:     in the middle of generating the file, and when the user runs
1.10      hubertf  4901:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1       dsieger  4902:     regenerated properly. Example:</p>
                   4903: <pre class="programlisting">
                   4904: wrong:
                   4905:         @echo "line 1" &gt; ${.TARGET}
                   4906:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4907:         @false
                   4908: 
                   4909: correct:
                   4910:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4911:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4912:         @false
                   4913:         @mv ${.TARGET}.tmp ${.TARGET}
                   4914: </pre>
1.10      hubertf  4915: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1       dsieger  4916:     <code class="filename">wrong</code> will exist, although there was an error
1.10      hubertf  4917:     message in the first run. On the other hand, running <span class="command"><strong>make
1.1       dsieger  4918:     correct</strong></span> gives an error message twice, as expected.</p>
1.10      hubertf  4919: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1       dsieger  4920:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4921:     happens when it is interrupted, for example by pressing
                   4922:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.10      hubertf  4923:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1       dsieger  4924: </li></ul></div>
                   4925: </div>
                   4926: <div class="sect1" lang="en">
                   4927: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4928: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1       dsieger  4929: <p><code class="filename">Makefile</code> variables contain strings that
                   4930:     can be processed using the five operators ``='', ``+='', ``?='',
1.10      hubertf  4931:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1       dsieger  4932:     page.</p>
                   4933: <p>When a variable's value is parsed from a
                   4934:     <code class="filename">Makefile</code>, the hash character ``#'' and the
                   4935:     backslash character ``\'' are handled specially. If a backslash is
                   4936:     followed by a newline, any whitespace immediately in front of the
                   4937:     backslash, the backslash, the newline, and any whitespace
                   4938:     immediately behind the newline are replaced with a single space. A
                   4939:     backslash character and an immediately following hash character are
                   4940:     replaced with a single hash character. Otherwise, the backslash is
                   4941:     passed as is. In a variable assignment, any hash character that is
                   4942:     not preceded by a backslash starts a comment that continues upto the
                   4943:     end of the logical line.</p>
                   4944: <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
                   4945:     the only way to create a variable consisting of a single backslash
                   4946:     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
                   4947: <p>So far for defining variables. The other thing you can do with
                   4948:     variables is evaluating them. A variable is evaluated when it is
                   4949:     part of the right side of the ``:='' or the ``!='' operator, or
                   4950:     directly before executing a shell command which the variable is part
1.10      hubertf  4951:     of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
1.1       dsieger  4952:     is, variables are not evaluated until there's no other way. The
                   4953:     ``modifiers'' mentioned in the man page also evaluate the
                   4954:     variable.</p>
                   4955: <p>Some of the modifiers split the string into words and then
                   4956:     operate on the words, others operate on the string as a whole. When
                   4957:     a string is split into words, it is split as you would expect
1.10      hubertf  4958:     it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.14      jmcneill 4959: <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
1.1       dsieger  4960:     loop does not follow the shell quoting rules but splits at sequences
                   4961:     of whitespace.</p>
                   4962: <p>There are several types of variables that should be handled
                   4963:     differently. Strings and two types of lists.</p>
                   4964: <div class="itemizedlist"><ul type="disc">
                   4965: <li><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
                   4966:       characters. Nevertheless, you should restrict yourself to only
                   4967:       using printable characters. Examples are
                   4968:       <code class="varname">PREFIX</code> and
                   4969:       <code class="varname">COMMENT</code>.</p></li>
                   4970: <li><p><span class="emphasis"><em>Internal lists</em></span> are lists that
                   4971:       are never exported to any shell command. Their elements are
                   4972:       separated by whitespace. Therefore, the elements themselves cannot
                   4973:       have embedded whitespace. Any other characters are allowed.
1.10      hubertf  4974:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1       dsieger  4975:       Examples are <code class="varname">DEPENDS</code> and
                   4976:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
                   4977: <li><p><span class="emphasis"><em>External lists</em></span> are lists that
                   4978:       may be exported to a shell command. Their elements can contain any
                   4979:       characters, including whitespace. That's why they cannot be used
1.10      hubertf  4980:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1       dsieger  4981:       <code class="varname">DISTFILES</code> and
                   4982:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4983: </ul></div>
                   4984: <div class="sect2" lang="en">
                   4985: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4986: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.1       dsieger  4987: <div class="itemizedlist"><ul type="disc">
                   4988: <li><p>All variable names starting with an underscore
                   4989:        are reserved for use by the pkgsrc infrastructure. They shall
                   4990:        not be used by package
                   4991:        <code class="filename">Makefile</code>s.</p></li>
1.10      hubertf  4992: <li><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1       dsieger  4993:        lowercase variable names for the iteration
                   4994:        variables.</p></li>
                   4995: <li><p>All list variables should have a ``plural''
                   4996:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4997:        <code class="varname">DISTFILES</code>.</p></li>
                   4998: </ul></div>
                   4999: </div>
                   5000: </div>
                   5001: <div class="sect1" lang="en">
                   5002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5003: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.1       dsieger  5004: <p>This section presents you with some code snippets you should
                   5005:     use in your own code. If you don't find anything appropriate here,
                   5006:     you should test your code and add it here.</p>
                   5007: <div class="sect2" lang="en">
                   5008: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5009: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.1       dsieger  5010: <pre class="programlisting">
                   5011: STRING=                 foo * bar `date`
                   5012: INT_LIST=               # empty
                   5013: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   5014: EXT_LIST=               # empty
                   5015: ANOTHER_EXT_LIST=       a=b c=d
                   5016: 
                   5017: INT_LIST+=              ${STRING}               # 1
                   5018: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   5019: EXT_LIST+=              ${STRING:Q}             # 3
                   5020: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
                   5021: </pre>
                   5022: <p>When you add a string to an external list (example 3), it
                   5023:       must be quoted. In all other cases, you must not add a quoting
                   5024:       level. You must not merge internal and external lists, unless you
                   5025:       are sure that all entries are correctly interpreted in both
                   5026:       lists.</p>
                   5027: </div>
                   5028: <div class="sect2" lang="en">
                   5029: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5030: <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
1.1       dsieger  5031: <pre class="programlisting">
                   5032: EXT_LIST=       # empty
                   5033: .for i in ${INT_LIST}
                   5034: EXT_LIST+=      ${i:Q}""
                   5035: .endfor
                   5036: </pre>
                   5037: <p>This code converts the internal list
                   5038:       <code class="varname">INT_LIST</code> into the external list
                   5039:       <code class="varname">EXT_LIST</code>. As the elements of an internal list
                   5040:       are unquoted they must be quoted here. The reason for appending
                   5041:       <code class="varname">""</code> is explained below.</p>
                   5042: </div>
                   5043: <div class="sect2" lang="en">
                   5044: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5045: <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
1.1       dsieger  5046: <p>Sometimes you may want to print an arbitrary string. There
                   5047:        are many ways to get it wrong and only few that can handle every
                   5048:        nastiness.</p>
                   5049: <pre class="programlisting">
                   5050: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5051: EXT_LIST=       string=${STRING:Q} x=second\ item
                   5052: 
                   5053: all:
                   5054:         echo ${STRING}                  # 1
                   5055:         echo "${STRING}"                # 2
                   5056:         echo "${STRING:Q}"              # 3
                   5057:         echo ${STRING:Q}                # 4
                   5058:         echo x${STRING:Q} | sed 1s,.,,  # 5
                   5059:         printf "%s\\n" ${STRING:Q}""    # 6
                   5060:         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
                   5061: </pre>
                   5062: <p>Example 1 leads to a syntax error in the shell, as the
                   5063:       characters are just copied.</p>
                   5064: <p>Example 2 leads to a syntax error too, and if you leave out
                   5065:       the last " character from <code class="varname">${STRING}</code>,
1.10      hubertf  5066:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
1.1       dsieger  5067:       variable would be evaluated, too.</p>
                   5068: <p>Example 3 outputs each space character preceded by a
                   5069:       backslash (or not), depending on the implementation of the
1.10      hubertf  5070:       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
1.1       dsieger  5071: <p>Example 4 handles correctly every string that does not start
                   5072:       with a dash. In that case, the result depends on the
1.10      hubertf  5073:       implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
1.1       dsieger  5074:       guarantee that your input does not start with a dash, this form is
                   5075:       appropriate.</p>
                   5076: <p>Example 5 handles even the case of a leading dash
                   5077:       correctly.</p>
                   5078: <p>Example 6 also works with every string and is the
                   5079:       light-weight solution, since it does not involve a pipe, which has
                   5080:       its own problems.</p>
                   5081: <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
                   5082:       because the quoting has already been done when adding elements to
                   5083:       the list.</p>
                   5084: <p>As internal lists shall not be passed to the shell, there is
                   5085:       no example for it.</p>
                   5086: </div>
                   5087: <div class="sect2" lang="en">
                   5088: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5089: <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
1.1       dsieger  5090: <p>There are many possible sources of wrongly quoted variables.
                   5091:       This section lists some of the commonly known ones.</p>
                   5092: <div class="itemizedlist"><ul type="disc">
                   5093: <li>
                   5094: <p>Whenever you use the value of a list, think
                   5095:        about what happens to leading or trailing whitespace. If the
                   5096:        list is a well-formed shell expression, you can apply the
                   5097:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   5098:        whitespace from each word. The <code class="varname">:M</code> operator
                   5099:        first splits its argument according to the rules of the shell,
                   5100:        and then creates a new list consisting of all words that match
                   5101:        the shell glob expression <code class="varname">*</code>, that is: all.
                   5102:        One class of situations where this is needed is when adding a
                   5103:        variable like <code class="varname">CPPFLAGS</code> to
                   5104:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   5105:        invokes other configure scripts, it strips the leading and
                   5106:        trailing whitespace from the variable and then passes it to the
                   5107:        other configure scripts. But these configure scripts expect the
                   5108:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   5109:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   5110:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   5111:        here is how we do it:</p>
                   5112: <pre class="programlisting">
                   5113: CPPFLAGS=               # empty
                   5114: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   5115: CPPFLAGS+=              ${MY_CPPFLAGS}
                   5116: 
                   5117: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   5118: 
                   5119: all:
                   5120:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5121:         echo x${CONFIGURE_ARGS}x        # properly trimmed
                   5122: </pre>
                   5123: </li>
                   5124: <li><p>The example above contains one bug: The
                   5125:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   5126:        expression, but there is the C compiler after it, which also
                   5127:        expects a properly quoted string (this time in C syntax). The
                   5128:        version above is therefore only correct if
                   5129:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   5130:        or double quotes. If you want to allow these, you have to add
                   5131:        another layer of quoting to each variable that is used as a C
                   5132:        string literal. You cannot use the <code class="varname">:Q</code>
                   5133:        operator for it, as this operator only works for the
                   5134:        shell.</p></li>
                   5135: <li>
                   5136: <p>Whenever a variable can be empty, the
                   5137:        <code class="varname">:Q</code> operator can have surprising results. Here
                   5138:        are two completely different cases which can be solved with the
                   5139:        same trick.</p>
                   5140: <pre class="programlisting">
                   5141: EMPTY=                  # empty
                   5142: empty_test:
                   5143:         for i in a ${EMPTY:Q} c; do \
                   5144:             echo "$$i"; \
                   5145:         done
                   5146: 
                   5147: for_test:
                   5148: .for i in a:\ a:\test.txt
                   5149:         echo ${i:Q}
                   5150:         echo "foo"
                   5151: .endfor
                   5152: </pre>
                   5153: <p>The first example will only print two of the three lines
                   5154:        we might have expected. This is because
                   5155:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   5156:        the shell cannot see. The workaround is to write
                   5157:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   5158:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   5159:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   5160: <p>The second example will only print three lines instead of
                   5161:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   5162:        This is because the backslash of the value
                   5163:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.10      hubertf  5164:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
                   5165:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
1.1       dsieger  5166:        <code class="varname">${i:Q}""</code>.</p>
                   5167: </li>
                   5168: </ul></div>
                   5169: </div>
                   5170: <div class="sect2" lang="en">
                   5171: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5172: <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
1.1       dsieger  5173: <p>The pkgsrc bmake program does not handle the following
                   5174:       assignment correctly. In case <code class="varname">_othervar_</code>
                   5175:       contains a ``-'' character, one of the closing braces is included
                   5176:       in <code class="varname">${VAR}</code> after this code executes.</p>
                   5177: <pre class="programlisting">
                   5178: VAR:=   ${VAR:N${_othervar_:C/-//}}
                   5179: </pre>
                   5180: <p>For a more complex code snippet and a workaround, see the
                   5181:       package <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/regress/make-quoting/README.html" target="_top"><code class="filename">regress/make-quoting</code></a>, testcase
                   5182:       <code class="varname">bug1</code>.</p>
                   5183: </div>
                   5184: </div>
                   5185: </div>
                   5186: <div class="chapter" lang="en">
                   5187: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5188: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1       dsieger  5189: <div class="toc">
                   5190: <p><b>Table of Contents</b></p>
                   5191: <dl>
1.6       rillig   5192: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.15      rillig   5193: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic PLIST generation</a></span></dt>
                   5194: <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of make print-PLIST</a></span></dt>
1.6       rillig   5195: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   5196: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.15      rillig   5197: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with PLIST_SRC</a></span></dt>
1.6       rillig   5198: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
                   5199: <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
1.1       dsieger  5200: </dl>
                   5201: </div>
                   5202: <p>The <code class="filename">PLIST</code> file contains a package's
                   5203:   &#8220;<span class="quote">packing list</span>&#8221;, i.e. a list of files that belong to
                   5204:   the package (relative to the <code class="filename">${PREFIX}</code>
                   5205:   directory it's been installed in) plus some additional statements
1.10      hubertf  5206:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1       dsieger  5207:   This chapter addresses some issues that need attention when
                   5208:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   5209:   below!).</p>
                   5210: <div class="sect1" lang="en">
                   5211: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5212: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1       dsieger  5213: <p>Be sure to add a RCS ID line as the first thing in any
                   5214:     <code class="filename">PLIST</code> file you write:</p>
                   5215: <pre class="programlisting">
                   5216: @comment $NetBSD$
                   5217:     </pre>
                   5218: </div>
                   5219: <div class="sect1" lang="en">
                   5220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5221: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10      hubertf  5222: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1       dsieger  5223:     to output a PLIST that matches any new files since the package
1.10      hubertf  5224:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a> for
1.1       dsieger  5225:     more information on this target.</p>
                   5226: </div>
                   5227: <div class="sect1" lang="en">
                   5228: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  5229: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  5230: </h2></div></div></div>
                   5231: <p>If you have used any of the *-dirs packages, as explained in
1.10      hubertf  5232:     <a class="xref" href="#faq.common-dirs" title="13.8. Sharing directories between packages">Section 13.8, &#8220;Sharing directories between packages&#8221;</a>, you may have noticed that
                   5233:     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
1.1       dsieger  5234:     <code class="varname">@comment</code>s instead of real
                   5235:     <code class="varname">@dirrm</code> lines.  You can also do this for
                   5236:     specific directories and files, so that the results of that
                   5237:     command are very close to reality. This helps <span class="emphasis"><em>a
                   5238:     lot</em></span> during the update of packages.</p>
                   5239: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   5240:     of AWK patterns and actions that are used to filter the output of
                   5241:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   5242:     scripting you like to it, but be careful with quoting.</p>
                   5243: <p>For example, to get all files inside the
                   5244:     <code class="filename">libdata/foo</code> directory removed from the
                   5245:     resulting PLIST:</p>
                   5246: <pre class="programlisting">
                   5247: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
                   5248:     </pre>
                   5249: <p>And to get all the <code class="varname">@dirrm</code> lines referring
                   5250:     to a specific (shared) directory converted to
                   5251:     <code class="varname">@comment</code>s:</p>
                   5252: <pre class="programlisting">
                   5253: PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
                   5254:     </pre>
                   5255: </div>
                   5256: <div class="sect1" lang="en">
                   5257: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5258: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1       dsieger  5259: <p>A number of variables are substituted automatically in
                   5260:     PLISTs when a package is installed on a system. This includes the
                   5261:     following variables:</p>
                   5262: <div class="variablelist"><dl>
                   5263: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   5264: <dd>
                   5265: <p>Some packages like emacs and perl embed information
                   5266:          about which architecture they were built on into the
                   5267:          pathnames where they install their files. To handle this
                   5268:          case, PLIST will be preprocessed before actually used, and
                   5269:          the symbol
                   5270:          &#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221; will be
1.10      hubertf  5271:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1       dsieger  5272:          same is done if the string
                   5273:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   5274:          PLIST somewhere - use this on packages that have GNU
                   5275:          autoconf-created configure scripts.</p>
                   5276: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   5277: <h3 class="title">Legacy note</h3>
                   5278: <p>There used to be a symbol
                   5279:            &#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221; that
1.10      hubertf  5280:            was replaced by the output of <span class="command"><strong>uname
1.1       dsieger  5281:            -m</strong></span>, but that's no longer supported and has
                   5282:            been removed.</p>
                   5283: </div>
                   5284: </dd>
                   5285: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   5286: <dd>
                   5287: <p>Some packages want to embed the OS name and version
                   5288:          into some paths.  To do this, use these variables in the
                   5289:          <code class="filename">PLIST</code>:
                   5290:          </p>
                   5291: <div class="itemizedlist"><ul type="disc">
1.10      hubertf  5292: <li><p><code class="varname">${OPSYS}</code> - output of &#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</p></li>
1.1       dsieger  5293: <li><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. &#8220;<span class="quote">solaris</span>&#8221;)</p></li>
1.10      hubertf  5294: <li><p><code class="varname">${OS_VERSION}</code> - &#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</p></li>
1.1       dsieger  5295: </ul></div>
                   5296: </dd>
                   5297: </dl></div>
                   5298: <p>For a complete list of values which are replaced by
                   5299:     default, please look in <code class="filename">bsd.pkg.mk</code> (and
                   5300:     search for <code class="varname">PLIST_SUBST</code>).</p>
                   5301: <p>If you want to change other variables not listed above, you
                   5302:     can add variables and their expansions to this variable in the
1.10      hubertf  5303:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, &#8220;Optional files&#8221;</a>):</p>
1.1       dsieger  5304: <pre class="programlisting">
                   5305: PLIST_SUBST+=   SOMEVAR="somevalue"
                   5306:     </pre>
                   5307: <p>This replaces all occurrences of &#8220;<span class="quote">${SOMEVAR}</span>&#8221;
                   5308:     in the <code class="filename">PLIST</code> with
                   5309:     &#8220;<span class="quote">somevalue</span>&#8221;.</p>
                   5310: </div>
                   5311: <div class="sect1" lang="en">
                   5312: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5313: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1       dsieger  5314: <p>Man pages should be installed in compressed form if
                   5315:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   5316:     and uncompressed otherwise. To handle this in the
                   5317:     <code class="filename">PLIST</code> file, the suffix &#8220;<span class="quote">.gz</span>&#8221; is
                   5318:     appended/removed automatically for man pages according to
                   5319:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   5320:     or not, see above for details. This modification of the
                   5321:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   5322:     <code class="filename">PLIST</code> itself.</p>
                   5323: </div>
                   5324: <div class="sect1" lang="en">
                   5325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5326: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1       dsieger  5327: </h2></div></div></div>
                   5328: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   5329:     in generating the binary package, set the variable
                   5330:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.10      hubertf  5331:     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.1       dsieger  5332:     important. The default for <code class="varname">PLIST_SRC</code> is
                   5333:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
                   5334: </div>
                   5335: <div class="sect1" lang="en">
                   5336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5337: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1       dsieger  5338: <p>Some packages decide to install a different set of files based on
                   5339:     the operating system being used. These differences can be
                   5340:     automatically handled by using the following files:</p>
                   5341: <div class="itemizedlist"><ul type="disc">
                   5342: <li><p><code class="filename">PLIST.common</code></p></li>
                   5343: <li><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   5344: <li><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   5345: <li><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   5346: <li><p><code class="filename">PLIST.common_end</code></p></li>
                   5347: </ul></div>
                   5348: </div>
                   5349: <div class="sect1" lang="en">
                   5350: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5351: <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
1.1       dsieger  5352: <p>A &#8220;<span class="quote">shared directory</span>&#8221; is a directory where
                   5353:     multiple (and unrelated) packages install files.  These
                   5354:     directories are problematic because you have to add special tricks
                   5355:     in the PLIST to conditionally remove them, or have some
                   5356:     centralized package handle them.</p>
                   5357: <p>Within pkgsrc, you'll find both approaches.  If a directory
                   5358:     is shared by a few unrelated packages, it's often not worth to add
                   5359:     an extra package to remove it.  Therefore, one simply does:</p>
                   5360: <pre class="programlisting">
                   5361: @unexec ${RMDIR} %D/path/to/shared/directory 2&gt;/dev/null || ${TRUE}
                   5362:     </pre>
                   5363: <p>in the PLISTs of all affected packages, instead of the
                   5364:     regular "@dirrm" line.</p>
                   5365: <p>However, if the directory is shared across many packages, two
                   5366:     different solutions are available:</p>
                   5367: <div class="orderedlist"><ol type="1">
                   5368: <li><p>If the packages have a common dependency, the directory
                   5369:        can be removed in that.  For example, see
                   5370:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/scrollkeeper/README.html" target="_top"><code class="filename">textproc/scrollkeeper</code></a>, which
                   5371:        removes the shared directory
                   5372:        <code class="filename">share/omf</code>.</p></li>
                   5373: <li><p>If the packages using the directory are not related at
                   5374:        all (they have no common dependencies), a *-dirs package is
                   5375:        used.</p></li>
                   5376: </ol></div>
                   5377: <p>From now on, we'll discuss the second solution.  To get an
                   5378:     idea of the *-dirs packages available, issue:</p>
                   5379: <pre class="programlisting">
                   5380: <code class="prompt">%</code> cd .../pkgsrc
                   5381: <code class="prompt">%</code> ls -d */*-dirs
                   5382:     </pre>
                   5383: <p>Their use from other packages is very simple.  The
                   5384:     <code class="varname">USE_DIRS</code> variable takes a list of package names
                   5385:     (without the &#8220;<span class="quote">-dirs</span>&#8221; part) together with the required
                   5386:     version number (always pick the latest one when writing new
                   5387:     packages).</p>
                   5388: <p>For example, if a package installs files under
                   5389:     <code class="filename">share/applications</code>, it should have the
                   5390:     following line in it:</p>
                   5391: <pre class="programlisting">
                   5392: USE_DIRS+=      xdg-1.1
                   5393:     </pre>
1.10      hubertf  5394: <p>After regenerating the PLIST using <span class="command"><strong>make
1.1       dsieger  5395:     print-PLIST</strong></span>, you should get the right (commented out)
                   5396:     lines.</p>
                   5397: <p>Note that even if your package is using
                   5398:     <code class="filename">$X11BASE</code>, it must not depend on the
                   5399:     *-x11-dirs packages.  Just specify the name without that part and
                   5400:     pkgsrc (in particular, <code class="filename">mk/dirs.mk</code>) will take
                   5401:     care of it.</p>
                   5402: </div>
                   5403: </div>
                   5404: <div class="chapter" lang="en">
                   5405: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5406: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1       dsieger  5407: <div class="toc">
                   5408: <p><b>Table of Contents</b></p>
                   5409: <dl>
1.6       rillig   5410: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.15      rillig   5411: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing buildlink3.mk files</a></span></dt>
1.1       dsieger  5412: <dd><dl>
1.6       rillig   5413: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.15      rillig   5414: <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.1       dsieger  5415: </dl></dd>
1.15      rillig   5416: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing builtin.mk files</a></span></dt>
1.1       dsieger  5417: <dd><dl>
1.15      rillig   5418: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a builtin.mk file</a></span></dt>
1.6       rillig   5419: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1       dsieger  5420: </dl></dd>
                   5421: </dl>
                   5422: </div>
                   5423: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   5424:   are seen by a package's configure and build processes.  This is implemented
                   5425:   in a two step process:</p>
                   5426: <div class="orderedlist"><ol type="1">
                   5427: <li><p>Symlink headers and libraries for dependencies into
                   5428:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5429:       of <code class="varname">WRKDIR</code>.</p></li>
                   5430: <li><p>Create wrapper scripts that are used in place of the normal compiler
                   5431:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5432:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5433:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5434:       native compiler on some operating systems look like GCC, so that
                   5435:       packages that expect GCC won't require modifications to build with
                   5436:       those native compilers.</p></li>
                   5437: </ol></div>
                   5438: <p>This normalizes the environment in which a package is built so that the
                   5439:   package may be built consistently despite what other software may be
                   5440:   installed. Please note that the normal system header and library paths,
                   5441:   e.g. <code class="filename">/usr/include</code>,
                   5442:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5443:   designed to insulate the package build from non-system-supplied
                   5444:   software.</p>
                   5445: <div class="sect1" lang="en">
                   5446: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5447: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1       dsieger  5448: <p>The process of converting packages to use the buildlink3
                   5449:     framework (&#8220;<span class="quote">bl3ifying</span>&#8221;) is fairly straightforward.
                   5450:     The things to keep in mind are:</p>
                   5451: <div class="orderedlist"><ol type="1">
                   5452: <li><p>Ensure that the build always calls the wrapper scripts
                   5453:        instead of the actual toolchain.  Some packages are tricky,
                   5454:        and the only way to know for sure is the check
                   5455:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5456:        wrappers are being invoked.</p></li>
                   5457: <li><p>Don't override <code class="varname">PREFIX</code> from within
                   5458:        the package Makefile, e.g. Java VMs, standalone shells,
                   5459:        etc., because the code to symlink files into
                   5460:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   5461:        relative to &#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;.
                   5462:        </p></li>
                   5463: <li><p>Remember that <span class="emphasis"><em>only</em></span> the
                   5464:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5465:        package's Makefile are added as dependencies for that package.
                   5466:        </p></li>
                   5467: </ol></div>
                   5468: <p>If a dependency on a particular package is required for its libraries and
                   5469:     headers, then we replace:</p>
                   5470: <pre class="programlisting">
                   5471: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5472: </pre>
                   5473: <p>with</p>
                   5474: <pre class="programlisting">
                   5475: .include "../../category/foo/buildlink3.mk"
                   5476: </pre>
                   5477: <p>The buildlink3.mk files usually define the required dependencies.
                   5478:     If you need a newer version of the dependency when using buildlink3.mk
                   5479:     files, then you can define it in your Makefile; for example:</p>
                   5480: <pre class="programlisting">
                   5481: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5482: .include "../../category/foo/buildlink3.mk"
                   5483: </pre>
                   5484: <p>There are several <code class="filename">buildlink3.mk</code>
                   5485:     files in <code class="filename">pkgsrc/mk</code>
                   5486:     that handle special package issues:</p>
                   5487: <div class="itemizedlist"><ul type="disc">
                   5488: <li><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   5489:        the native or a pkgsrc Berkeley DB implementation based on
                   5490:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5491:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   5492: <li><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   5493:        comes with neither Curses nor NCurses, this will take care
                   5494:        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>
                   5495: <li><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   5496:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5497:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5498:        require a Kerberos 5 implementation.</p></li>
                   5499: <li><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   5500:        system-provided Motif installation or adds a dependency on
                   5501:        <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
                   5502:        <code class="varname">MOTIF_TYPE</code> to &#8220;<span class="quote">dt</span>&#8221;,
                   5503:        &#8220;<span class="quote">lesstif</span>&#8221;, or &#8220;<span class="quote">openmotif</span>&#8221; to choose
                   5504:        which Motif version will be used.</p></li>
                   5505: <li><p><code class="filename">oss.buildlink3.mk</code> defines several
                   5506:        variables that may be used by packages that use the
                   5507:        Open Sound System (OSS) API.</p></li>
                   5508: <li><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   5509:        either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
                   5510:        the file for more information.</p></li>
                   5511: <li><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   5512:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   5513:        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>
                   5514: <li><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   5515:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5516:        library.</p></li>
                   5517: </ul></div>
                   5518: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   5519:     files provide a more complete
                   5520:     description of how to use them properly.</p>
                   5521: </div>
                   5522: <div class="sect1" lang="en">
                   5523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5524: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7       rillig   5525: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1       dsieger  5526:     included by Makefiles to indicate the need to compile and link
                   5527:     against header files and libraries provided by the package.  A
                   5528:     <code class="filename">buildlink3.mk</code> file should always provide
                   5529:     enough information to add the correct type of dependency
                   5530:     relationship and include any other
                   5531:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5532:     headers and libraries that it needs in turn.</p>
                   5533: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   5534:     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>
                   5535:     package is highly recommended.  For most packages, the following
                   5536:     command will generate a good starting point for
                   5537:     <code class="filename">buildlink3.mk</code> files:</p>
                   5538: <pre class="screen">
                   5539: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5540: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5541:     </pre>
                   5542: <div class="sect2" lang="en">
                   5543: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5544: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1       dsieger  5545: <p>The following real-life example
                   5546:       <code class="filename">buildlink3.mk</code> is taken
                   5547:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
                   5548: <pre class="programlisting">
                   5549: # $NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp $
                   5550: 
                   5551: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
                   5552: TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
                   5553: 
                   5554: .if ${BUILDLINK_DEPTH} == "+"
                   5555: BUILDLINK_DEPENDS+=     tiff
                   5556: .endif
                   5557: 
                   5558: BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
                   5559: BUILDLINK_PACKAGES+=    tiff
                   5560: 
                   5561: .if ${TIFF_BUILDLINK3_MK} == "+"
                   5562: BUILDLINK_API_DEPENDS.tiff+=        tiff&gt;=3.6.1
                   5563: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   5564: .endif  # TIFF_BUILDLINK3_MK
                   5565: 
                   5566: .include "../../devel/zlib/buildlink3.mk"
                   5567: .include "../../graphics/jpeg/buildlink3.mk"
                   5568: 
                   5569: BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
                   5570: </pre>
                   5571: <p>The header and footer manipulate
                   5572:       <code class="varname">BUILDLINK_DEPTH</code>, which is common across all
                   5573:       <code class="filename">buildlink3.mk</code> files and is used to track
                   5574:       at what depth we are including
                   5575:       <code class="filename">buildlink3.mk</code> files.</p>
                   5576: <p>The first section controls if the dependency on
                   5577:       <em class="replaceable"><code>pkg</code></em> is added.
                   5578:       <code class="varname">BUILDLINK_DEPENDS</code> is the global list of
                   5579:       packages for which dependencies are added by
                   5580:       buildlink3.</p>
                   5581: <p>The second section advises pkgsrc that the
                   5582:       <code class="filename">buildlink3.mk</code> file for
                   5583:       <em class="replaceable"><code>pkg</code></em> has been included at some point.
                   5584:       <code class="varname">BUILDLINK_PACKAGES</code> is the global list of
                   5585:       packages for which <code class="filename">buildlink3.mk</code> files
                   5586:       have been included.  It must <span class="emphasis"><em>always</em></span> be
                   5587:       appended to within a <code class="filename">buildlink3.mk</code>
                   5588:       file.</p>
                   5589: <p>The third section is protected from multiple inclusion
                   5590:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5591:       added.  Several important variables are set in the section:</p>
                   5592: <div class="itemizedlist"><ul type="disc">
                   5593: <li><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5594:          is the actual dependency recorded in the installed
                   5595:          package; this should always be set using
1.10      hubertf  5596:          <span class="command"><strong>+=</strong></span> to ensure that
1.1       dsieger  5597:          we're appending to any pre-existing list of values.  This
                   5598:          variable should be set to the first version of the
                   5599:          package that had an API change.
                   5600:          </p></li>
                   5601: <li><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   5602:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5603:          pkgsrc directory.</p></li>
                   5604: <li><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5605:          (not shown above) controls whether we use
                   5606:          <code class="varname">BUILD_DEPENDS</code> or
                   5607:          <code class="varname">DEPENDS</code> to add the dependency on
                   5608:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5609:          selected by setting
                   5610:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   5611:          to &#8220;<span class="quote">build</span>&#8221;.  By default, the full dependency is
                   5612:          used.</p></li>
                   5613: <li><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5614:            and
                   5615:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5616:            (not shown above) are lists of subdirectories of
                   5617:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5618:            to add to the header and library search paths.  These
                   5619:            default to &#8220;<span class="quote">include</span>&#8221; and &#8220;<span class="quote">lib</span>&#8221;
                   5620:          respectively.</p></li>
                   5621: <li><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   5622:            (not shown above) is the list of preprocessor flags to add
                   5623:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   5624:            configure and build phases.  The &#8220;<span class="quote">-I</span>&#8221; option
                   5625:            should be avoided and instead be handled using
                   5626:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   5627:          above.</p></li>
                   5628: </ul></div>
                   5629: <p>The following variables are all optionally defined within
                   5630:       this second section (protected against multiple inclusion) and
                   5631:       control which package files are symlinked into
                   5632:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5633:       transformed during the symlinking:</p>
                   5634: <div class="itemizedlist"><ul type="disc">
                   5635: <li><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   5636:            (not shown above) is a shell glob pattern relative to
                   5637:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5638:            to be symlinked into
                   5639:            <code class="filename">${BUILDLINK_DIR}</code>,
                   5640:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   5641: <li><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   5642:            (not shown above) is a shell pipeline that
                   5643:            outputs to stdout a list of files relative to
                   5644:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5645:            The resulting files are to be symlinked
                   5646:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5647:            this takes the <code class="filename">+CONTENTS</code> of a
                   5648:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5649:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   5650: <li><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   5651:            (not shown above) is a filter command that filters
                   5652:            <code class="filename">+CONTENTS</code> input into a list of files
                   5653:            relative to
                   5654:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   5655:            on stdout.  By default for overwrite packages,
                   5656:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   5657:            outputs the contents of the <code class="filename">include</code>
                   5658:            and <code class="filename">lib</code> directories in the package
                   5659:            <code class="filename">+CONTENTS</code>, and for pkgviews packages,
                   5660:            it outputs any libtool archives in
                   5661:            <code class="filename">lib</code> directories.</p></li>
                   5662: <li><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   5663:            (not shown above) is a list of sed arguments used to
                   5664:            transform the name of the source filename into a
1.10      hubertf  5665:            destination filename, e.g. <span class="command"><strong>-e
1.1       dsieger  5666:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   5667: </ul></div>
                   5668: <p>The last section includes any
                   5669:       <code class="filename">buildlink3.mk</code> needed for
                   5670:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5671:       Including these <code class="filename">buildlink3.mk</code> files
                   5672:       means that the headers and libraries for these
                   5673:       dependencies are also symlinked into
                   5674:       <code class="filename">${BUILDLINK_DIR}</code>
                   5675:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5676:       <code class="filename">buildlink3.mk</code>
                   5677:       file is included.</p>
                   5678: </div>
                   5679: <div class="sect2" lang="en">
                   5680: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5681: <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.1       dsieger  5682: <p>The situation that requires increasing the dependency listed in
                   5683:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5684:        after a package update is when the API or interface to the
                   5685:       header files change.</p>
                   5686: <p>In this case,
                   5687:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5688:       should be adjusted to require at least the new package
                   5689:       version.  In some cases, the packages that depend on this new
                   5690:       version may need their <code class="varname">PKGREVISION</code>s
                   5691:       increased and, if they have <code class="filename">buildlink3.mk</code>
                   5692:       files, their
                   5693:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5694:       adjusted, too.  This is needed so pkgsrc will require the
                   5695:       correct package dependency and not settle for an older one
                   5696:       when building the source.</p>
                   5697: <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5698:        should be increased when the binary interface or sonames
                   5699:        (major number of the library version) of any installed
                   5700:        shared libraries change.  This is needed so that binary
                   5701:        packages made using it will require the correct package
                   5702:        dependency and not settle for an older one which will not
                   5703:       contain the necessary shared libraries.</p>
1.10      hubertf  5704: <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
1.1       dsieger  5705:        more information about dependencies on other packages,
                   5706:        including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
                   5707:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5708: <p>Please take careful consideration before adjusting
                   5709:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5710:       or
                   5711:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5712:       as we don't want to cause unneeded package deletions and
                   5713:       rebuilds.  In many cases, new versions of packages work just
                   5714:       fine with older dependencies.</p>
                   5715: <p>Also it is not needed to set
                   5716:        <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5717:        when it is identical to
                   5718:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
                   5719: </div>
                   5720: </div>
                   5721: <div class="sect1" lang="en">
                   5722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5723: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1       dsieger  5724: <p>Some packages in pkgsrc install headers and libraries that
                   5725:       coincide with headers and libraries present in the base system.
                   5726:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5727:       packages should also include a <code class="filename">builtin.mk</code>
                   5728:       file that includes the necessary checks to decide whether using
                   5729:       the built-in software or the pkgsrc software is
                   5730:     appropriate.</p>
                   5731: <p>The only requirements of a builtin.mk file for
                   5732:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   5733: <div class="orderedlist"><ol type="1">
                   5734: <li><p>It should set
                   5735:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5736:        to either &#8220;<span class="quote">yes</span>&#8221; or &#8220;<span class="quote">no</span>&#8221;
                   5737:        after it is included.</p></li>
                   5738: <li><p>It should <span class="emphasis"><em>not</em></span> override any
                   5739:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5740:        which is already set before the
                   5741:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   5742: <li><p>It should be written to allow multiple inclusion.  This
                   5743:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5744:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   5745: </ol></div>
                   5746: <div class="sect2" lang="en">
                   5747: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5748: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1       dsieger  5749: <p>The following is the recommended template for builtin.mk
                   5750:       files:</p>
                   5751: <pre class="programlisting">
                   5752: .if !defined(IS_BUILTIN.foo)
                   5753: #
                   5754: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5755: # genuinely exists in the system or not.
                   5756: #
                   5757: IS_BUILTIN.foo?=        no
                   5758: 
                   5759: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5760: # version can be determined.
                   5761: #
                   5762: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5763: BUILTIN_PKG.foo?=       foo-1.0
                   5764: .  endif
                   5765: .endif  # IS_BUILTIN.foo
                   5766: 
                   5767: .if !defined(USE_BUILTIN.foo)
                   5768: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5769: .  if defined(BUILTIN_PKG.foo)
                   5770: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5771: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5772: USE_BUILTIN.foo!=                                                       \
                   5773:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5774:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5775: .      endif
                   5776: .    endfor
                   5777: .  endif
                   5778: .endif  # USE_BUILTIN.foo
                   5779: 
                   5780: CHECK_BUILTIN.foo?=     no
                   5781: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5782: #
                   5783: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5784: # "yes" or "no".
                   5785: #
                   5786: .endif  # CHECK_BUILTIN.foo
                   5787: </pre>
                   5788: <p>The first section sets
                   5789:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5790:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5791:       in the base system.  This should not be a base system software
                   5792:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   5793:       it should only be &#8220;<span class="quote">yes</span>&#8221; if the actual package is
                   5794:       included as part of the base system.  This variable is only
                   5795:       used internally within the <code class="filename">builtin.mk</code>
                   5796:       file.</p>
                   5797: <p>The second section sets
                   5798:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5799:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5800:       system if it exists (if
                   5801:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5802:       is &#8220;<span class="quote">yes</span>&#8221;).  This variable is only used internally
                   5803:       within the <code class="filename">builtin.mk</code> file.</p>
                   5804: <p>The third section sets
                   5805:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5806:       and is <span class="emphasis"><em>required</em></span> in all
                   5807:       <code class="filename">builtin.mk</code> files.  The code in this
                   5808:       section must make the determination whether the built-in
                   5809:       software is adequate to satisfy the dependencies listed in
                   5810:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5811:       This is typically done by comparing
                   5812:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5813:       against each of the dependencies in
                   5814:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5815:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5816:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5817:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5818:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5819:       may be &#8220;<span class="quote">yes</span>&#8221; even if
                   5820:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5821:       is &#8220;<span class="quote">no</span>&#8221; because we may make the determination
                   5822:       that the built-in version of the software is similar enough to
                   5823:       be used as a replacement.</p>
                   5824: <p>The last section is guarded by
                   5825:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5826:       and includes code that uses the value of
                   5827:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5828:       set in the previous section.  This typically includes, e.g.,
                   5829:       adding additional dependency restrictions and listing additional
                   5830:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5831:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   5832: </div>
                   5833: <div class="sect2" lang="en">
                   5834: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5835: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1       dsieger  5836: <p>When building packages, it's possible to choose whether to set
                   5837:        a global preference for using either the built-in (native)
                   5838:        version or the pkgsrc version of software to satisfy a
                   5839:        dependency.  This is controlled by setting
                   5840:        <code class="varname">PREFER_PKGSRC</code> and
                   5841:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   5842:        of either &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">no</span>&#8221;, or a list of
                   5843:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5844:        use the pkgsrc versions of software, while
                   5845:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5846:        built-in versions.  Preferences are determined by the most
                   5847:        specific instance of the package in either
                   5848:        <code class="varname">PREFER_PKGSRC</code> or
                   5849:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5850:        in neither or in both variables, then
                   5851:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5852:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5853:        using pkgsrc versions of software for all but the most basic
                   5854:       bits on a NetBSD system, you can set:</p>
                   5855: <pre class="programlisting">
                   5856: PREFER_PKGSRC=  yes
                   5857: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5858: </pre>
                   5859: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5860:       <code class="filename">builtin.mk</code>
                   5861:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5862:       otherwise it is simply ignored in that list.</p>
                   5863: </div>
                   5864: </div>
                   5865: </div>
                   5866: <div class="chapter" lang="en">
                   5867: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5868: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1       dsieger  5869: <div class="toc">
                   5870: <p><b>Table of Contents</b></p>
                   5871: <dl>
1.6       rillig   5872: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1       dsieger  5873: <dd><dl>
1.6       rillig   5874: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5875: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1       dsieger  5876: </dl></dd>
1.6       rillig   5877: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1       dsieger  5878: <dd><dl>
1.15      rillig   5879: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How PKG_SYSCONFDIR is set</a></span></dt>
1.6       rillig   5880: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5881: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5882: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5883: </dl></dd>
                   5884: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5885: <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>
                   5886: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5887: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5888: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5889: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5890: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1       dsieger  5891: </dl>
                   5892: </div>
                   5893: <p>This chapter describes the framework known as
                   5894: <code class="literal">pkginstall</code>, whose key features are:</p>
                   5895: <div class="itemizedlist"><ul type="disc">
                   5896: <li><p>Generic installation and manipulation of directories and files
                   5897:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   5898: <li><p>Automatic handling of configuration files during installation,
                   5899:     provided that packages are correctly designed.</p></li>
                   5900: <li><p>Generation and installation of system startup scripts.</p></li>
                   5901: <li><p>Registration of system users and groups.</p></li>
                   5902: <li><p>Registration of system shells.</p></li>
                   5903: <li><p>Automatic updating of fonts databases.</p></li>
                   5904: </ul></div>
                   5905: <p>The following sections inspect each of the above points in detail.</p>
                   5906: <p>You may be thinking that many of the things described here could be
                   5907: easily done with simple code in the package's post-installation target
                   5908: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5909: as the code in them is only executed when building from source.  Machines
                   5910: using binary packages could not benefit from it at all (as the code itself
                   5911: could be unavailable).  Therefore, the only way to achieve any of the items
                   5912: described above is by means of the installation scripts, which are
                   5913: automatically generated by pkginstall.</p>
                   5914: <div class="sect1" lang="en">
                   5915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5916: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1       dsieger  5917: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   5918: of files and directories that belong to a package.  The names used in it
                   5919: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   5920: which means that it cannot register files outside this directory (absolute
                   5921: path names are not allowed).  Despite this restriction, some packages need
                   5922: to install files outside this location; e.g., under
                   5923: <code class="filename">${VARBASE}</code> or
                   5924: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5925: is to create such files during installation time by using
                   5926: installation scripts.</p>
                   5927: <p>The generic installation scripts are shell scripts that can
                   5928: contain arbitrary code.  The list of scripts to execute is taken from
                   5929: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5930: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5931: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5932: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5933: commands, so they have the potential to create and manage files
                   5934: anywhere in the file system.</p>
                   5935: <p>Using these general installation files is not recommended, but
                   5936: may be needed in some special cases.  One reason for avoiding them is
                   5937: that the user has to trust the packager that there is no unwanted or
                   5938: simply erroneous code included in the installation script. Also,
                   5939: previously there were many similar scripts for the same functionality,
                   5940: and fixing a common error involved finding and changing all of
                   5941: them.</p>
                   5942: <p>The pkginstall framework offers another, standardized way.  It
                   5943: provides generic scripts to abstract the manipulation of such files
                   5944: and directories based on variables set in the package's
                   5945: <code class="filename">Makefile</code>.  The rest of this section describes
                   5946: these variables.</p>
                   5947: <div class="sect2" lang="en">
                   5948: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5949: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1       dsieger  5950: <p>The following variables can be set to request the creation of
                   5951: directories anywhere in the file system:</p>
                   5952: <div class="itemizedlist"><ul type="disc">
                   5953: <li><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   5954:     contain a list of directories that should be created and should attempt
                   5955:     to be destroyed by the installation scripts.  The difference between
                   5956:     the two is that the latter prompts the administrator to remove any
                   5957:     directories that may be left after deinstallation (because they were
                   5958:     not empty), while the former does not.</p></li>
                   5959: <li>
                   5960: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5961:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5962:     which directories should be created and should attempt to be destroyed
                   5963:     by the installation scripts.  Each tuple holds the following values,
                   5964:     separated by spaces: the directory name, its owner, its group and its
                   5965:     numerical mode.  For example:</p>
                   5966: <pre class="programlisting">
                   5967: MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
                   5968: </pre>
                   5969: <p>The difference between the two is exactly the same as their
                   5970:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5971: </li>
                   5972: </ul></div>
                   5973: </div>
                   5974: <div class="sect2" lang="en">
                   5975: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5976: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1       dsieger  5977: <p>Creating non-empty files outside the installation prefix is tricky
                   5978: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   5979: To overcome this problem, the only solution is to extract the file in the
                   5980: known place (i.e., inside the installation prefix) and copy it to the
                   5981: appropriate location during installation (done by the installation scripts
                   5982: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5983: file</em></span> in the following paragraphs, which describe the variables
                   5984: that can be used to automatically and consistently handle files outside the
                   5985: installation prefix:</p>
                   5986: <div class="itemizedlist"><ul type="disc">
                   5987: <li>
                   5988: <p><code class="varname">CONF_FILES</code> and
                   5989:     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
                   5990:     During installation time, the master file is copied to the target one
                   5991:     if and only if the latter does not exist.  Upon deinstallation, the
                   5992:     target file is removed provided that it was not modified by the
                   5993:     installation.</p>
                   5994: <p>The difference between the two is that the latter prompts the
                   5995:     administrator to remove any files that may be left after
                   5996:     deinstallation (because they were not empty), while the former does
                   5997:     not.</p>
                   5998: </li>
                   5999: <li>
                   6000: <p><code class="varname">CONF_FILES_PERMS</code> and
                   6001:     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
                   6002:     files as well as their target locations.  For each of them, it also
                   6003:     specifies their owner, their group and their numeric permissions, in
                   6004:     this order.  For example:</p>
                   6005: <pre class="programlisting">
                   6006: SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
                   6007: </pre>
                   6008: <p>The difference between the two is exactly the same as their
                   6009:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6010: </li>
                   6011: </ul></div>
                   6012: </div>
                   6013: </div>
                   6014: <div class="sect1" lang="en">
                   6015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6016: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1       dsieger  6017: <p>Configuration files are special in the sense that they are installed
                   6018: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6019: need special treatment during installation (most of which is automated by
                   6020: pkginstall).  The main concept you must bear in mind is that files marked
                   6021: as configuration files are automatically copied to the right place (somewhere
                   6022: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6023: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6024: be removed if they have local modifications.  This ensures that
                   6025: administrators never lose any custom changes they may have made.</p>
                   6026: <div class="sect2" lang="en">
                   6027: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6028: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1       dsieger  6029: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   6030: specifies where configuration files shall be installed.  Its contents are
                   6031: set based upon the following variables:</p>
                   6032: <div class="itemizedlist"><ul type="disc">
                   6033: <li><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   6034:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   6035:     be overridden by the user to point to his preferred location (e.g.,
                   6036:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   6037:     Packages must not use it directly.</p></li>
                   6038: <li>
                   6039: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   6040:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   6041:     for the package being built shall be installed.  The definition of this
                   6042:     variable only makes sense in the package's
                   6043:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   6044: <p>As an example, consider the Apache package,
                   6045:     <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
                   6046:     configuration files under the
                   6047:     <code class="filename">httpd/</code> subdirectory of
                   6048:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   6049:     Makefile.</p>
                   6050: </li>
                   6051: <li><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   6052:     variable that holds this package's configuration directory (if
                   6053:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   6054:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   6055:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   6056: <li><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   6057:     directory where the configuration files for the package identified by
                   6058:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   6059: </ul></div>
                   6060: <p>Based on the above variables, pkginstall determines the value of
                   6061: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6062: variable that can be used within a package to refer to its configuration
                   6063: directory.  The algorithm used to set its value is basically the
                   6064: following:</p>
                   6065: <div class="orderedlist"><ol type="1">
                   6066: <li><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   6067:     its value is used.</p></li>
                   6068: <li><p>If the previous variable is not defined but
                   6069:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   6070:     <code class="filename">Makefile</code>, the resulting value is
                   6071:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   6072: <li><p>Otherwise, it is set to
                   6073:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   6074: </ol></div>
                   6075: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16      jnemeth  6076: 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
                   6077: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6078: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1       dsieger  6079: </div>
                   6080: <div class="sect2" lang="en">
                   6081: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6082: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1       dsieger  6083: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   6084: known place, you need to teach each package where it shall install its
                   6085: files.  In some cases you will have to patch the package Makefiles to
                   6086: achieve it.  If you are lucky, though, it may be as easy as passing an
                   6087: extra flag to the configuration script; this is the case of GNU Autoconf-
                   6088: generated files:</p>
                   6089: <pre class="programlisting">
                   6090: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   6091: </pre>
                   6092: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   6093: for</em></span> its configuration files, not where they will be originally
                   6094: installed (although the difference is never explicit,
                   6095: unfortunately).</p>
                   6096: </div>
                   6097: <div class="sect2" lang="en">
                   6098: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6099: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1       dsieger  6100: <p>As said before, pkginstall automatically handles configuration files.
                   6101: This means that <span class="strong"><strong>the packages themselves must not
                   6102: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   6103: directly</strong></span>.  Bad news is that many software installation scripts
                   6104: will, out of the box, mess with the contents of that directory.  So what is
                   6105: the correct procedure to fix this issue?</p>
                   6106: <p>You must teach the package (usually by manually patching it) to
                   6107: install any configuration files under the examples hierarchy,
                   6108: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   6109: <code class="filename">PLIST</code> registers them and the administrator always
                   6110: has the original copies available.</p>
                   6111: <p>Once the required configuration files are in place (i.e., under the
                   6112: examples hierarchy), the pkginstall framework can use them as master copies
                   6113: during the package installation to update what is in
                   6114: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   6115: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10      hubertf  6116: used.  Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, &#8220;File manipulation&#8221;</a> for information
1.1       dsieger  6117: about their syntax and their purpose.  Here is an example, taken from the
                   6118: <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>
                   6119: <pre class="programlisting">
                   6120: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   6121: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   6122: </pre>
                   6123: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   6124: package and has no meaning outside it.</p>
                   6125: </div>
                   6126: <div class="sect2" lang="en">
                   6127: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6128: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1       dsieger  6129: <p>The automatic copying of config files can be toggled by setting the
                   6130: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   6131: installation.</p>
                   6132: </div>
                   6133: </div>
                   6134: <div class="sect1" lang="en">
                   6135: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6136: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1       dsieger  6137: <p>System startup scripts are special files because they must be
                   6138: installed in a place known by the underlying OS, usually outside the
1.10      hubertf  6139: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.1       dsieger  6140: can be used.  However, pkginstall provides a special mechanism to handle
                   6141: these files.</p>
                   6142: <p>In order to provide system startup scripts, the package has
                   6143: to:</p>
                   6144: <div class="orderedlist"><ol type="1">
                   6145: <li><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   6146:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   6147:     <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
                   6148:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
                   6149: <li>
                   6150: <p>Tell pkginstall to handle it, appending the name of the script,
                   6151:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   6152:     Continuing the previous example:</p>
                   6153: <pre class="programlisting">
                   6154: RCD_SCRIPTS+=   cupsd
                   6155: </pre>
                   6156: </li>
                   6157: </ol></div>
                   6158: <p>Once this is done, pkginstall will do the following steps for each
                   6159: script in an automated fashion:</p>
                   6160: <div class="orderedlist"><ol type="1">
                   6161: <li><p>Process the file found in the files directory applying all the
                   6162:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   6163:     variable.</p></li>
                   6164: <li><p>Copy the script from the files directory to the examples
                   6165:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   6166:     that this master file must be explicitly registered in the
                   6167:     <code class="filename">PLIST</code>.</p></li>
                   6168: <li><p>Add code to the installation scripts to copy the startup script
                   6169:     from the examples hierarchy into the system-wide startup scripts
                   6170:     directory.</p></li>
                   6171: </ol></div>
                   6172: <div class="sect2" lang="en">
                   6173: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6174: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1       dsieger  6175: <p>The automatic copying of config files can be toggled by setting the
                   6176: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   6177: installation.  Note that the scripts will be always copied inside the
                   6178: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   6179: matter what the value of this variable is.</p>
                   6180: </div>
                   6181: </div>
                   6182: <div class="sect1" lang="en">
                   6183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6184: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1       dsieger  6185: <p>If a package needs to create special users and/or groups during
                   6186: installation, it can do so by using the pkginstall framework.</p>
                   6187: <p>Users can be created by adding entries to the
                   6188: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   6189: syntax:</p>
                   6190: <pre class="programlisting">
                   6191: user:group
                   6192: </pre>
                   6193: <p>Further specification of user details may be done by setting
                   6194: per-user variables.
                   6195: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   6196: numeric UID for the user.
                   6197: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   6198: user's description or comment.
                   6199: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   6200: user's home directory, and defaults to
                   6201: <code class="filename">/nonexistent</code> if not specified.
                   6202: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   6203: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   6204: not specified.</p>
                   6205: <p>Similarly, groups can be created by adding entries to the
                   6206: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   6207: <pre class="programlisting">
                   6208: group
                   6209: </pre>
                   6210: <p>The numeric GID of the group may be set by defining
                   6211: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   6212: <p>If a package needs to create the users and groups at an earlier
                   6213: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   6214: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   6215: indicate the phase before which the users and groups are created.  In
                   6216: this case, the numeric UIDs and GIDs of the created users and groups
                   6217: are automatically hardcoded into the final installation scripts.</p>
                   6218: </div>
                   6219: <div class="sect1" lang="en">
                   6220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6221: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1       dsieger  6222: <p>Packages that install system shells should register them in the shell
                   6223: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   6224: administrator.  This must be done from the installation scripts to keep
                   6225: binary packages working on any system.  pkginstall provides an easy way to
                   6226: accomplish this task.</p>
                   6227: <p>When a package provides a shell interpreter, it has to set the
                   6228: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   6229: add some hooks to the installation scripts to handle it.  Consider the
                   6230: 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>
                   6231: <pre class="programlisting">
                   6232: PKG_SHELL=      ${PREFIX}/bin/zsh
                   6233: </pre>
                   6234: <div class="sect2" lang="en">
                   6235: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6236: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1       dsieger  6237: <p>The automatic registration of shell interpreters can be disabled by
                   6238: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   6239: environment variable to <code class="literal">NO</code>.</p>
                   6240: </div>
                   6241: </div>
                   6242: <div class="sect1" lang="en">
                   6243: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6244: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1       dsieger  6245: <p>Packages that install X11 fonts should update the database files
                   6246: that index the fonts within each fonts directory.  This can easily be
                   6247: accomplished within the pkginstall framework.</p>
                   6248: <p>When a package installs X11 fonts, it must list the directories in
                   6249: which fonts are installed in the
                   6250: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   6251: where <em class="replaceable"><code>type</code></em> can be one of &#8220;<span class="quote">ttf</span>&#8221;,
                   6252: &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.  This will add hooks to the
                   6253: installation scripts to run the appropriate commands to update the fonts
                   6254: database files within each of those directories.  For convenience, if the
                   6255: directory path is relative, it is taken to be relative to the package's
                   6256: 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>
                   6257: <pre class="programlisting">
                   6258: FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
                   6259: </pre>
                   6260: <div class="sect2" lang="en">
                   6261: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6262: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1       dsieger  6263: <p>The automatic update of fonts databases can be disabled by
                   6264: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   6265: environment variable to <code class="literal">NO</code>.</p>
                   6266: </div>
                   6267: </div>
                   6268: </div>
                   6269: <div class="chapter" lang="en">
                   6270: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6271: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1       dsieger  6272: <div class="toc">
                   6273: <p><b>Table of Contents</b></p>
                   6274: <dl>
1.6       rillig   6275: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.15      rillig   6276: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use bsd.options.mk</a></span></dt>
1.6       rillig   6277: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   6278: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1       dsieger  6279: </dl>
                   6280: </div>
                   6281: <p>Many packages have the ability to be built to support different
                   6282: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   6283: in pkgsrc that provides generic handling of those options that
                   6284: determine different ways in which the packages can be built.  It's
                   6285: possible for the user to specify exactly which sets of options will be
                   6286: built into a package or to allow a set of global default options
                   6287: apply.</p>
1.7       rillig   6288: <p>There are two broad classes of behaviors that one might want to
                   6289: control via options.  One is whether some particular feature is
                   6290: enabled in a program that will be built anyway, often by including or
                   6291: not including a dependency on some other package.  The other is
                   6292: whether or not an additional program will be built as part of the
                   6293: package.  Generally, it is better to make a split package for such
                   6294: additional programs instead of using options, because it enables
                   6295: binary packages to be built which can then be added separately.  For
                   6296: example, the foo package might have minimal dependencies (those
                   6297: packages without which foo doesn't make sense), and then the foo-gfoo
                   6298: package might include the GTK frontend program gfoo.  This is better
                   6299: than including a gtk option to foo that adds gfoo, because either that
                   6300: option is default, in which case binary users can't get foo without
                   6301: gfoo, or not default, in which case they can't get gfoo.  With split
                   6302: packages, they can install foo without having GTK, and later decide to
                   6303: install gfoo (pulling in GTK at that time).  This is an advantage to
                   6304: source users too, avoiding the need for rebuilds.</p>
                   6305: <p>Plugins with widely varying dependencies should usually be split
                   6306: instead of options.</p>
                   6307: <p>It is often more work to maintain split packages, especially if
                   6308: the upstream package does not support this.  The decision of split
                   6309: vs. option should be made based on the likelihood that users will want
                   6310: or object to the various pieces, the size of the dependencies that are
                   6311: included, and the amount of work.</p>
                   6312: <p>A further consideration is licensing.  Non-free parts, or parts
                   6313: that depend on non-free dependencies (especially plugins) should
                   6314: almost always be split if feasible.</p>
1.1       dsieger  6315: <div class="sect1" lang="en">
                   6316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6317: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1       dsieger  6318: <p>Global default options are listed in
                   6319: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   6320: that should be built into every package if that option is supported.
1.10      hubertf  6321: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  6322: </div>
                   6323: <div class="sect1" lang="en">
                   6324: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6325: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1       dsieger  6326: </h2></div></div></div>
                   6327: <p>The following example shows how
                   6328: <code class="filename">bsd.options.mk</code> should be used
                   6329: by the hypothetical ``wibble'' package, either in the package
                   6330: <code class="filename">Makefile</code>, or in a file,
                   6331: e.g. <code class="filename">options.mk</code>, that is included by the
                   6332: main package <code class="filename">Makefile</code>.</p>
                   6333: <pre class="programlisting">
                   6334: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   6335: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   6336: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   6337: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   6338: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   6339: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   6340: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   6341: 
                   6342: .include "../../mk/bsd.prefs.mk"
                   6343: 
                   6344: # this package was previously named wibble2
                   6345: .if defined(PKG_OPTIONS.wibble2)
                   6346: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   6347: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   6348:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   6349: .endif
                   6350: 
                   6351: .include "../../mk/bsd.options.mk"
                   6352: 
                   6353: # Package-specific option-handling
                   6354: 
                   6355: ###
                   6356: ### FOO support
                   6357: ###
                   6358: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6359: CONFIGURE_ARGS+=    --enable-foo
                   6360: .endif
                   6361: 
                   6362: ###
                   6363: ### LDAP support
                   6364: ###
                   6365: .if !empty(PKG_OPTIONS:Mldap)
                   6366: .  include "../../databases/openldap-client/buildlink3.mk"
                   6367: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6368: .endif
                   6369: 
                   6370: ###
                   6371: ### database support
                   6372: ###
                   6373: .if !empty(PKG_OPTIONS:Mmysql)
                   6374: .  include "../../mk/mysql.buildlink3.mk"
                   6375: .endif
                   6376: .if !empty(PKG_OPTIONS:Mpgsql)
                   6377: .  include "../../mk/pgsql.buildlink3.mk"
                   6378: .endif
                   6379: </pre>
                   6380: <p>The first section contains the information about which build
                   6381: options are supported by the package, and any default options settings
                   6382: if needed.</p>
                   6383: <div class="orderedlist"><ol type="1">
                   6384: <li><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.10      hubertf  6385: <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.1       dsieger  6386: options.  It should be set to
                   6387: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6388: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6389: at the point where the options are processed.</p></li>
                   6390: <li><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   6391: build options supported by the package.</p></li>
                   6392: <li><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   6393: list of names of groups of mutually exclusive options.  The options in
                   6394: each group are listed in
                   6395: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6396: The most specific setting of any option from the group takes
                   6397: precedence over all other options in the group.  Options from the
                   6398: groups will be automatically added to
                   6399: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   6400: <li><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   6401: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6402: packages will fail if no option from the group is
                   6403: selected.</p></li>
                   6404: <li><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   6405: of names of sets of options.  At least one option from each set must
                   6406: be selected.  The options in each set are listed in
                   6407: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6408: Options from the sets will be automatically added to
                   6409: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6410: fail if no option from the set is selected.</p></li>
                   6411: <li><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   6412: build options which are enabled by default.</p></li>
                   6413: <li><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   6414: of
                   6415: &#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;
1.10      hubertf  6416: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1       dsieger  6417: their option counterparts.  Pairs should be added with
                   6418: &#8220;<span class="quote">+=</span>&#8221; to keep the listing of global legacy variables.  A
                   6419: warning will be issued if the user uses a legacy
                   6420: variable.</p></li>
                   6421: <li><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   6422: of
                   6423: &#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;
                   6424: pairs that map options that have been renamed to their new
                   6425: counterparts.  Pairs should be added with &#8220;<span class="quote">+=</span>&#8221; to keep
                   6426: the listing of global legacy options.  A warning will be issued if
                   6427: the user uses a legacy option.</p></li>
                   6428: <li><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   6429: options implied by deprecated variables used.  This can be used for
                   6430: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6431: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6432: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   6433: <li><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   6434: a list of warnings about deprecated variables or options used, and
                   6435: what to use instead.</p></li>
                   6436: </ol></div>
                   6437: <p>A package should never modify
                   6438: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6439: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6440: To suggest a default set of options, use
                   6441: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6442: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   6443: including <code class="filename">bsd.options.mk</code>.  If none of
                   6444: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6445: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6446: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6447: happen with platform-specific options if none of them is supported on
                   6448: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6449: empty list and the package is otherwise treated as not using the
                   6450: options framework.</p>
                   6451: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   6452: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6453: build options, properly filtered to remove unsupported and duplicate
                   6454: options.</p>
                   6455: <p>The remaining sections contain the logic that is specific to
                   6456: each option.  The correct way to check for an option is to check
                   6457: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6458: <pre class="programlisting">
                   6459: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   6460: </pre>
                   6461: </div>
                   6462: <div class="sect1" lang="en">
                   6463: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6464: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1       dsieger  6465: <p>Options that enable similar features in different packages (like
                   6466: optional support for a library) should use a common name in all
                   6467: packages that support it (like the name of the library).  If another
                   6468: package already has an option with the same meaning, use the same
                   6469: name.</p>
                   6470: <p>Options that enable features specific to one package, where it's
                   6471: unlikely that another (unrelated) package has the same (or a similar)
                   6472: optional feature, should use a name prefixed with
                   6473: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6474: <p>If a group of related packages share an optional feature
                   6475: specific to that group, prefix it with the name of the
                   6476: &#8220;<span class="quote">main</span>&#8221; package
                   6477: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6478: <p>For new options, add a line to
                   6479: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   6480: fields, separated by tab.  The first field is the option name, the
                   6481: second its description.  The description should be a whole sentence
                   6482: (starting with an uppercase letter and ending with a period) that
                   6483: describes what enabling the option does.  E. g. &#8220;<span class="quote">Enable ispell
                   6484: support.</span>&#8221; The file is sorted by option names.</p>
                   6485: </div>
1.7       rillig   6486: <div class="sect1" lang="en">
                   6487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6488: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10      hubertf  6489: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7       rillig   6490: different dependencies based on the options with which the package was
                   6491: built. For querying these options, the file
                   6492: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6493: typical example looks like this:</p>
                   6494: <pre class="programlisting">
                   6495: pkgbase := libpurple
                   6496: .include "../../mk/pkg-build-options.mk"
                   6497: 
                   6498: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6499: ...
                   6500: .endif
                   6501: </pre>
                   6502: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6503: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6504: options of the libpurple package, which can then be queried like
                   6505: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6506: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6507: details.</p>
                   6508: </div>
1.1       dsieger  6509: </div>
                   6510: <div class="chapter" lang="en">
                   6511: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6512: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1       dsieger  6513: <div class="toc">
                   6514: <p><b>Table of Contents</b></p>
                   6515: <dl>
1.6       rillig   6516: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6517: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6518: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6519: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.15      rillig   6520: <dt><span class="sect1"><a href="#build.fetch">17.5. The fetch phase</a></span></dt>
1.6       rillig   6521: <dd><dl>
                   6522: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6523: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6524: </dl></dd>
1.15      rillig   6525: <dt><span class="sect1"><a href="#build.checksum">17.6. The checksum phase</a></span></dt>
                   6526: <dt><span class="sect1"><a href="#build.extract">17.7. The extract phase</a></span></dt>
                   6527: <dt><span class="sect1"><a href="#build.patch">17.8. The patch phase</a></span></dt>
                   6528: <dt><span class="sect1"><a href="#build.tools">17.9. The tools phase</a></span></dt>
                   6529: <dt><span class="sect1"><a href="#build.wrapper">17.10. The wrapper phase</a></span></dt>
                   6530: <dt><span class="sect1"><a href="#build.configure">17.11. The configure phase</a></span></dt>
                   6531: <dt><span class="sect1"><a href="#build.build">17.12. The build phase</a></span></dt>
                   6532: <dt><span class="sect1"><a href="#build.test">17.13. The test phase</a></span></dt>
                   6533: <dt><span class="sect1"><a href="#build.install">17.14. The install phase</a></span></dt>
                   6534: <dt><span class="sect1"><a href="#build.package">17.15. The package phase</a></span></dt>
1.6       rillig   6535: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6536: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1       dsieger  6537: </dl>
                   6538: </div>
                   6539: <div class="sect1" lang="en">
                   6540: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6541: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1       dsieger  6542: <p>This chapter gives a detailed description on how a package is
                   6543:     built. Building a package is separated into different
                   6544:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6545:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   6546:     described in the following sections. Each phase is splitted into
                   6547:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6548:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6549:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6550:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6551:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   6552: <p>Never override the regular targets (like
                   6553:     <code class="varname">fetch</code>), if you have to, override the
                   6554:     <code class="varname">do-*</code> ones instead.</p>
                   6555: <p>The basic steps for building a program are always the same.  First
                   6556:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6557:     the local system and then extracted. After any pkgsrc-specific patches
                   6558:     to compile properly are applied, the software can be configured, then
                   6559:     built (usually by compiling), and finally the generated binaries, etc.
                   6560:     can be put into place on the system.</p>
                   6561: <p>To get more details about what is happening at each step,
                   6562:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6563:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6564:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   6565: </div>
                   6566: <div class="sect1" lang="en">
                   6567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6568: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1       dsieger  6569: <p>Before outlining the process performed by the NetBSD package system in
                   6570:     the next section, here's a brief discussion on where programs are
                   6571:     installed, and which variables influence this.</p>
                   6572: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   6573:     where all files of the final program shall be installed. It is
                   6574:     usually set to <code class="varname">LOCALBASE</code>
                   6575:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   6576:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   6577:     <code class="varname">PREFIX</code> needs to be put
                   6578:     into the various places in the program's source where paths to
1.10      hubertf  6579:     these files are encoded.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.1       dsieger  6580: <p>When choosing which of these variables to use,
                   6581:     follow the following rules:</p>
                   6582: <div class="itemizedlist"><ul type="disc">
                   6583: <li><p><code class="varname">PREFIX</code> always points to the location
                   6584:        where the current pkg will be installed.  When referring to a
                   6585:        pkg's own installation path, use
                   6586:        &#8220;<span class="quote">${PREFIX}</span>&#8221;.</p></li>
                   6587: <li><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   6588:        are installed.  If you need to construct a -I or -L argument
                   6589:        to the compiler to find includes and libraries installed by
                   6590:        another non-X11 pkg, use &#8220;<span class="quote">${LOCALBASE}</span>&#8221;. The name
                   6591:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6592:        installed all packages in <code class="filename">/usr/local</code>. As
                   6593:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6594:        administrator, this variable is a misnomer.</p></li>
                   6595: <li><p><code class="varname">X11BASE</code> is where the actual X11
                   6596:        distribution (from xsrc, etc.) is installed. When looking for
                   6597:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   6598:        installed by a package), use &#8220;<span class="quote">${X11BASE}</span>&#8221;.</p></li>
                   6599: <li>
                   6600: <p>X11-based packages are special in that they may be
                   6601:        installed in either <code class="varname">X11BASE</code> or
                   6602:        <code class="varname">LOCALBASE</code>.</p>
                   6603: <p>Usually, X11 packages should be installed under
                   6604:        <code class="varname">LOCALBASE</code> whenever possible.  Note that you
                   6605:        will need to include
                   6606:        <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
                   6607:        request the presence of X11 and to get the right compilation
                   6608:        flags.</p>
                   6609: <p>Even though, there are some packages that cannot be installed
                   6610:        under <code class="varname">LOCALBASE</code>: those that come with app-defaults
                   6611:        files. These packages are special and they must be placed under
                   6612:        <code class="varname">X11BASE</code>. To accomplish this, set either
                   6613:        <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
                   6614:        your package.</p>
                   6615: <p>Some notes: If you need
                   6616:        to find includes or libraries installed by a pkg that has
                   6617:        <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
                   6618:        its pkg <code class="filename">Makefile</code>, you need to look in
                   6619:        <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
                   6620:        <code class="filename">${LOCALBASE}</code>. To force installation of
                   6621:        all X11 packages in <code class="varname">LOCALBASE</code>, the
                   6622:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
                   6623:        is enabled by default.</p>
                   6624: </li>
                   6625: <li><p><code class="varname">X11PREFIX</code> should be used to refer to
                   6626:        the installed location of an X11
                   6627:        package. <code class="varname">X11PREFIX</code> will be set to
                   6628:        <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
                   6629:        to <code class="varname">LOCALBASE</code> if xpkgwedge is
                   6630:        installed.</p></li>
                   6631: <li>
                   6632: <p>If xpkgwedge is installed, it is possible to have some
                   6633:        packages installed in <code class="varname">X11BASE</code> and some in
                   6634:        <code class="varname">LOCALBASE</code>.  To determine the prefix of an
                   6635:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6636:        definition can be used. It takes pairs in the format
1.10      hubertf  6637:        &#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.1       dsieger  6638:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6639:        of the installed package &lt;package&gt;, or
                   6640:        &#8220;<span class="quote">${X11PREFIX}</span>&#8221; if the package is not
                   6641:        installed.</p>
                   6642: <p>This is best illustrated by example.</p>
                   6643: <p>The following lines are taken from
                   6644:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
                   6645: <pre class="programlisting">
                   6646: EVAL_PREFIX+=           GTKDIR=gtk+
                   6647: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6648: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6649: CONFIGURE_ARGS+=        --enable-multibyte
                   6650: </pre>
                   6651: <p>Specific defaults can be defined for the packages
                   6652:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6653:        definition of the form:</p>
                   6654: <pre class="programlisting">
                   6655: GTKDIR_DEFAULT= ${LOCALBASE}
                   6656: </pre>
                   6657: <p>where <code class="varname">GTKDIR</code> corresponds
                   6658:        to the first definition in
                   6659:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
                   6660: </li>
                   6661: <li><p>Within <code class="filename">${PREFIX}</code>, packages should
1.10      hubertf  6662:        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.1       dsieger  6663:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6664:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   6665: </ul></div>
                   6666: </div>
                   6667: <div class="sect1" lang="en">
                   6668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6669: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14      jmcneill 6670: <p>When building a package, various directories are used to store
1.1       dsieger  6671:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6672:     directories are explained here.</p>
                   6673: <p>Some of the directory variables contain relative pathnames. There
                   6674:     are two common base directories for these relative directories:
                   6675:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6676:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6677:     inside the package itself.</p>
                   6678: <div class="variablelist"><dl>
                   6679: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6680: <dd><p>This is an absolute pathname that points to the pkgsrc
                   6681:       root directory. Generally, you don't need
                   6682:       it.</p></dd>
                   6683: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6684: <dd><p>This is an absolute pathname that points to the
                   6685:       current package.</p></dd>
                   6686: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6687: <dd><p>This is a pathname relative to
                   6688:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6689:       package.</p></dd>
                   6690: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6691: <dd><p>This is an absolute pathname pointing to the directory
                   6692:       where all work takes place. The distfiles are extracted to this
                   6693:       directory. It also contains temporary directories and log files used by
                   6694:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6695:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   6696: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6697: <dd><p>This is an absolute pathname pointing to the directory
                   6698:       where the distfiles are extracted. It is usually a direct subdirectory
                   6699:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6700:       that isn't hidden. This variable may be changed by a package
                   6701:       <code class="filename">Makefile</code>.</p></dd>
                   6702: </dl></div>
1.14      jmcneill 6703: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6704:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15      rillig   6705:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14      jmcneill 6706:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6707:     If users would like to have their pkgsrc trees behave in a
                   6708:     read-only manner, then the value of
                   6709:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6710:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  6711: </div>
                   6712: <div class="sect1" lang="en">
                   6713: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6714: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10      hubertf  6715: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1       dsieger  6716:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6717:     phase. This will automatically run all phases that are required for this
                   6718:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.10      hubertf  6719:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1       dsieger  6720:     the package will be built, but not installed.</p>
                   6721: </div>
                   6722: <div class="sect1" lang="en">
                   6723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6724: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  6725: <p>The first step in building a package is to fetch the
                   6726:     distribution files (distfiles) from the sites that are providing
                   6727:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6728:     phase.</p>
                   6729: <div class="sect2" lang="en">
                   6730: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6731: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1       dsieger  6732: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6733:       defines all URLs from where the distfile, whose name is
                   6734:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6735:       fetched. The more complicated cases are described
                   6736:       below.</p>
                   6737: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6738:       the list of distfiles that have to be fetched. Its value
                   6739:       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   6740:       so that most packages don't need to define it at all.
                   6741:       <code class="varname">EXTRACT_SUFX</code> is
                   6742:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6743:       freely. Note that if your package requires additional
                   6744:       distfiles to the default one, you cannot just append the
                   6745:       additional filenames using the <code class="literal">+=</code>
                   6746:       operator, but you have write for example:</p>
                   6747: <pre class="programlisting">
                   6748: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   6749: </pre>
                   6750: <p>Each distfile is fetched from a list of sites, usually
                   6751:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6752:       <code class="varname">DISTFILES</code> or multiple
                   6753:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6754:       set
                   6755:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6756:       to the list of URLs where the file
                   6757:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6758:       (including the suffix) can be found.</p>
                   6759: <pre class="programlisting">
                   6760: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6761: DISTFILES+=     foo-file.tar.gz
                   6762: SITES.foo-file.tar.gz= \
                   6763: http://www.somewhere.com/somehow/ \
                   6764: http://www.somewhereelse.com/mirror/somehow/
                   6765: </pre>
                   6766: <p>When actually fetching the distfiles, each item from
                   6767:       <code class="varname">MASTER_SITES</code> or
                   6768:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6769:       appended to it, without an intermediate slash. Therefore,
                   6770:       all site values have to end with a slash or other separator
                   6771:       character. This allows for example to set
                   6772:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6773:       that gets the name of the distfile as a parameter. In this
                   6774:       case, the definition would look like:</p>
                   6775: <pre class="programlisting">
                   6776: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6777: </pre>
                   6778: <p>There are some predefined values for
                   6779:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6780:       packages.  The names of the variables should speak for
                   6781:       themselves.</p>
                   6782: <pre class="programlisting">
                   6783: ${MASTER_SITE_APACHE}
                   6784: ${MASTER_SITE_BACKUP}
                   6785: ${MASTER_SITE_CYGWIN}
                   6786: ${MASTER_SITE_DEBIAN}
                   6787: ${MASTER_SITE_FREEBSD}
                   6788: ${MASTER_SITE_FREEBSD_LOCAL}
                   6789: ${MASTER_SITE_GENTOO}
                   6790: ${MASTER_SITE_GNOME}
                   6791: ${MASTER_SITE_GNU}
                   6792: ${MASTER_SITE_GNUSTEP}
                   6793: ${MASTER_SITE_IFARCHIVE}
                   6794: ${MASTER_SITE_KDE}
                   6795: ${MASTER_SITE_MOZILLA}
                   6796: ${MASTER_SITE_MYSQL}
                   6797: ${MASTER_SITE_OPENOFFICE}
                   6798: ${MASTER_SITE_PERL_CPAN}
                   6799: ${MASTER_SITE_PGSQL}
                   6800: ${MASTER_SITE_R_CRAN}
                   6801: ${MASTER_SITE_SOURCEFORGE}
                   6802: ${MASTER_SITE_SOURCEFORGE_JP}
                   6803: ${MASTER_SITE_SUNSITE}
                   6804: ${MASTER_SITE_SUSE}
                   6805: ${MASTER_SITE_TEX_CTAN}
                   6806: ${MASTER_SITE_XCONTRIB}
                   6807: ${MASTER_SITE_XEMACS}
                   6808: </pre>
                   6809: <p>Some explanations for the less self-explaining ones:
                   6810:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.10      hubertf  6811:       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
                   6812:       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.1       dsieger  6813: <p>If you choose one of these predefined sites, you may
                   6814:       want to specify a subdirectory of that site. Since these
                   6815:       macros may expand to more than one actual site, you
                   6816:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6817:       specify a subdirectory:</p>
                   6818: <pre class="programlisting">
                   6819: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6820: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6821: </pre>
                   6822: <p>Note the trailing slash after the subdirectory
                   6823:       name.</p>
                   6824: </div>
                   6825: <div class="sect2" lang="en">
                   6826: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   6827: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1       dsieger  6828: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6829:       all the distfiles exist in a local directory
                   6830:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   6831:       user). If the files do not exist, they are fetched using
                   6832:       commands of the form</p>
                   6833: <pre class="programlisting">
                   6834: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6835: </pre>
                   6836: <p>where <code class="literal">${site}</code> varies through
                   6837:       several possibilities in turn: first,
                   6838:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6839:       sites specified in either <code class="varname">SITES.file</code> if
                   6840:       defined, else <code class="varname">MASTER_SITES</code> or
                   6841:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6842:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   6843:       all except the first and the last can be optionally sorted
                   6844:       by the user, via setting either
                   6845:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6846:       <code class="varname">MASTER_SORT_AWK</code> or
                   6847:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16      jnemeth  6848: <p> The specific command and arguments used depend on the
                   6849:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6850:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.1       dsieger  6851: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6852:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6853:       distfiles, if they are freely distributable.  Packages setting
                   6854:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   6855:       &#8220;<span class="quote">${RESTRICTED}</span>&#8221;) will not have their distfiles
                   6856:       mirrored.</p>
                   6857: </div>
                   6858: </div>
                   6859: <div class="sect1" lang="en">
                   6860: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6861: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1       dsieger  6862: <p>After the distfile(s) are fetched, their checksum is
                   6863:     generated and compared with the checksums stored in the
                   6864:     distinfo file. If the checksums don't match, the build is
                   6865:     aborted. This is to ensure the same distfile is used for
                   6866:     building, and that the distfile wasn't changed, e.g. by some
                   6867:     malign force, deliberately changed distfiles on the master
                   6868:     distribution site or network lossage.</p>
                   6869: </div>
                   6870: <div class="sect1" lang="en">
                   6871: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6872: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1       dsieger  6873: <p>When the distfiles are present on the local system, they
                   6874:     need to be extracted, as they usually come in the form of some
                   6875:     compressed archive format.</p>
                   6876: <p>By default, all <code class="varname">DISTFILES</code> are
                   6877:     extracted. If you only need some of them, you can set the
                   6878:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6879:     files.</p>
                   6880: <p>Extracting the files is usually done by a little
                   6881:     program, <code class="filename">mk/extract/extract</code>, which
                   6882:     already knows how to extract various archive formats, so most
                   6883:     likely you will not need to change anything here. But if you
                   6884:     need, the following variables may help you:</p>
                   6885: <div class="variablelist"><dl>
                   6886: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6887: <dd><p>Use these variables to override the default
                   6888:       options for an extract command, which are defined in
                   6889:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   6890: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6891: <dd><p>This variable can be set to
1.14      jmcneill 6892:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6893:       (which is the default value), <code class="literal">pax</code>, or an
1.1       dsieger  6894:       absolute pathname pointing to the command with which tar
1.14      jmcneill 6895:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6896:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  6897: </dl></div>
                   6898: <p>If the <code class="filename">extract</code> program doesn't
                   6899:     serve your needs, you can also override the
                   6900:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6901:     command used for extracting the files. This command is
                   6902:     executed in the <code class="filename">${WRKSRC}</code>
                   6903:     directory. During execution of this command, the shell
                   6904:     variable <code class="varname">extract_file</code> holds the absolute
                   6905:     pathname of the file that is going to be extracted.</p>
                   6906: <p>And if that still does not suffice, you can override the
                   6907:     <code class="varname">do-extract</code> target in the package
                   6908:     Makefile.</p>
                   6909: </div>
                   6910: <div class="sect1" lang="en">
                   6911: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6912: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1       dsieger  6913: <p>After extraction, all the patches named by the
                   6914:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6915:     subdirectory of the package as well as in
                   6916:     $LOCALPATCHES/$PKGPATH (e.g.
                   6917:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6918:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6919:     <code class="filename">.gz</code> are uncompressed before they are
                   6920:     applied, files ending in <code class="filename">.orig</code> or
                   6921:     <code class="filename">.rej</code> are ignored. Any special options to
1.10      hubertf  6922:     <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
                   6923:     <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>
                   6924: <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.1       dsieger  6925:     it fail if the patches apply with some lines of fuzz. Please
                   6926:     fix (regen) the patches so that they apply cleanly. The
                   6927:     rationale behind this is that patches that don't apply cleanly
                   6928:     may end up being applied in the wrong place, and cause severe
                   6929:     harm there.</p>
                   6930: </div>
                   6931: <div class="sect1" lang="en">
                   6932: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6933: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10      hubertf  6934: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.1       dsieger  6935:     </p>
                   6936: </div>
                   6937: <div class="sect1" lang="en">
                   6938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6939: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1       dsieger  6940: <p>This phase creates wrapper programs for the compilers and
                   6941:     linkers. The following variables can be used to tweak the
                   6942:     wrappers.</p>
                   6943: <div class="variablelist"><dl>
                   6944: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6945: <dd><p>The command used to print progress
                   6946:       messages. Does nothing by default. Set to
                   6947:       <code class="literal">${ECHO}</code> to see the progress
                   6948:       messages.</p></dd>
                   6949: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6950: <dd><p>This variable can be set to
                   6951:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6952:       depending on whether you want additional information in the
                   6953:       wrapper log file.</p></dd>
                   6954: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6955: <dd><p>This variable can be set to
                   6956:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6957:       on whether the wrapper should use its cache, which will
                   6958:       improve the speed. The default value is
                   6959:       <code class="literal">yes</code>, but is forced to
                   6960:       <code class="literal">no</code> if the platform does not support
                   6961:       it.</p></dd>
                   6962: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   6963: <dd><p>A list of reordering commands. A reordering
                   6964:       command has the form
                   6965:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6966:       It ensures that that
                   6967:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6968:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6969:       </p></dd>
                   6970: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6971: <dd><p>A list of transformation commands. [TODO:
                   6972:       investigate further]</p></dd>
                   6973: </dl></div>
                   6974: </div>
                   6975: <div class="sect1" lang="en">
                   6976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6977: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  6978: <p>Most pieces of software need information on the header
                   6979:     files, system calls, and library routines which are available
                   6980:     on the platform they run on. The process of determining this
                   6981:     information is known as configuration, and is usually
                   6982:     automated. In most cases, a script is supplied with the
                   6983:     distfiles, and its invocation results in generation of header
                   6984:     files, Makefiles, etc.</p>
                   6985: <p>If the package contains a configure script, this can be
                   6986:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   6987:     &#8220;<span class="quote">yes</span>&#8221;. If the configure script is a GNU autoconf
                   6988:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   6989:     &#8220;<span class="quote">yes</span>&#8221; instead. What happens in the
                   6990:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6991: <pre class="programlisting">
                   6992: .for d in ${CONFIGURE_DIRS}
                   6993:         cd ${WRKSRC} \
                   6994:         &amp;&amp; cd ${d} \
                   6995:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6996: .endfor
                   6997: </pre>
                   6998: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   6999:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   7000:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   7001:     configure script is run with the environment
                   7002:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   7003:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   7004:     <code class="varname">CONFIGURE_ENV</code>,
                   7005:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   7006:     &#8220;<span class="quote">./configure</span>&#8221;) and
                   7007:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   7008:     package.</p>
                   7009: <p>If the program uses an <code class="filename">Imakefile</code>
                   7010:     for configuration, the appropriate steps can be invoked by
                   7011:     setting <code class="varname">USE_IMAKE</code> to
                   7012:     &#8220;<span class="quote">yes</span>&#8221;. (If you only want the package installed in
                   7013:     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
                   7014:     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
                   7015:     xmkmf's environment by adding them to the
                   7016:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11      rillig   7017: <p>If the program uses <code class="filename">cmake</code>
                   7018:     for configuration, the appropriate steps can be invoked by
                   7019:     setting <code class="varname">USE_CMAKE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7020:     You can add variables to cmake's environment by adding them to the
                   7021:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   7022:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   7023:     The top directory argument is given by the
                   7024:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   7025:     &#8220;<span class="quote">.</span>&#8221; (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1       dsieger  7026: <p>If there is no configure step at all, set
                   7027:     <code class="varname">NO_CONFIGURE</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
                   7028: </div>
                   7029: <div class="sect1" lang="en">
                   7030: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7031: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  7032: <p>For building a package, a rough equivalent of the
                   7033:     following code is executed.</p>
                   7034: <pre class="programlisting">
                   7035: .for d in ${BUILD_DIRS}
                   7036:         cd ${WRKSRC} \
                   7037:         &amp;&amp; cd ${d} \
                   7038:         &amp;&amp; env ${MAKE_ENV} \
                   7039:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   7040:                 -f ${MAKE_FILE} \
                   7041:                 ${BUILD_TARGET}
                   7042: .endfor
                   7043: </pre>
                   7044: <p><code class="varname">BUILD_DIRS</code> (default:
                   7045:     &#8220;<span class="quote">.</span>&#8221;) is a list of pathnames relative to
                   7046:     <code class="varname">WRKSRC</code>. In each of these directories,
                   7047:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   7048:     <code class="varname">MAKE_ENV</code> and arguments
                   7049:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   7050:     <code class="varname">MAKE_ENV</code>,
                   7051:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   7052:     <code class="varname">MAKE_FILE</code> and
                   7053:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   7054:     package.</p>
                   7055: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   7056:     &#8220;<span class="quote">gmake</span>&#8221; if <code class="varname">USE_TOOLS</code> contains
                   7057:     &#8220;<span class="quote">gmake</span>&#8221;, &#8220;<span class="quote">make</span>&#8221; otherwise. The
                   7058:     default value of <code class="varname">MAKE_FILE</code> is
                   7059:     &#8220;<span class="quote">Makefile</span>&#8221;, and <code class="varname">BUILD_TARGET</code>
                   7060:     defaults to &#8220;<span class="quote">all</span>&#8221;.</p>
                   7061: <p>If there is no build step at all, set
                   7062:     <code class="varname">NO_BUILD</code> to &#8220;<span class="quote">yes</span>&#8221;.</p>
                   7063: </div>
                   7064: <div class="sect1" lang="en">
                   7065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7066: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1       dsieger  7067: <p>[TODO]</p>
                   7068: </div>
                   7069: <div class="sect1" lang="en">
                   7070: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7071: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  7072: <p>Once the build stage has completed, the final step is to
                   7073:     install the software in public directories, so users can
                   7074:     access the programs and files.</p>
                   7075: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   7076:     equivalent of the following code is executed. Additionally,
                   7077:     before and after this code, much magic is performed to do
                   7078:     consistency checks, registering the package, and so on.</p>
                   7079: <pre class="programlisting">
                   7080: .for d in ${INSTALL_DIRS}
                   7081:         cd ${WRKSRC} \
                   7082:         &amp;&amp; cd ${d} \
                   7083:         &amp;&amp; env ${MAKE_ENV} \
                   7084:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   7085:                 -f ${MAKE_FILE} \
                   7086:                 ${INSTALL_TARGET}
                   7087: .endfor
                   7088: </pre>
                   7089: <p>The variable's meanings are analogous to the ones in the
                   7090:     <span class="emphasis"><em>build</em></span> phase.
                   7091:     <code class="varname">INSTALL_DIRS</code> defaults to
                   7092:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   7093:     is &#8220;<span class="quote">install</span>&#8221; by default, plus
                   7094:     &#8220;<span class="quote">install.man</span>&#8221; if <code class="varname">USE_IMAKE</code> is
                   7095:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   7096:     defined.</p>
                   7097: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   7098:     variables are useful. They are all variations of the
1.10      hubertf  7099:     <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.1       dsieger  7100:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   7101:     install command. The specialized variants, together with their
                   7102:     intended use, are:</p>
                   7103: <div class="variablelist"><dl>
                   7104: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   7105: <dd><p>directories that contain
                   7106:       binaries</p></dd>
                   7107: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   7108: <dd><p>directories that contain
                   7109:       scripts</p></dd>
                   7110: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   7111: <dd><p>directories that contain shared and static
                   7112:       libraries</p></dd>
                   7113: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   7114: <dd><p>directories that contain data
                   7115:       files</p></dd>
                   7116: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   7117: <dd><p>directories that contain man
                   7118:       pages</p></dd>
                   7119: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   7120: <dd><p>binaries that can be stripped from debugging
                   7121:       symbols</p></dd>
                   7122: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   7123: <dd><p>binaries that cannot be
                   7124:       stripped</p></dd>
                   7125: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   7126: <dd><p>game
                   7127:       binaries</p></dd>
                   7128: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   7129: <dd><p>shared and static
                   7130:       libraries</p></dd>
                   7131: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   7132: <dd><p>data files</p></dd>
                   7133: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   7134: <dd><p>data files for
                   7135:       games</p></dd>
                   7136: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   7137: <dd><p>man pages</p></dd>
                   7138: </dl></div>
                   7139: <p>Some other variables are:</p>
                   7140: <div class="variablelist"><dl>
                   7141: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   7142: <dd><p>A list of directories relative to
                   7143:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   7144:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   7145:       The package is supposed to create all needed directories itself
                   7146:       before installing files to it and list all other directories here.
                   7147:       </p></dd>
                   7148: </dl></div>
                   7149: <p>In the rare cases that a package shouldn't install anything,
                   7150:     set <code class="varname">NO_INSTALL</code> to &#8220;<span class="quote">yes</span>&#8221;. This is
                   7151:     mostly relevant for packages in the <code class="filename">regress</code>
                   7152:     category.</p>
                   7153: </div>
                   7154: <div class="sect1" lang="en">
                   7155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7156: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1       dsieger  7157: <p>Once the install stage has completed, a binary package of
                   7158:     the installed files can be built.  These binary packages can be
                   7159:     used for quick installation without previous compilation, e.g. by
1.10      hubertf  7160:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   7161:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.1       dsieger  7162: <p>By default, the binary packages are created in
                   7163:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   7164:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   7165:     one for each category in the <code class="varname">CATEGORIES</code>
                   7166:     variable.  <code class="varname">PACKAGES</code> defaults to
                   7167:     <code class="filename">pkgsrc/packages</code>.</p>
                   7168: <p>If there should be no binary package, set
                   7169:     <code class="varname">NO_PACKAGE</code> to &#8220;<span class="quote">yes</span>&#8221;.
                   7170:     This should only be used in rare cases, like when a package
                   7171:     definitely is only usable on the machine where it is built and even
                   7172:     then, a binary package can be useful.</p>
                   7173: </div>
                   7174: <div class="sect1" lang="en">
                   7175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7176: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1       dsieger  7177: <p>Once you're finished with a package, you can clean the work
1.10      hubertf  7178:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.1       dsieger  7179:     to clean the work directories of all dependencies too, use
1.10      hubertf  7180:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  7181: </div>
                   7182: <div class="sect1" lang="en">
                   7183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7184: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.1       dsieger  7185: <div class="variablelist"><dl>
                   7186: <dt><span class="term">pre/post-*</span></dt>
                   7187: <dd><p>For any of the main targets described in the
                   7188:          previous section, two auxiliary targets exist with
                   7189:          &#8220;<span class="quote">pre-</span>&#8221; and &#8220;<span class="quote">post-</span>&#8221; used as a
                   7190:          prefix for the main target's name.  These targets are
                   7191:          invoked before and after the main target is called,
                   7192:          allowing extra configuration or installation steps be
                   7193:          performed from a package's Makefile, for example, which
                   7194:          a program's configure script or install target
                   7195:          omitted.</p></dd>
                   7196: <dt><span class="term">do-*</span></dt>
                   7197: <dd><p>Should one of the main targets do the wrong thing,
                   7198:          and should there be no variable to fix this, you can
                   7199:          redefine it with the do-* target.  (Note that redefining
                   7200:          the target itself instead of the do-* target is a bad
                   7201:          idea, as the pre-* and post-* targets won't be called
                   7202:          anymore, etc.) You will not usually need to do
                   7203:          this.</p></dd>
                   7204: <dt><span class="term">reinstall</span></dt>
                   7205: <dd>
1.10      hubertf  7206: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1       dsieger  7207:          you noticed some file was not installed properly, you
                   7208:          can repeat the installation with this target, which will
                   7209:          ignore the &#8220;<span class="quote">already installed</span>&#8221; flag.</p>
                   7210: <p>This is the default value of
                   7211:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10      hubertf  7212:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1       dsieger  7213:          package</strong></span>, where the defaults are
                   7214:          &#8220;<span class="quote">package</span>&#8221; and &#8220;<span class="quote">update</span>&#8221;,
                   7215:          respectively.</p>
                   7216: </dd>
                   7217: <dt><span class="term">deinstall</span></dt>
                   7218: <dd>
1.10      hubertf  7219: <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.1       dsieger  7220:          current directory, effectively de-installing the
                   7221:          package. The following variables can be used to tune the
                   7222:          behaviour:</p>
                   7223: <div class="variablelist"><dl>
                   7224: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.10      hubertf  7225: <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.1       dsieger  7226: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   7227: <dd><p>Remove all packages that require (depend on)
                   7228:                the given package.  This can be used to remove any
                   7229:                packages that may have been pulled in by a given
1.10      hubertf  7230:                package, e.g. if <span class="command"><strong>make deinstall
1.1       dsieger  7231:                DEINSTALLDEPENDS=1</strong></span> is done in
                   7232:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   7233:                likely to remove whole KDE. Works by adding
1.10      hubertf  7234:                &#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.1       dsieger  7235:                command line.</p></dd>
                   7236: </dl></div>
                   7237: </dd>
                   7238: <dt><span class="term">bin-install</span></dt>
                   7239: <dd><p>Install a binary package from local disk and via FTP
                   7240:          from a list of sites (see the
                   7241:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.10      hubertf  7242:          <span class="command"><strong>make package</strong></span> if no binary package is
1.1       dsieger  7243:          available anywhere.  The arguments given to
1.10      hubertf  7244:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.1       dsieger  7245:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   7246:          operation, etc.</p></dd>
                   7247: <dt><span class="term">update</span></dt>
                   7248: <dd>
                   7249: <p>This target causes the current package to be
                   7250:          updated to the latest version.  The package and all
                   7251:          depending packages first get de-installed, then current
                   7252:          versions of the corresponding packages get compiled and
                   7253:          installed.  This is similar to manually noting which
                   7254:          packages are currently installed, then performing a
1.10      hubertf  7255:          series of <span class="command"><strong>make deinstall</strong></span> and
                   7256:          <span class="command"><strong>make install</strong></span> (or whatever
1.1       dsieger  7257:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   7258:          packages.</p>
                   7259: <p>You can use the &#8220;<span class="quote">update</span>&#8221; target to
1.10      hubertf  7260:          resume package updating in case a previous <span class="command"><strong>make
1.1       dsieger  7261:          update</strong></span> was interrupted for some reason.
                   7262:          However, in this case, make sure you don't call
1.10      hubertf  7263:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1       dsieger  7264:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   7265:          Otherwise, you lose the ability to automatically update
                   7266:          the current package along with the dependent packages
                   7267:          you have installed.</p>
1.10      hubertf  7268: <p>Resuming an interrupted <span class="command"><strong>make
1.1       dsieger  7269:          update</strong></span> will only work as long as the package
                   7270:          tree remains unchanged.  If the source code for one of
                   7271:          the packages to be updated has been changed, resuming
1.10      hubertf  7272:          <span class="command"><strong>make update</strong></span> will most certainly
1.1       dsieger  7273:          fail!</p>
                   7274: <p>The following variables can be used either on the
1.10      hubertf  7275:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   7276:          alter the behaviour of <span class="command"><strong>make
1.1       dsieger  7277:          update</strong></span>:</p>
                   7278: <div class="variablelist"><dl>
                   7279: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   7280: <dd><p>Install target to recursively use for the
                   7281:                updated package and the dependent packages.
                   7282:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   7283:                set, &#8220;<span class="quote">install</span>&#8221; otherwise for
1.10      hubertf  7284:                <span class="command"><strong>make update</strong></span>.  Other good
1.1       dsieger  7285:                targets are &#8220;<span class="quote">package</span>&#8221; or
                   7286:                &#8220;<span class="quote">bin-install</span>&#8221;.  Do not set this to
                   7287:                &#8220;<span class="quote">update</span>&#8221; or you will get stuck in an
                   7288:                endless loop!</p></dd>
                   7289: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   7290: <dd><p>Don't clean up after updating.  Useful if
                   7291:                you want to leave the work sources of the updated
                   7292:                packages around for inspection or other purposes.
                   7293:                Be sure you eventually clean up the source tree
                   7294:                (see the &#8220;<span class="quote">clean-update</span>&#8221; target below)
                   7295:                or you may run into troubles with old source code
                   7296:                still lying around on your next
1.10      hubertf  7297:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1       dsieger  7298:                update</strong></span>.</p></dd>
                   7299: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   7300: <dd><p>Deinstall each package before installing
                   7301:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   7302:                may be necessary if the
                   7303:                &#8220;<span class="quote">clean-update</span>&#8221; target (see below) was
1.10      hubertf  7304:                called after interrupting a running <span class="command"><strong>make
1.1       dsieger  7305:                update</strong></span>.</p></dd>
                   7306: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   7307: <dd><p>Allows you to disable recursion and hardcode
                   7308:                the target for packages.  The default is
                   7309:                &#8220;<span class="quote">update</span>&#8221; for the update target,
                   7310:                facilitating a recursive update of prerequisite
                   7311:                packages.  Only set
                   7312:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   7313:                disable recursive updates. Use
                   7314:                <code class="varname">UPDATE_TARGET</code> instead to just
                   7315:                set a specific target for each package to be
1.10      hubertf  7316:                installed during <span class="command"><strong>make update</strong></span>
1.1       dsieger  7317:                (see above).</p></dd>
                   7318: </dl></div>
                   7319: </dd>
                   7320: <dt><span class="term">clean-update</span></dt>
                   7321: <dd>
                   7322: <p>Clean the source tree for all packages that would
1.10      hubertf  7323:          get updated if <span class="command"><strong>make update</strong></span> was called
1.1       dsieger  7324:          from the current directory.  This target should not be
                   7325:          used if the current package (or any of its depending
                   7326:          packages) have already been de-installed (e.g., after
1.10      hubertf  7327:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1       dsieger  7328:          some packages you intended to update. As a rule of
                   7329:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10      hubertf  7330:          the first time you run <span class="command"><strong>make update</strong></span>
1.1       dsieger  7331:          and only if you have a dirty package tree (e.g., if you
                   7332:          used <code class="varname">NOCLEAN</code>).</p>
                   7333: <p>If you are unsure about whether your tree is
1.10      hubertf  7334:          clean, you can either perform a <span class="command"><strong>make
1.1       dsieger  7335:          clean</strong></span> at the top of the tree, or use the
                   7336:          following sequence of commands from the directory of the
                   7337:          package you want to update (<span class="emphasis"><em>before</em></span>
1.10      hubertf  7338:          running <span class="command"><strong>make update</strong></span> for the first
1.1       dsieger  7339:          time, otherwise you lose all the packages you wanted to
                   7340:          update!):</p>
                   7341: <pre class="screen">
                   7342: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   7343: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   7344: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   7345:          </pre>
                   7346: <p>The following variables can be used either on the
1.10      hubertf  7347:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   7348:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.1       dsieger  7349: <div class="variablelist"><dl>
                   7350: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10      hubertf  7351: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1       dsieger  7352:                reconstruct the list of directories to update for
1.10      hubertf  7353:                this package.  Only use this if <span class="command"><strong>make
1.1       dsieger  7354:                update</strong></span> successfully installed all
                   7355:                packages you wanted to update.  Normally, this is
1.10      hubertf  7356:                done automatically on <span class="command"><strong>make
1.1       dsieger  7357:                update</strong></span>, but may have been suppressed by
                   7358:                the <code class="varname">NOCLEAN</code> variable (see
                   7359:                above).</p></dd>
                   7360: </dl></div>
                   7361: </dd>
                   7362: <dt><span class="term">replace</span></dt>
                   7363: <dd>
                   7364: <p>Update the installation of the current package.  This
                   7365:          differs from update in that it does not replace dependent
                   7366:          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
                   7367:          target to work.</p>
                   7368: <p><span class="emphasis"><em>Be careful when using this
                   7369:          target!</em></span> There are no guarantees that dependent
                   7370:          packages will still work, in particular they will most
1.10      hubertf  7371:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1       dsieger  7372:          library package whose shared library major version changed
                   7373:          between your installed version and the new one.  For this
                   7374:          reason, this target is not officially supported and only
                   7375:          recommended for advanced users.</p>
                   7376: </dd>
                   7377: <dt><span class="term">info</span></dt>
1.10      hubertf  7378: <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.1       dsieger  7379:          package. You can use this to check which version of a
                   7380:          package is installed.</p></dd>
                   7381: <dt><span class="term">index</span></dt>
                   7382: <dd>
                   7383: <p>This is a top-level command, i.e. it should be used in
                   7384:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7385:          database of all packages in the local pkgsrc tree, including
                   7386:          dependencies, comment, maintainer, and some other useful
                   7387:          information.  Individual entries are created by running
1.10      hubertf  7388:          <span class="command"><strong>make describe</strong></span> in the packages'
1.1       dsieger  7389:          directories.  This index file is saved as
                   7390:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.10      hubertf  7391:          verbose format by running <span class="command"><strong>make
1.1       dsieger  7392:          print-index</strong></span>.  You can search in it with
1.10      hubertf  7393:          <span class="command"><strong>make search
1.1       dsieger  7394:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7395:          extract a list of all packages that depend on a particular
1.10      hubertf  7396:          one by running <span class="command"><strong>make show-deps
1.1       dsieger  7397:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7398: <p>Running this command takes a very long time, some
                   7399:          hours even on fast machines!</p>
                   7400: </dd>
                   7401: <dt><span class="term">readme</span></dt>
                   7402: <dd>
                   7403: <p>This target generates a
                   7404:          <code class="filename">README.html</code> file, which can be
                   7405:          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
                   7406:          contain references to any packages which are in the
                   7407:          <code class="varname">PACKAGES</code> directory on the local
                   7408:          host. The generated files can be made to refer to URLs
                   7409:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7410:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7411:          wanted to generate <code class="filename">README.html</code>
                   7412:          files which pointed to binary packages on the local
                   7413:          machine, in the directory
                   7414:          <code class="filename">/usr/packages</code>, set
                   7415:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7416:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7417:          <code class="varname">${PACKAGES}</code> directory and its
                   7418:          subdirectories will be searched for all the binary
                   7419:          packages.</p>
                   7420: <p>The target can be run at the toplevel or in category
                   7421:          directories, in which case it descends recursively.</p>
                   7422: </dd>
                   7423: <dt><span class="term">readme-all</span></dt>
                   7424: <dd><p>This is a top-level command, run it in
                   7425:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7426:          file <code class="filename">README-all.html</code> which contains a
                   7427:          list of all packages currently available in the NetBSD
                   7428:          Packages Collection, together with the category they belong
                   7429:          to and a short description. This file is compiled from the
                   7430:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10      hubertf  7431:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1       dsieger  7432:          readme</strong></span>.</p></dd>
                   7433: <dt><span class="term">cdrom-readme</span></dt>
                   7434: <dd><p>This is very much the same as the
                   7435:          &#8220;<span class="quote">readme</span>&#8221; target (see above), but is to be
                   7436:          used when generating a pkgsrc tree to be written to a
                   7437:          CD-ROM.  This target also produces
                   7438:          <code class="filename">README.html</code> files, and can be made
                   7439:          to refer to URLs based on
                   7440:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   7441:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   7442: <dt><span class="term">show-distfiles</span></dt>
                   7443: <dd><p>This target shows which distfiles and patchfiles
                   7444:          are needed to build the package
                   7445:          (<code class="varname">ALLFILES</code>, which contains all
                   7446:          <code class="varname">DISTFILES</code> and
                   7447:          <code class="varname">PATCHFILES</code>, but not
                   7448:          <code class="filename">patches/*</code>).</p></dd>
                   7449: <dt><span class="term">show-downlevel</span></dt>
                   7450: <dd><p>This target shows nothing if the package is not
                   7451:          installed. If a version of this package is installed,
                   7452:          but is not the version provided in this version of
                   7453:          pkgsrc, then a warning message is displayed. This target
                   7454:          can be used to show which of your installed packages are
                   7455:          downlevel, and so the old versions can be deleted, and
                   7456:          the current ones added.</p></dd>
                   7457: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   7458: <dd><p>This target shows the directory in the pkgsrc
                   7459:          hierarchy from which the package can be built and
                   7460:          installed. This may not be the same directory as the one
                   7461:          from which the package was installed. This target is
                   7462:          intended to be used by people who may wish to upgrade
                   7463:          many packages on a single host, and can be invoked from
                   7464:          the top-level pkgsrc Makefile by using the
                   7465:          &#8220;<span class="quote">show-host-specific-pkgs</span>&#8221; target.</p></dd>
                   7466: <dt><span class="term">show-installed-depends</span></dt>
                   7467: <dd><p>This target shows which installed packages match
                   7468:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7469:          if out of date dependencies are causing build
                   7470:          problems.</p></dd>
                   7471: <dt><span class="term">check-shlibs</span></dt>
                   7472: <dd><p>After a package is installed, check all its
                   7473:          binaries and (on ELF platforms) shared libraries to see
                   7474:          if they find the shared libs they need.  Run by default
1.10      hubertf  7475:          if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1       dsieger  7476: <dt><span class="term">print-PLIST</span></dt>
                   7477: <dd>
                   7478: <p>After a &#8220;<span class="quote">make install</span>&#8221; from a new or
                   7479:          upgraded pkg, this prints out an attempt to generate a
1.10      hubertf  7480:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1       dsieger  7481:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7482:          to care for shared libs etc., but it is
                   7483:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7484:          result before putting it into
                   7485:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7486:          diff the output of this command against an already
                   7487:          existing <code class="filename">PLIST</code> file.</p>
1.10      hubertf  7488: <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.1       dsieger  7489:          other methods that don't update file access times, be
                   7490:          sure to add these files manually to your
                   7491:          <code class="filename">PLIST</code>, as the &#8220;<span class="quote">find
                   7492:          -newer</span>&#8221; command used by this target won't catch
                   7493:          them!</p>
1.15      rillig   7494: <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.1       dsieger  7495:          information on this target.</p>
                   7496: </dd>
                   7497: <dt><span class="term">bulk-package</span></dt>
                   7498: <dd>
                   7499: <p>Used to do bulk builds. If an appropriate binary
                   7500:          package already exists, no action is taken. If not, this
                   7501:          target will compile, install and package it (and its
                   7502:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.10      hubertf  7503:          properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
1.1       dsieger  7504:          After creating the binary package, the sources, the
                   7505:          just-installed package and its required packages are
                   7506:          removed, preserving free disk space.</p>
                   7507: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7508:          all packages installed on a system!</em></span></p>
                   7509: </dd>
                   7510: <dt><span class="term">bulk-install</span></dt>
                   7511: <dd>
                   7512: <p>Used during bulk-installs to install required
                   7513:          packages. If an up-to-date binary package is available,
1.10      hubertf  7514:          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,
                   7515:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1       dsieger  7516:          but the installed binary won't be removed.</p>
                   7517: <p>A binary package is considered
                   7518:          &#8220;<span class="quote">up-to-date</span>&#8221; to be installed via
1.10      hubertf  7519:          <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.1       dsieger  7520: <div class="itemizedlist"><ul type="disc">
                   7521: <li><p>None of the package's files
                   7522:              (<code class="filename">Makefile</code>, ...) were modified
                   7523:              since it was built.</p></li>
                   7524: <li><p>None of the package's required (binary)
                   7525:              packages were modified since it was built.</p></li>
                   7526: </ul></div>
                   7527: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7528:          all packages installed on a system!</em></span></p>
                   7529: </dd>
                   7530: </dl></div>
                   7531: </div>
                   7532: </div>
                   7533: <div class="chapter" lang="en">
                   7534: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7535: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  7536: <div class="toc">
                   7537: <p><b>Table of Contents</b></p>
                   7538: <dl>
1.6       rillig   7539: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7540: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7541: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7542: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.1       dsieger  7543: </dl>
                   7544: </div>
                   7545: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   7546: by pkgsrc and also for individual packages to define what commands
                   7547: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7548: or for later run-time of an installed packaged (such as
                   7549: <code class="varname">DEPENDS</code>).
                   7550: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   7551: package will not be used.</p>
                   7552: <p>When building a package, the replacement tools are
                   7553: made available in a directory (as symlinks or wrapper scripts)
                   7554: that is early in the executable search path. Just like the buildlink
                   7555: system, this helps with consistent builds.</p>
                   7556: <p>A tool may be needed to help build a specific package. For example,
                   7557: perl, GNU make (gmake) or yacc may be needed.</p>
                   7558: <p>Also a tool may be needed, for example, because the native system's supplied
                   7559: tool may be inefficient for building a package with pkgsrc.
                   7560: For example, a package may need GNU awk, bison (instead of
                   7561: yacc) or a better sed.</p>
                   7562: <p>The tools used by a package can be listed by running
1.10      hubertf  7563: <span class="command"><strong>make show-tools</strong></span>.</p>
1.1       dsieger  7564: <div class="sect1" lang="en">
                   7565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7566: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1       dsieger  7567: <p>The default set of tools used by pkgsrc is defined in
                   7568: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10      hubertf  7569: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7570: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1       dsieger  7571: These can be seen by running:
1.10      hubertf  7572: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1       dsieger  7573: <p>If a package needs a specific program to build
                   7574: then the <code class="varname">USE_TOOLS</code> variable can be used
                   7575: to define the tools needed.</p>
                   7576: </div>
                   7577: <div class="sect1" lang="en">
                   7578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7579: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.1       dsieger  7580: <p>In the following examples, the :pkgsrc means to use the pkgsrc version
                   7581: and not the native version for a build dependency.
                   7582: And the :run means that it is used for a
                   7583: run-time dependencies also (and becomes a DEPENDS).
                   7584: The default is a build dependency which can be set with
                   7585: :build. (So in this example, it is the same as gmake:build
                   7586: and pkg-config:build.)</p>
                   7587: <pre class="programlisting">
                   7588: USE_TOOLS+=     mktemp:pkgsrc
                   7589: USE_TOOLS+=     gmake perl:run pkg-config
                   7590: </pre>
                   7591: <p>When using the tools framework, a
                   7592: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7593: which contains the full path to the appropriate tool. For example,
                   7594: <code class="varname">TOOLS_PATH.bash</code> could be &#8220;<span class="quote">/bin/bash</span>&#8221;
                   7595: on Linux systems.</p>
                   7596: <p>If you always need a pkgsrc version of the
                   7597: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7598: </p>
                   7599: </div>
                   7600: <div class="sect1" lang="en">
                   7601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7602: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1       dsieger  7603: <p>When improving or porting pkgsrc to a new platform, have a look
                   7604: at (or create) the corresponding platform specific make file fragment under
                   7605: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   7606: the name of the common tools. For example:</p>
                   7607: <pre class="programlisting">
                   7608: .if exists(/usr/bin/bzcat)
                   7609: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7610: .elif exists(/usr/bin/bzip2)
                   7611: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7612: .endif
                   7613: 
                   7614: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7615: </pre>
                   7616: </div>
                   7617: <div class="sect1" lang="en">
                   7618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7619: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.1       dsieger  7620: <div class="qandaset">
                   7621: <dl>
1.6       rillig   7622: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.1       dsieger  7623: </dt>
1.6       rillig   7624: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.1       dsieger  7625:        tools?</a>
                   7626: </dt>
1.6       rillig   7627: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.1       dsieger  7628:        package is using while being built? I want to know whether it
                   7629:        uses sed or not.</a>
                   7630: </dt>
                   7631: </dl>
                   7632: <table border="0" summary="Q and A Set">
                   7633: <col align="left" width="1%">
                   7634: <tbody>
                   7635: <tr class="question">
                   7636: <td align="left" valign="top">
1.17    ! imil     7637: <a name="tools.new"></a><a name="id52054999"></a><p><b>18.4.1.</b></p>
1.1       dsieger  7638: </td>
                   7639: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7640: </tr>
                   7641: <tr class="answer">
                   7642: <td align="left" valign="top"></td>
                   7643: <td align="left" valign="top"><p>TODO</p></td>
                   7644: </tr>
                   7645: <tr class="question">
                   7646: <td align="left" valign="top">
1.17    ! imil     7647: <a name="tools.listall"></a><a name="id52055008"></a><p><b>18.4.2.</b></p>
1.1       dsieger  7648: </td>
                   7649: <td align="left" valign="top"><p>How do I get a list of all available
                   7650:        tools?</p></td>
                   7651: </tr>
                   7652: <tr class="answer">
                   7653: <td align="left" valign="top"></td>
                   7654: <td align="left" valign="top"><p>TODO</p></td>
                   7655: </tr>
                   7656: <tr class="question">
                   7657: <td align="left" valign="top">
1.17    ! imil     7658: <a name="tools.used"></a><a name="id52055016"></a><p><b>18.4.3.</b></p>
1.1       dsieger  7659: </td>
                   7660: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7661:        package is using while being built? I want to know whether it
                   7662:        uses sed or not.</p></td>
                   7663: </tr>
                   7664: <tr class="answer">
                   7665: <td align="left" valign="top"></td>
                   7666: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7667:        to do it.)</p></td>
                   7668: </tr>
                   7669: </tbody>
                   7670: </table>
                   7671: </div>
                   7672: </div>
                   7673: </div>
                   7674: <div class="chapter" lang="en">
                   7675: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   7676: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1       dsieger  7677: <div class="toc">
                   7678: <p><b>Table of Contents</b></p>
                   7679: <dl>
1.6       rillig   7680: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1       dsieger  7681: <dd><dl>
1.6       rillig   7682: <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
1.15      rillig   7683: <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.6       rillig   7684: <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
                   7685: <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
                   7686: <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
                   7687: <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
                   7688: <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
                   7689: <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
                   7690: <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
                   7691: <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
                   7692: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7693: <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7694: </dl></dd>
1.15      rillig   7695: <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the fetch phase</a></span></dt>
1.6       rillig   7696: <dd><dl>
                   7697: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7698: <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>
                   7699: </dl></dd>
1.15      rillig   7700: <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the configure phase</a></span></dt>
1.6       rillig   7701: <dd><dl>
                   7702: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7703: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7704: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7705: </dl></dd>
                   7706: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7707: <dd><dl>
                   7708: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7709: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7710: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
                   7711: <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
                   7712: </dl></dd>
1.15      rillig   7713: <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the build phase</a></span></dt>
1.6       rillig   7714: <dd><dl>
                   7715: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7716: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.15      rillig   7717: <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to ...</a></span></dt>
1.6       rillig   7718: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7719: </dl></dd>
1.15      rillig   7720: <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the install phase</a></span></dt>
1.6       rillig   7721: <dd><dl>
                   7722: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7723: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7724: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7725: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7726: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7727: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7728: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7729: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   7730: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.6       rillig   7731: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper data files</a></span></dt>
                   7732: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7733: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7734: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7735: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7736: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7737: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7738: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7739: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  7740:     emulation</a></span></dt>
1.6       rillig   7741: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7742: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  7743: </dl></dd>
1.6       rillig   7744: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  7745: </dl>
                   7746: </div>
                   7747: <div class="sect1" lang="en">
                   7748: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7749: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1       dsieger  7750: <div class="sect2" lang="en">
                   7751: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7752: <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
1.1       dsieger  7753: <p>One appealing feature of pkgsrc is that it runs on many
                   7754:     different platforms. As a result, it is important to ensure,
                   7755:     where possible, that packages in pkgsrc are portable. This
                   7756:     chapter mentions some particular details you should pay
                   7757:     attention to while working on pkgsrc.</p>
                   7758: </div>
                   7759: <div class="sect2" lang="en">
                   7760: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  7761: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.2. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  7762: </h3></div></div></div>
                   7763: <p>The pkgsrc user can configure pkgsrc by overriding several
                   7764:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  7765:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  7766:     want to use those variables in the preprocessor directives of
1.10      hubertf  7767:     <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.1       dsieger  7768:     <code class="literal">.for</code>), you need to include the file
                   7769:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7770:     loads the user preferences.</p>
                   7771: <p>But note that some variables may not be completely defined
                   7772:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7773:     included, as they may contain references to variables that are
                   7774:     not yet defined. In shell commands this is no problem, since
                   7775:     variables are actually macros, which are only expanded when they
                   7776:     are used. But in the preprocessor directives mentioned above and
                   7777:     in dependency lines (of the form <code class="literal">target:
                   7778:     dependencies</code>) the variables are expanded at load
                   7779:     time.</p>
                   7780: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   7781: <h3 class="title">Note</h3>
                   7782: <p>Currently there is no exhaustive list of all
                   7783:     variables that tells you whether they can be used at load time
                   7784:     or only at run time, but it is in preparation.</p>
                   7785: </div>
                   7786: </div>
                   7787: <div class="sect2" lang="en">
                   7788: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7789: <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
1.1       dsieger  7790: <p>Occasionally, packages require interaction from the user,
                   7791:     and this can be in a number of ways:</p>
                   7792: <div class="itemizedlist"><ul type="disc">
                   7793: <li><p>When fetching the distfiles, some packages require user
                   7794:        interaction such as entering username/password or accepting a
                   7795:        license on a web page.</p></li>
                   7796: <li><p>When extracting the distfiles, some packages may ask for
                   7797:        passwords.</p></li>
                   7798: <li><p>help to configure the package before it is built</p></li>
                   7799: <li><p>help during the build process</p></li>
                   7800: <li><p>help during the installation of a package</p></li>
                   7801: </ul></div>
                   7802: <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
                   7803:     provided to notify the pkgsrc mechanism of an interactive stage
                   7804:     which will be needed, and this should be set in the package's
                   7805:     <code class="filename">Makefile</code>, e.g.:</p>
                   7806: <pre class="programlisting">
                   7807: INTERACTIVE_STAGE=      build
                   7808:     </pre>
                   7809: <p>Multiple interactive stages can be specified:</p>
                   7810: <pre class="programlisting">
                   7811: INTERACTIVE_STAGE=      configure install
                   7812:     </pre>
                   7813: <p>The user can then decide to skip this package by setting the
                   7814:     <code class="varname">BATCH</code> variable.</p>
                   7815: </div>
                   7816: <div class="sect2" lang="en">
                   7817: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7818: <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
1.1       dsieger  7819: <p>Authors of software can choose the licence under which
                   7820:     software can be copied.  This is due to copyright law, and reasons
                   7821:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7822:     system recognizes that there are a number of licenses which some
                   7823:     users may find objectionable or difficult or impossible to comply
                   7824:     with.  The Free Software Foundation has declared some licenses
                   7825:     "Free", and the Open Source Initiative has a definition of "Open
                   7826:     Source".  The pkgsrc system, as a policy choice, does not label
                   7827:     packages which have licenses that are Free or Open Source.
                   7828:     However, packages without a license meeting either of those tests
                   7829:     are labeled with a license tag denoting the license.  Note that a
                   7830:     package with no license to copy trivially does not meet either the
                   7831:     Free or Open Source test.</p>
                   7832: <p>For packages which are not Free or Open Source, pkgsrc will
                   7833:     not build the package unless the user has indicated to pkgsrc that
                   7834:     packages with that particular license may be built.  Note that
                   7835:     this documentation avoids the term "accepted the license".  The
                   7836:     pkgsrc system is merely providing a mechanism to avoid
                   7837:     accidentally building a package with a non-free license;
                   7838:     judgement and responsibility remain with the user.  (Installation
                   7839:     of binary packages are not currently subject to this mechanism;
                   7840:     this is a bug.)</p>
                   7841: <p>One might want to only install packages with a BSD license,
                   7842:     or the GPL, and not the other.  The pkgsrc license tag mechanism
                   7843:     does not provide a way to do this.  It might be possible to put in
                   7844:     tags for free licenses, and have a default
                   7845:     <code class="varname">ACCEPTABLE_LICENSES</code> variable value, but this is
                   7846:     widely viewed as having a very poor ratio of benefit to
                   7847:     work.</p>
                   7848: <p>The license tag mechanism is intended to address
                   7849:     copyright-related issues surrounding building, installing and
                   7850:     using a package, and not to address redistribution issues (see
                   7851:     <code class="varname">RESTRICTED</code> and
                   7852:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  However, the above
                   7853:     definition of licenses for which tags are not needed implies
                   7854:     that packages with redistribution restrictions should have
                   7855:     tags, because Free or Open Source programs do not have
                   7856:     redistribution restrictions.</p>
                   7857: <p>Denoting that a package may be copied according to a
                   7858:     particular license is done by placing the license in
                   7859:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7860:     <code class="varname">LICENSE</code> variable to a string identifying the
                   7861:     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>
                   7862: <pre class="programlisting">
                   7863: LICENSE=        xv-license
                   7864:     </pre>
                   7865: <p>When trying to build, the user will get a notice that the
                   7866:     package is covered by a license which has not been placed in the
                   7867:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7868: <pre class="programlisting">
                   7869: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7870: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7871: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7872: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7873: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7874: *** Error code 1
                   7875:     </pre>
1.10      hubertf  7876: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  7877:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  7878:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7879:     convey to pkgsrc that it should not in the future fail because of
                   7880:     that license:</p>
                   7881: <pre class="programlisting">
                   7882: ACCEPTABLE_LICENSES+=xv-license
                   7883:     </pre>
                   7884: <p>When adding a package with a new license, the license text
                   7885:     should be added to <code class="filename">pkgsrc/licenses</code> for
                   7886:     displaying.  A list of known licenses can be seen in this
                   7887:     directory.</p>
                   7888: <p>When the license changes (in a way other than formatting),
                   7889:     please make sure that the new license has a different name (e.g.,
                   7890:     append the version number if it exists, or the date).  Just
                   7891:     because a user told pkgsrc to build programs under a previous
                   7892:     version of a license does not mean that pkgsrc should build
                   7893:     programs under the new licenses.  The higher-level point is that
                   7894:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7895:     test is a mechanistic test of whether a particular text has been
                   7896:     approved by either of two bodies.</p>
                   7897: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7898:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7899:     is deprecated because it does not crisply refer to a particular
                   7900:     license text.  Another problem with such usage is that it does not
                   7901:     enable a user to tell pkgsrc to proceed for a single package
                   7902:     without also telling pkgsrc to proceed for all packages with that
                   7903:     tag.</p>
                   7904: </div>
                   7905: <div class="sect2" lang="en">
                   7906: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7907: <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
1.1       dsieger  7908: <p>Some licenses restrict how software may be re-distributed.
                   7909:     Because a license tag is required unless the package is Free or
                   7910:     Open Source, all packages with restrictions should have license
                   7911:     tags.  By declaring the restrictions, package tools can
                   7912:     automatically refrain from e.g. placing binary packages on FTP
                   7913:     sites.</p>
                   7914: <p>There are four restrictions that may be encoded, which are
                   7915:     the cross product of sources (distfiles) and binaries not being
                   7916:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7917:     language in any license, and because non-Free licenses tend to be
                   7918:     different from each other, pkgsrc adopts a definition of FTP and
                   7919:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7920:     should not be made available over the Internet at no charge.
                   7921:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7922:     made available on some kind of media, together with other source
                   7923:     and binary packages, and which is sold for a distribution charge.
                   7924:     </p>
                   7925: <p>In order to encode these restrictions, the package system
                   7926:     defines five make variables that can be set to note these
                   7927:     restrictions:</p>
                   7928: <div class="itemizedlist"><ul type="disc">
                   7929: <li>
                   7930: <p><code class="varname">RESTRICTED</code></p>
                   7931: <p>This variable should be set whenever a restriction
                   7932:        exists (regardless of its kind).  Set this variable to a
                   7933:        string containing the reason for the restriction.  It should
                   7934:        be understood that those wanting to understand the restriction
                   7935:        will have to read the license, and perhaps seek advice of
                   7936:        counsel.</p>
                   7937: </li>
                   7938: <li>
                   7939: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7940: <p>Binaries may not be placed on CD-ROM containing other
                   7941:        binary packages, for which a distribution charge may be made.
                   7942:        In this case, set this variable to
                   7943:        <code class="varname">${RESTRICTED}</code>.</p>
                   7944: </li>
                   7945: <li>
                   7946: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7947: <p>Binaries may not made available on the Internet without
                   7948:        charge.  In this case, set this variable to
                   7949:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7950:        binary packages will not be included on ftp.NetBSD.org.</p>
                   7951: </li>
                   7952: <li>
                   7953: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7954: <p>Distfiles may not be placed on CD-ROM, together with
                   7955:        other distfiles, for which a fee may be charged.  In this
                   7956:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7957:        </p>
                   7958: </li>
                   7959: <li>
                   7960: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7961: <p>Distfiles may not made available via FTP at no charge.
                   7962:        In this case, set this variable to
                   7963:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7964:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7965: </li>
                   7966: </ul></div>
                   7967: <p>Please note that the use of <code class="varname">NO_PACKAGE</code>,
                   7968:     <code class="varname">IGNORE</code>, <code class="varname">NO_CDROM</code>, or other
                   7969:     generic make variables to denote restrictions is deprecated,
                   7970:     because they unconditionally prevent users from generating
                   7971:     binary packages!</p>
                   7972: </div>
                   7973: <div class="sect2" lang="en">
                   7974: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7975: <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
1.1       dsieger  7976: <p>Your package may depend on some other package being present
                   7977:     - and there are various ways of expressing this dependency.
                   7978:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7979:     <code class="varname">DEPENDS</code> definitions, the
                   7980:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7981:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7982:     to handle dependencies, and which uses the variables named above.
1.10      hubertf  7983:     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1       dsieger  7984: <p>The basic difference between the two variables is as
                   7985:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7986:     that pre-requisite in the binary package so it will be pulled in
                   7987:     when the binary package is later installed, whilst the
                   7988:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7989:     dependency that is only needed for building the package.</p>
                   7990: <p>This means that if you only need a package present whilst
                   7991:     you are building, it should be noted as a
                   7992:     <code class="varname">BUILD_DEPENDS</code>.</p>
                   7993: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
                   7994:     <code class="varname">DEPENDS</code> definition is:</p>
                   7995: <pre class="programlisting">
                   7996: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
                   7997:     </pre>
                   7998: <p>Please note that the &#8220;<span class="quote">pre-req-package-name</span>&#8221;
                   7999:     may include any of the wildcard version numbers recognized by
1.10      hubertf  8000:     <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.1       dsieger  8001: <div class="orderedlist"><ol type="1">
                   8002: <li>
                   8003: <p>If your package needs another package's binaries or
                   8004:        libraries to build or run, and if that package has a
                   8005:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   8006: <pre class="programlisting">
                   8007: .include "../../graphics/jpeg/buildlink3.mk"
                   8008:        </pre>
                   8009: </li>
                   8010: <li>
                   8011: <p>If your package needs to use another package to build
                   8012:        itself and there is no <code class="filename">buildlink3.mk</code>
                   8013:        file available, use the <code class="varname">BUILD_DEPENDS</code>
                   8014:        definition:</p>
                   8015: <pre class="programlisting">
                   8016: BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
                   8017:        </pre>
                   8018: </li>
                   8019: <li>
                   8020: <p>If your package needs a library with which to link and
                   8021:        again there is no <code class="filename">buildlink3.mk</code> file
                   8022:        available, this is specified using the
                   8023:        <code class="varname">DEPENDS</code> definition. For example:</p>
                   8024: <pre class="programlisting">
                   8025: DEPENDS+=       xpm-3.4j:../../graphics/xpm
                   8026:        </pre>
1.9       rillig   8027: <p>You can also use wildcards in package dependencies:</p>
1.1       dsieger  8028: <pre class="programlisting">
                   8029: DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
                   8030:        </pre>
                   8031: <p>Note that such wildcard dependencies are retained when
                   8032:        creating binary packages.  The dependency is checked when
                   8033:        installing the binary package and any package which matches
                   8034:        the pattern will be used.  Wildcard dependencies should be
                   8035:        used with care.</p>
                   8036: <p>The &#8220;<span class="quote">-[0-9]*</span>&#8221; should be used instead of
                   8037:        &#8220;<span class="quote">-*</span>&#8221; to avoid potentially ambiguous matches
                   8038:        such as &#8220;<span class="quote">tk-postgresql</span>&#8221; matching a
                   8039:        &#8220;<span class="quote">tk-*</span>&#8221; <code class="varname">DEPENDS</code>.</p>
                   8040: <p>Wildcards can also be used to specify that a package
                   8041:        will only build against a certain minimum version of a
                   8042:        pre-requisite:</p>
                   8043: <pre class="programlisting">
                   8044: DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
                   8045:        </pre>
                   8046: <p>This means that the package will build against version
                   8047:        3.5.4 of the tiff library or newer.  Such a dependency may
                   8048:        be warranted if, for example, the API of the library has
                   8049:        changed with version 3.5.4 and a package would not compile
                   8050:        against an earlier version of tiff.</p>
                   8051: <p>Please note that such dependencies should only be
                   8052:        updated if a package requires a newer pre-requisite, but
                   8053:        not to denote recommendations such as
                   8054:        ABI changes that do not prevent a package from building
                   8055:        correctly.  Such recommendations can be expressed using
                   8056:        <code class="varname">ABI_DEPENDS</code>:</p>
                   8057: <pre class="programlisting">
                   8058: ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
                   8059:        </pre>
                   8060: <p>In addition to the above <code class="varname">DEPENDS</code>
                   8061:        line, this denotes that while a package will build against
                   8062:        tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
                   8063:        <code class="varname">ABI_DEPENDS</code> entries will be turned into
                   8064:        dependencies unless explicitly ignored (in which case a
                   8065:        warning will be printed).</p>
                   8066: <p>To ignore these ABI dependency recommendations and just
                   8067:        use the required <code class="varname">DEPENDS</code>, set
                   8068:        <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
                   8069:        it easier and faster to update packages built using pkgsrc,
                   8070:        since older compatible dependencies can continue to be
                   8071:        used. This is useful for people who watch their rebuilds
                   8072:        very carefully; it is not very good as a general-purpose
                   8073:        hammer.  If you use it, you need to be mindful of possible
                   8074:        ABI changes, including those from the underlying OS.</p>
                   8075: <p>Packages that are built with recommendations ignored
                   8076:        may not be uploaded to ftp.NetBSD.org by developers and
                   8077:        should not be used across different systems that may have
                   8078:        different versions of binary packages installed.</p>
                   8079: <p>For security fixes, please update the package
1.10      hubertf  8080:        vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.10. Handling packages with security problems">Section 19.1.10, &#8220;Handling packages with security problems&#8221;</a> for more
1.1       dsieger  8081:        information.</p>
                   8082: </li>
                   8083: <li>
                   8084: <p>If your package needs some executable to be able to run
                   8085:        correctly and if there's no
                   8086:        <code class="filename">buildlink3.mk</code> file, this is specified
                   8087:        using the <code class="varname">DEPENDS</code> variable. The
                   8088:        <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
                   8089:        be able to execute the latex binary from the teTeX package
                   8090:        when it runs, and that is specified:</p>
                   8091: <pre class="programlisting">
                   8092: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
                   8093:        </pre>
                   8094: <p>The comment about wildcard dependencies from previous
                   8095:        paragraph applies here, too.</p>
                   8096: </li>
                   8097: </ol></div>
                   8098: <p>If your package needs files from another package to build,
                   8099:     add the relevant distribution files to
                   8100:     <code class="varname">DISTFILES</code>, so they will be extracted
                   8101:     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.
                   8102:     (It relies on the jpeg sources being present in source form
                   8103:     during the build.)</p>
                   8104: </div>
                   8105: <div class="sect2" lang="en">
                   8106: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8107: <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  8108: <p>Your package may conflict with other packages a user might
                   8109:     already have installed on his system, e.g. if your package
                   8110:     installs the same set of files as another package in the pkgsrc
                   8111:     tree.</p>
                   8112: <p>In this case you can set <code class="varname">CONFLICTS</code> to a
                   8113:     space-separated list of packages (including version string) your
                   8114:     package conflicts with.</p>
                   8115: <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>
                   8116:     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>
                   8117:     install the same shared library, thus you set in
                   8118:     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
                   8119: <pre class="programlisting">
                   8120: CONFLICTS=      Xaw-Xpm-[0-9]*
                   8121:     </pre>
                   8122: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   8123: <pre class="programlisting">
                   8124: CONFLICTS=      Xaw3d-[0-9]*
                   8125:     </pre>
                   8126: <p>Packages will automatically conflict with other packages
                   8127:     with the name prefix and a different version
                   8128:     string. &#8220;<span class="quote">Xaw3d-1.5</span>&#8221; e.g. will automatically
                   8129:     conflict with the older version &#8220;<span class="quote">Xaw3d-1.3</span>&#8221;.</p>
                   8130: </div>
                   8131: <div class="sect2" lang="en">
                   8132: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8133: <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  8134: <p>There are several reasons why a package might be
                   8135:     instructed to not build under certain circumstances.  If the
                   8136:     package builds and runs on most platforms, the exceptions
                   8137:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
                   8138:     the package builds and runs on a small handful of platforms,
                   8139:     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
                   8140:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   8141:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   8142:     (OS-version-platform) that can use glob-style
                   8143:     wildcards.</p>
                   8144: <p>Some packages are tightly bound to a specific version of an
                   8145:     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
                   8146:     backwards compatible with other versions of the OS, and should be
                   8147:     uploaded to a version specific directory on the FTP server.  Mark
                   8148:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
                   8149:     &#8220;<span class="quote">yes</span>&#8221;.  This variable is not currently used by any of
                   8150:     the package system internals, but may be used in the
                   8151:     future.</p>
                   8152: <p>If the package should be skipped (for example, because it
                   8153:     provides functionality already provided by the system), set
                   8154:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   8155:     the package should fail because some preconditions are not met,
                   8156:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   8157:     message.</p>
                   8158: </div>
                   8159: <div class="sect2" lang="en">
                   8160: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8161: <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  8162: <p>To ensure that a package may not be deleted, once it has been
                   8163:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   8164:     be set in the package Makefile. This will be carried into any
                   8165:     binary package that is made from this pkgsrc entry. A
                   8166:     &#8220;<span class="quote">preserved</span>&#8221; package will
1.10      hubertf  8167:     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.1       dsieger  8168:     &#8220;<span class="quote">-f</span>&#8221; option is used.</p>
                   8169: </div>
                   8170: <div class="sect2" lang="en">
                   8171: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8172: <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  8173: <p>When a vulnerability is found, this should be noted in
                   8174:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.10      hubertf  8175:     and after committing that file, use <span class="command"><strong>make upload</strong></span>
1.1       dsieger  8176:     in the same directory to update the file on ftp.NetBSD.org.</p>
                   8177: <p>After fixing the vulnerability by a patch, its
                   8178:     <code class="varname">PKGREVISION</code> should be increased (this
                   8179:     is of course not necessary if the problem is fixed by using
                   8180:     a newer release of the software).</p>
                   8181: <p>Also, if the fix should be applied to the stable pkgsrc
                   8182:     branch, be sure to submit a pullup request!</p>
                   8183: <p>Binary packages already on ftp.NetBSD.org will be handled
                   8184:     semi-automatically by a weekly cron job.</p>
                   8185: </div>
                   8186: <div class="sect2" lang="en">
                   8187: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8188: <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1       dsieger  8189: <p>When making fixes to an existing package it can be useful
                   8190:     to change the version number in <code class="varname">PKGNAME</code>. To
                   8191:     avoid conflicting with future versions by the original author, a
                   8192:     &#8220;<span class="quote">nb1</span>&#8221;, &#8220;<span class="quote">nb2</span>&#8221;, ... suffix can be used
                   8193:     on package versions by setting <code class="varname">PKGREVISION=1</code>
                   8194:     (2, ...). The &#8220;<span class="quote">nb</span>&#8221; is treated like a
                   8195:     &#8220;<span class="quote">.</span>&#8221; by the package tools. e.g.</p>
                   8196: <pre class="programlisting">
                   8197: DISTNAME=       foo-17.42
                   8198: PKGREVISION=    9
                   8199:     </pre>
                   8200: <p>will result in a <code class="varname">PKGNAME</code> of
                   8201:     &#8220;<span class="quote">foo-17.42nb9</span>&#8221;. If you want to use the original
                   8202:     value of <code class="varname">PKGNAME</code> without the &#8220;<span class="quote">nbX</span>&#8221;
                   8203:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   8204:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   8205: <p>When a new release of the package is released, the
                   8206:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   8207:     minor release of the above package, things should be like:</p>
                   8208: <pre class="programlisting">
                   8209: DISTNAME=       foo-17.43
                   8210:     </pre>
                   8211: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   8212:     non-trivial change in the resulting binary package.  Without a
                   8213:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   8214:     version installed has no way of knowing that their package is out
                   8215:     of date.  Thus, changes without increasing
                   8216:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   8217:     trivial that no reasonable person would want to upgrade", and this
                   8218:     is the rough test for when increasing
                   8219:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   8220:     changes that do not merit increasing
                   8221:     <code class="varname">PKGREVISION</code> are:</p>
                   8222: <div class="itemizedlist"><ul type="disc">
1.14      jmcneill 8223: <li><p>Changing <code class="varname">HOMEPAGE</code>,
                   8224:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1       dsieger  8225:       or comments in Makefile.</p></li>
                   8226: <li><p>
                   8227:       Changing build variables if the resulting binary package is the same.</p></li>
                   8228: <li><p>
                   8229:       Changing <code class="filename">DESCR</code>.</p></li>
                   8230: <li><p>
                   8231:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   8232: </ul></div>
                   8233: <p>Examples of changes that do merit an increase to
                   8234:     <code class="varname">PKGREVISION</code> include:</p>
                   8235: <div class="itemizedlist"><ul type="disc">
                   8236: <li><p>
                   8237:       Security fixes</p></li>
                   8238: <li><p>
                   8239:       Changes or additions to a patch file</p></li>
                   8240: <li><p>
                   8241:       Changes to the <code class="filename">PLIST</code></p></li>
1.12      weinem   8242: <li><p>A dependency is changed or renamed.</p></li>
1.1       dsieger  8243: </ul></div>
                   8244: <p>PKGREVISION must also be incremented when dependencies have ABI
                   8245:     changes.</p>
                   8246: </div>
                   8247: <div class="sect2" lang="en">
                   8248: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8249: <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1       dsieger  8250: <p>When you want to replace the same text in multiple files
                   8251:     or when the replacement text varies, patches alone cannot help.
                   8252:     This is where the SUBST framework comes in. It provides an
                   8253:     easy-to-use interface for replacing text in files.
                   8254:     Example:</p>
                   8255: <pre class="programlisting">
                   8256: SUBST_CLASSES+=                 fix-paths
                   8257: SUBST_STAGE.fix-paths=          pre-configure
                   8258: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   8259: SUBST_FILES.fix-paths=          src/*.c
                   8260: SUBST_FILES.fix-paths+=         scripts/*.sh
                   8261: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   8262: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
                   8263:     </pre>
                   8264: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
                   8265:     that are used to identify the different SUBST blocks that are
                   8266:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   8267:     important to always use the <code class="literal">+=</code> operator with
                   8268:     this variable. Otherwise some substitutions may be
                   8269:     skipped.</p>
                   8270: <p>The remaining variables of each SUBST block are
                   8271:     parameterized with the identifier from the first line
                   8272:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   8273:     parameters to a function call.</p>
                   8274: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
                   8275:     which the replacement will take place. All combinations of
                   8276:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   8277:     <code class="literal">post-</code> together with a phase name are
                   8278:     possible, though only few are actually used. Most commonly used
                   8279:     are <code class="literal">post-patch</code> and
                   8280:     <code class="literal">pre-configure</code>. Of these two,
                   8281:     <code class="literal">pre-configure</code> should be preferred because
1.10      hubertf  8282:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1       dsieger  8283:     have the state after applying the patches but before making any
                   8284:     other changes. This is especially useful when you are debugging
                   8285:     a package in order to create new patches for it. Similarly,
                   8286:     <code class="literal">post-build</code> is preferred over
                   8287:     <code class="literal">pre-install</code>, because the install phase should
                   8288:     generally be kept as simple as possible. When you use
                   8289:     <code class="literal">post-build</code>, you have the same files in the
                   8290:     working directory that will be installed later, so you can check
                   8291:     if the substitution has succeeded.</p>
                   8292: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
                   8293:     that is printed just before the substitution is done.</p>
                   8294: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
                   8295:     globbing patterns that specifies the files in which the
                   8296:     substitution will take place. The patterns are interpreted
                   8297:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
                   8298: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.10      hubertf  8299:     <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.1       dsieger  8300:     command should be prefixed with <code class="literal">-e</code>, so that
                   8301:     all SUBST blocks look uniform.</p>
                   8302: <p>There are some more variables, but they are so seldomly
                   8303:     used that they are only documented in the
                   8304:     <code class="filename">mk/subst.mk</code> file.</p>
                   8305: </div>
                   8306: </div>
                   8307: <div class="sect1" lang="en">
                   8308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8309: <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  8310: <div class="sect2" lang="en">
                   8311: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8312: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1       dsieger  8313: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  8314:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  8315:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8316:     with the name of each file to download as an argument, expecting
                   8317:     it to output the URL of the directory from which to download
                   8318:     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
                   8319:     example of this usage.</p>
                   8320: <p>If the download can't be automated, because the user must
                   8321:     submit personal information to apply for a password, or must pay
                   8322:     for the source, or whatever, you can set
                   8323:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8324:     displayed to the user before aborting the build. Example:</p>
                   8325: <pre class="programlisting">
                   8326: FETCH_MESSAGE=  "Please download the files"
                   8327: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8328: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
                   8329:     </pre>
                   8330: </div>
                   8331: <div class="sect2" lang="en">
                   8332: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8333: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1       dsieger  8334: <p>Sometimes authors of a software package make some
                   8335:     modifications after the software was released, and they put up a
                   8336:     new distfile without changing the package's version number. If a
                   8337:     package is already in pkgsrc at that time, the checksum will
                   8338:     no longer match. The contents of the new distfile should be
                   8339:     compared against the old one before changing anything, to make
                   8340:     sure the distfile was really updated on purpose, and that
                   8341:     no trojan horse or so crept in.
                   8342:     Please mention that the distfiles were compared and what was found
                   8343:     in your commit message.
                   8344:     Then, the correct way to work around this is to
                   8345:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8346:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8347:     <code class="varname">DISTFILES</code> and
                   8348:     <code class="varname">PATCHFILES</code> for this package will be put in that
                   8349:     subdirectory of the local distfiles directory.
1.10      hubertf  8350:     (See <a class="xref" href="#bumping-pkgrevision" title="19.1.11. How to handle incrementing versions when fixing an existing package">Section 19.1.11, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
1.1       dsieger  8351:     In case this
                   8352:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8353:     including the <code class="filename">nbX</code> suffix) or a date stamp
                   8354:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
                   8355:     Do not forget regenerating the <code class="filename">distinfo</code> file
                   8356:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8357:     path in the filenames.
                   8358:     Also increase the PKGREVISION if the installed package is different.
                   8359:     Furthermore, a mail to the package's authors seems appropriate
                   8360:     telling them that changing distfiles after releases without
                   8361:     changing the file names is not good practice.</p>
                   8362: </div>
                   8363: </div>
                   8364: <div class="sect1" lang="en">
                   8365: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8366: <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  8367: <div class="sect2" lang="en">
                   8368: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8369: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  8370: <p>pkgsrc supports many different machines, with different
                   8371:     object formats like a.out and ELF, and varying abilities to do
                   8372:     shared library and dynamic loading at all. To accompany this,
                   8373:     varying commands and options have to be passed to the
                   8374:     compiler, linker, etc. to get the Right Thing, which can be
                   8375:     pretty annoying especially if you don't have all the machines
                   8376:     at your hand to test things.  The
                   8377:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
                   8378:     can help here, as it just &#8220;<span class="quote">knows</span>&#8221; how to build
                   8379:     both static and dynamic libraries from a set of source files,
                   8380:     thus being platform-independent.</p>
                   8381: <p>Here's how to use libtool in a package in seven simple
                   8382:     steps:</p>
                   8383: <div class="orderedlist"><ol type="1">
                   8384: <li><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
                   8385:        Makefile.</p></li>
                   8386: <li><p>For library objects, use &#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8387:        ${CC}</span>&#8221; in place of &#8220;<span class="quote">${CC}</span>&#8221;. You could even
                   8388:        add it to the definition of <code class="varname">CC</code>, if only
                   8389:        libraries are being built in a given Makefile. This one command
                   8390:        will build both PIC and non-PIC library objects, so you need not
                   8391:        have separate shared and non-shared library rules.</p></li>
                   8392: <li>
                   8393: <p>For the linking of the library, remove any
                   8394:        &#8220;<span class="quote">ar</span>&#8221;, &#8220;<span class="quote">ranlib</span>&#8221;, and &#8220;<span class="quote">ld
                   8395:        -Bshareable</span>&#8221; commands, and instead use:</p>
                   8396: <pre class="programlisting">
                   8397: ${LIBTOOL} --mode=link \
                   8398:     ${CC} -o ${.TARGET:.a=.la} \
                   8399:         ${OBJS:.o=.lo} \
                   8400:         -rpath ${PREFIX}/lib \
                   8401:         -version-info major:minor
                   8402:        </pre>
                   8403: <p>Note that the library is changed to have a
                   8404:        <code class="filename">.la</code> extension, and the objects are
                   8405:        changed to have a <code class="filename">.lo</code>
                   8406:        extension. Change <code class="varname">OBJS</code> as
                   8407:        necessary. This automatically creates all of the
                   8408:        <code class="filename">.a</code>,
                   8409:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8410:        necessary) in the build directory. Be sure to include
                   8411:        &#8220;<span class="quote">-version-info</span>&#8221;, especially when major and
                   8412:        minor are zero, as libtool will otherwise strip off the
                   8413:        shared library version.</p>
                   8414: <p>From the libtool manual:</p>
                   8415: <pre class="programlisting">
                   8416: So, libtool library versions are described by three integers:
                   8417: 
                   8418: CURRENT
                   8419: The most recent interface number that this library implements.
                   8420: 
                   8421: REVISION
                   8422: The implementation number of the CURRENT interface.
                   8423: 
                   8424: AGE
                   8425: The difference between the newest and oldest interfaces that
                   8426: this library implements.  In other words, the library implements
                   8427: all the interface numbers in the range from number `CURRENT -
                   8428: AGE' to `CURRENT'.
                   8429: 
                   8430: If two libraries have identical CURRENT and AGE numbers, then the
                   8431: dynamic linker chooses the library with the greater REVISION number.
                   8432:        </pre>
                   8433: <p>The &#8220;<span class="quote">-release</span>&#8221; option will produce
                   8434:        different results for a.out and ELF (excluding symlinks)
                   8435:        in only one case. An ELF library of the form
                   8436:        &#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8437:        will have a symlink of
                   8438:        &#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;
                   8439:        on an a.out platform. This is handled
                   8440:        automatically.</p>
                   8441: <p>The &#8220;<span class="quote">-rpath argument</span>&#8221; is the install
                   8442:        directory of the library being built.</p>
                   8443: <p>In the <code class="filename">PLIST</code>, include only the
                   8444:        <code class="filename">.la</code> file, the other files will be
                   8445:        added automatically.</p>
                   8446: </li>
                   8447: <li>
                   8448: <p>When linking shared object (<code class="filename">.so</code>)
1.10      hubertf  8449:        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.1       dsieger  8450:        shared libraries, use &#8220;<span class="quote">-module
                   8451:        -avoid-version</span>&#8221; to prevent them getting version
                   8452:        tacked on.</p>
                   8453: <p>The <code class="filename">PLIST</code> file gets the
                   8454:        <code class="filename">foo.so</code> entry.</p>
                   8455: </li>
                   8456: <li>
                   8457: <p>When linking programs that depend on these libraries
                   8458:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.10      hubertf  8459:        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.1       dsieger  8460:        --mode=link</span>&#8221;, and it will find the correct
                   8461:        libraries (static or shared), but please be aware that
                   8462:        libtool will not allow you to specify a relative path in
                   8463:        -L (such as &#8220;<span class="quote">-L../somelib</span>&#8221;), because it
                   8464:        expects you to change that argument to be the
                   8465:        <code class="filename">.la</code> file. e.g.</p>
                   8466: <pre class="programlisting">
                   8467: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
                   8468:        </pre>
                   8469: <p>should be changed to:</p>
                   8470: <pre class="programlisting">
                   8471: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
                   8472:        </pre>
                   8473: <p>and it will do the right thing with the libraries.</p>
                   8474: </li>
                   8475: <li>
1.10      hubertf  8476: <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>
                   8477:        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.1       dsieger  8478:        --mode=install</span>&#8221;, and change the library name to
                   8479:        <code class="filename">.la</code>. e.g.</p>
                   8480: <pre class="programlisting">
                   8481: ${LIBTOOL} --mode=install ${BSD_INSTALL_DATA} ${SOMELIB:.a=.la} ${PREFIX}/lib
                   8482:        </pre>
                   8483: <p>This will install the static <code class="filename">.a</code>,
                   8484:        shared library, any needed symlinks, and run
1.10      hubertf  8485:        <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.1       dsieger  8486: </li>
                   8487: <li><p>In your <code class="filename">PLIST</code>, include only
                   8488:        the <code class="filename">.la</code>
                   8489:        file (this is a change from previous behaviour).</p></li>
                   8490: </ol></div>
                   8491: </div>
                   8492: <div class="sect2" lang="en">
                   8493: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8494: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  8495: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   8496:     package Makefile. This will override the package's own libtool
                   8497:     in most cases.  For older libtool using packages,  libtool is
                   8498:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  8499:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  8500:     configure; find work*/ -name libtool</strong></span>.</p>
                   8501: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   8502:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
                   8503:     default, it is set to &#8220;<span class="quote">libtool */libtool
                   8504:     */*/libtool</span>&#8221;.  If this does not match the location of the
                   8505:     package's libtool script(s), set it as appropriate.</p>
                   8506: <p>If you do not need <code class="filename">*.a</code> static
                   8507:     libraries built and installed, then use
                   8508:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   8509: <p>If your package makes use of the platform-independent library
                   8510:     for loading dynamic shared objects, that comes with libtool
                   8511:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8512: <p>Some packages use libtool incorrectly so that the package
                   8513:     may not work or build in some circumstances. Some of the more
                   8514:     common errors are:</p>
                   8515: <div class="itemizedlist"><ul type="disc">
                   8516: <li>
                   8517: <p>The inclusion of a shared object (-module) as a dependent library in an
                   8518:        executable or library. This in itself isn't a problem if one of two things
                   8519:        has been done:</p>
                   8520: <div class="orderedlist"><ol type="1">
                   8521: <li><p>The shared object is named correctly, i.e.
                   8522:            <code class="filename">libfoo.la</code>, not
                   8523:            <code class="filename">foo.la</code></p></li>
                   8524: <li><p>The -dlopen option is used when linking an executable.</p></li>
                   8525: </ol></div>
                   8526: </li>
                   8527: <li><p>The use of libltdl without the correct calls to initialisation routines.
                   8528:        The function lt_dlinit() should be called and the macro
                   8529:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8530:        executables.</p></li>
                   8531: </ul></div>
                   8532: </div>
                   8533: <div class="sect2" lang="en">
                   8534: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8535: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  8536: <p>If a package needs GNU autoconf or automake to be executed
                   8537:     to regenerate the configure script and Makefile.in makefile
                   8538:     templates, then they should be executed in a pre-configure
                   8539:     target.</p>
                   8540: <p>For packages that need only autoconf:</p>
                   8541: <pre class="programlisting">
                   8542: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8543: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8544: ...
                   8545: 
                   8546: pre-configure:
                   8547:         cd ${WRKSRC} &amp;&amp; autoconf
                   8548: 
                   8549: ...
                   8550:     </pre>
                   8551: <p>and for packages that need automake and autoconf:</p>
                   8552: <pre class="programlisting">
                   8553: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8554: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8555: ...
                   8556: 
                   8557: pre-configure:
                   8558:         set -e; cd ${WRKSRC}; \
                   8559:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   8560: 
                   8561: ...
                   8562:     </pre>
                   8563: <p>Packages which use GNU Automake will almost certainly
                   8564:     require GNU Make.</p>
                   8565: <p>There are times when the configure process makes
                   8566:     additional changes to the generated files, which then causes
                   8567:     the build process to try to re-execute the automake sequence.
                   8568:     This is prevented by touching various files in the configure
                   8569:     stage. If this causes problems with your package you can set
                   8570:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8571:     Makefile.</p>
                   8572: </div>
                   8573: </div>
                   8574: <div class="sect1" lang="en">
                   8575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8576: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.1       dsieger  8577: <div class="sect2" lang="en">
                   8578: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8579: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  8580: <p>Compilers for the C, C++, and Fortran languages comes with
                   8581:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8582:     is written in C and will hide all other compilers (via the wrapper
1.10      hubertf  8583:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  8584: <p>To declare which language's compiler a package needs, set
                   8585:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
                   8586:     currently are &#8220;<span class="quote">c</span>&#8221;, &#8220;<span class="quote">c++</span>&#8221;, and
                   8587:     &#8220;<span class="quote">fortran</span>&#8221; (and any combination).  The default is
                   8588:     &#8220;<span class="quote">c</span>&#8221;.  Packages using GNU configure scripts, even if
                   8589:     written in C++, usually need a C compiler for the configure
                   8590:     phase.</p>
                   8591: </div>
                   8592: <div class="sect2" lang="en">
                   8593: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8594: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1       dsieger  8595: <p>If a program is written in Java, use the Java framework in
                   8596:     pkgsrc.  The package must include
                   8597:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8598:     provides the following variables:</p>
                   8599: <div class="itemizedlist"><ul type="disc">
                   8600: <li><p><code class="varname">USE_JAVA</code> defines if a build
                   8601:       dependency on the JDK is added.  If
                   8602:       <code class="varname">USE_JAVA</code> is set to &#8220;<span class="quote">run</span>&#8221;, then
                   8603:       there is only a runtime dependency on the JDK.  The default is
                   8604:       &#8220;<span class="quote">yes</span>&#8221;, which also adds a build dependency on the
                   8605:       JDK.</p></li>
                   8606: <li><p>Set <code class="varname">USE_JAVA2</code> to declare that
                   8607:       a package needs a Java2 implementation.  The supported values
                   8608:       are &#8220;<span class="quote">yes</span>&#8221;, &#8220;<span class="quote">1.4</span>&#8221;, and
                   8609:       &#8220;<span class="quote">1.5</span>&#8221;.  &#8220;<span class="quote">yes</span>&#8221; accepts any Java2
                   8610:       implementation, &#8220;<span class="quote">1.4</span>&#8221; insists on versions 1.4 or
                   8611:       above, and &#8220;<span class="quote">1.5</span>&#8221; only accepts versions 1.5 or
                   8612:       above. This variable is not set by default.</p></li>
                   8613: </ul></div>
                   8614: </div>
                   8615: <div class="sect2" lang="en">
                   8616: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8617: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1       dsieger  8618: <p>If your package contains interpreted perl scripts, add
                   8619:     &#8220;<span class="quote">perl</span>&#8221; to the <code class="varname">USE_TOOLS</code> variable
                   8620:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8621:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8622:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
                   8623:     that you want adjusted.  Every occurrence of
                   8624:     <code class="filename">*/bin/perl</code> will be replaced with the full
                   8625:     path to the perl executable.</p>
                   8626: <p>If a particular version of perl is needed, set the
                   8627:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
                   8628:     default is &#8220;<span class="quote">5.0</span>&#8221;.</p>
1.10      hubertf  8629: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.1       dsieger  8630:     about handling perl modules.</p>
                   8631: </div>
                   8632: <div class="sect2" lang="en">
                   8633: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8634: <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
1.1       dsieger  8635: <p>Currently, there is no special handling for other languages
                   8636:     in pkgsrc.  If a compiler package provides a
                   8637:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8638:     just add a (build) dependency on the appropriate compiler
                   8639:     package.</p>
                   8640: </div>
                   8641: </div>
                   8642: <div class="sect1" lang="en">
                   8643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8644: <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  8645: <p>The most common failures when building a package are that
                   8646:        some platforms do not provide certain header files, functions or
                   8647:        libraries, or they provide the functions in a library that the
                   8648:        original package author didn't know. To work around this, you
                   8649:        can rewrite the source code in most cases so that it does not
                   8650:        use the missing functions or provides a replacement function.</p>
                   8651: <div class="sect2" lang="en">
                   8652: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8653: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  8654: <p>If a package already comes with a GNU configure script, the
                   8655:        preferred way to fix the build failure is to change the
                   8656:        configure script, not the code. In the other cases, you can
                   8657:        utilize the C preprocessor, which defines certain macros
                   8658:        depending on the operating system and hardware architecture it
                   8659:        compiles for. These macros can be queried using for example
                   8660:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8661:        system, hardware architecture and compiler has its own macro.
                   8662:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8663:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8664:        are all defined, you know that you are using NetBSD on an i386
                   8665:        compatible CPU, and your compiler is GCC.</p>
                   8666: <p>The list of the following macros for hardware and
                   8667:        operating system depends on the compiler that is used. For
                   8668:        example, if you want to conditionally compile code on Solaris,
                   8669:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8670:        does not define it. Use <code class="varname">__sun</code> instead.</p>
                   8671: <div class="sect3" lang="en">
                   8672: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8673: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1       dsieger  8674: <p>To distinguish between 4.4 BSD-derived systems and the
                   8675:         rest of the world, you should use the following code.</p>
                   8676: <pre class="programlisting">
                   8677: #include &lt;sys/param.h&gt;
                   8678: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8679: /* BSD-specific code goes here */
                   8680: #else
                   8681: /* non-BSD-specific code goes here */
                   8682: #endif
                   8683: </pre>
                   8684: <p>If this distinction is not fine enough, you can also test
                   8685:        for the following macros.</p>
                   8686: <pre class="programlisting">
                   8687: FreeBSD     __FreeBSD__
                   8688: DragonFly   __DragonFly__
                   8689: Interix     __INTERIX
                   8690: IRIX        __sgi (TODO: get a definite source for this)
                   8691: Linux       linux, __linux, __linux__
                   8692: NetBSD      __NetBSD__
                   8693: OpenBSD     __OpenBSD__
                   8694: Solaris     sun, __sun
                   8695: </pre>
                   8696: </div>
                   8697: <div class="sect3" lang="en">
                   8698: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8699: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1       dsieger  8700: <pre class="programlisting">
                   8701: i386        i386, __i386, __i386__
                   8702: MIPS        __mips
                   8703: SPARC       sparc, __sparc
                   8704: </pre>
                   8705: </div>
                   8706: <div class="sect3" lang="en">
                   8707: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8708: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1       dsieger  8709: <pre class="programlisting">
                   8710: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8711: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8712: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8713: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   8714: </pre>
                   8715: </div>
                   8716: </div>
                   8717: <div class="sect2" lang="en">
                   8718: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8719: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  8720: <p>Some source files trigger bugs in the compiler, based on
                   8721:         combinations of compiler version and architecture and almost
                   8722:         always relation to optimisation being enabled.  Common symptoms
                   8723:         are gcc internal errors or never finishing compiling a
                   8724:        file.</p>
                   8725: <p>Typically, a workaround involves testing the
                   8726:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8727:         optimisation for that combination of file,
                   8728:        <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
                   8729:        in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
                   8730:        number of examples.</p>
                   8731: </div>
                   8732: <div class="sect2" lang="en">
                   8733: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8734: <a name="undefined-reference"></a>19.5.3. Undefined reference to &#8220;<span class="quote">...</span>&#8221;</h3></div></div></div>
1.1       dsieger  8735: <p>This error message often means that a package did not
                   8736:        link to a shared library it needs. The following functions are
                   8737:        known to cause this error message over and over.</p>
                   8738: <div class="informaltable">
                   8739: <a name="undefined-reference-functions"></a><table border="1">
                   8740: <colgroup>
                   8741: <col>
                   8742: <col>
                   8743: <col>
                   8744: </colgroup>
                   8745: <thead><tr>
                   8746: <th>Function</th>
                   8747: <th>Library</th>
                   8748: <th>Affected platforms</th>
                   8749: </tr></thead>
                   8750: <tbody>
                   8751: <tr>
                   8752: <td>accept, bind, connect</td>
                   8753: <td>-lsocket</td>
                   8754: <td>Solaris</td>
                   8755: </tr>
                   8756: <tr>
                   8757: <td>crypt</td>
                   8758: <td>-lcrypt</td>
                   8759: <td>DragonFly, NetBSD</td>
                   8760: </tr>
                   8761: <tr>
                   8762: <td>dlopen, dlsym</td>
                   8763: <td>-ldl</td>
                   8764: <td>Linux</td>
                   8765: </tr>
                   8766: <tr>
                   8767: <td>gethost*</td>
                   8768: <td>-lnsl</td>
                   8769: <td>Solaris</td>
                   8770: </tr>
                   8771: <tr>
                   8772: <td>inet_aton</td>
                   8773: <td>-lresolv</td>
                   8774: <td>Solaris</td>
                   8775: </tr>
                   8776: <tr>
                   8777: <td>nanosleep, sem_*, timer_*</td>
                   8778: <td>-lrt</td>
                   8779: <td>Solaris</td>
                   8780: </tr>
                   8781: <tr>
                   8782: <td>openpty</td>
                   8783: <td>-lutil</td>
                   8784: <td>Linux</td>
                   8785: </tr>
                   8786: </tbody>
                   8787: </table>
                   8788: </div>
                   8789: <p>To fix these linker errors, it is often sufficient to say
                   8790:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8791:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10      hubertf  8792:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1       dsieger  8793:     bmake</strong></span>.</p>
                   8794: <div class="sect3" lang="en">
                   8795: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   8796: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  8797: <p>When you are using the SunPro compiler, there is another
                   8798: possibility. That compiler cannot handle the following code:</p>
                   8799: <pre class="programlisting">
                   8800: extern int extern_func(int);
                   8801: 
                   8802: static inline int
                   8803: inline_func(int x)
                   8804: {
                   8805:         return extern_func(x);
                   8806: }
                   8807: 
                   8808: int main(void)
                   8809: {
                   8810:         return 0;
                   8811: }
                   8812: </pre>
                   8813: <p>It generates the code for <code class="function">inline_func</code> even if
                   8814: that function is never used. This code then refers to
                   8815: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8816: solve this problem you can try to tell the package to disable inlining
                   8817: of functions.</p>
                   8818: </div>
                   8819: </div>
                   8820: <div class="sect2" lang="en">
                   8821: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8822: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1       dsieger  8823: <p>Sometimes packages fail to build because the compiler runs
                   8824:     into an operating system specific soft limit.  With the
                   8825:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
                   8826:     to unlimit the resources.  Currently, the allowed values are
                   8827:     &#8220;<span class="quote">datasize</span>&#8221; and &#8220;<span class="quote">stacksize</span>&#8221; (or both).
                   8828:     Setting this variable is similar to running the shell builtin
1.10      hubertf  8829:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  8830:     segment size or maximum stack size of a process, respectively, to
                   8831:     their hard limits.</p>
                   8832: </div>
                   8833: </div>
                   8834: <div class="sect1" lang="en">
                   8835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8836: <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  8837: <div class="sect2" lang="en">
                   8838: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8839: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  8840: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  8841:     with some operating systems cannot create more than one
                   8842:     directory at a time. As such, you should call
                   8843:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8844: <pre class="programlisting">
                   8845: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8846: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
                   8847:     </pre>
                   8848: <p>You can also just append &#8220;<span class="quote"><code class="literal">dir1
                   8849:     dir2</code></span>&#8221; to the
                   8850:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8851:     automatically do the right thing.</p>
                   8852: </div>
                   8853: <div class="sect2" lang="en">
                   8854: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8855: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  8856: <p>In general, documentation should be installed into
                   8857:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8858:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8859:     includes the version number of the package).</p>
                   8860: <p>Many modern packages using GNU autoconf allow to set the
                   8861:     directory where HTML documentation is installed with the
                   8862:     &#8220;<span class="quote">--with-html-dir</span>&#8221; option. Sometimes using this flag
                   8863:     is needed because otherwise the documentation ends up in
                   8864:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8865:     places.</p>
                   8866: <p>An exception to the above is that library API documentation
                   8867:     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
                   8868:     browsers (devhelp) should be left at their default location, which
                   8869:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8870:     documentation can be recognized from files ending in
                   8871:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8872:     (It is also acceptable to install such files in
                   8873:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8874:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8875:     <code class="filename">.devhelp*</code> file must be directly in that
                   8876:     directory then, no additional subdirectory level is allowed in
                   8877:     this case. This is usually achieved by using
                   8878:     &#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;.
                   8879:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8880:     though.)</p>
                   8881: </div>
                   8882: <div class="sect2" lang="en">
                   8883: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8884: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  8885: <p>Certain packages, most of them in the games category, install
                   8886:     a score file that allows all users on the system to record their
                   8887:     highscores.  In order for this to work, the binaries need to be
                   8888:     installed setgid and the score files owned by the appropriate
                   8889:     group and/or owner (traditionally the "games" user/group).  The
                   8890:     following variables, documented in more detail in
                   8891:     <code class="filename">mk/defaults/mk.conf</code>, control this
                   8892:     behaviour: <code class="varname">SETGIDGAME</code>,
                   8893:     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
                   8894:     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
                   8895: <p>Note that per default, setgid installation of games is
                   8896:     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
                   8897:     the other variables accordingly.</p>
1.14      jmcneill 8898: <p>A package should therefore never hard code file ownership or
1.1       dsieger  8899:     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
                   8900:     <code class="varname">INSTALL_GAME_DATA</code> to set these
                   8901:     correctly.</p>
                   8902: </div>
                   8903: <div class="sect2" lang="en">
                   8904: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8905: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 8906: <p><code class="varname">DESTDIR</code> support means that a package
                   8907:     installs into a staging directory, not the final location of the
                   8908:     files. Then a binary package is created which can be used for
                   8909:     installation as usual. There are two ways: Either the package must
                   8910:     install as root (&#8220;<span class="quote">destdir</span>&#8221;) or the package can
                   8911:     install as non-root user (&#8220;<span class="quote">user-destdir</span>&#8221;).</p>
                   8912: <div class="itemizedlist"><ul type="disc">
                   8913: <li><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
                   8914:       set to &#8220;<span class="quote">destdir</span>&#8221; or &#8220;<span class="quote">user-destdir</span>&#8221;. If
                   8915:       bsd.prefs.mk is included in the Makefile,
                   8916:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8917:       the inclusion.</p></li>
1.4       rillig   8918: <li><p>All installation operations have to be prefixed with
                   8919:       <code class="filename">${DESTDIR}</code>.</p></li>
                   8920: <li><p>automake gets this DESTDIR mostly right
                   8921:       automatically. Many manual rules and pre/post-install often are
                   8922:       incorrect; fix them.</p></li>
                   8923: <li><p>If files are installed with special owner/group
1.17    ! imil     8924:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.4       rillig   8925: <li><p>In general, packages should support
                   8926:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8927:       DESTDIR.</p></li>
                   8928: </ul></div>
                   8929: </div>
                   8930: <div class="sect2" lang="en">
                   8931: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8932: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8933: <p>Your package may also contain scripts with hardcoded paths to
                   8934:       other interpreters besides (or as well as) perl.  To correct the
                   8935:       full pathname to the script interpreter, you need to set the
                   8936:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  8937:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  8938: <pre class="programlisting">
                   8939: REPLACE_INTERPRETER+=   tcl
                   8940: REPLACE.tcl.old=        .*/bin/tclsh
                   8941: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8942: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8943: # relative to ${WRKSRC}, just as in REPLACE_PERL
                   8944:     </pre>
                   8945: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   8946: <h3 class="title">Note</h3>
                   8947: <p>Before March 2006, these variables were called
                   8948:     <code class="varname">_REPLACE.*</code> and
                   8949:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8950: </div>
                   8951: </div>
                   8952: <div class="sect2" lang="en">
                   8953: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8954: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1       dsieger  8955: <p>Makefiles of packages providing perl5 modules should include
                   8956:     the Makefile fragment
                   8957:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  8958:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  8959:     configuration for such modules as well as various hooks to tune
                   8960:     this configuration.  See comments in this file for
                   8961:     details.</p>
                   8962: <p>Perl5 modules will install into different places depending
                   8963:     on the version of perl used during the build process.  To
                   8964:     address this, pkgsrc will append lines to the
                   8965:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8966:     the installed <code class="filename">.packlist</code> file generated by
                   8967:     most perl5 modules.  This is invoked by defining
                   8968:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
                   8969:     paths to packlist files, e.g.:</p>
                   8970: <pre class="programlisting">
                   8971: PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
                   8972:     </pre>
                   8973: <p>The variables <code class="varname">PERL5_SITELIB</code>,
                   8974:     <code class="varname">PERL5_SITEARCH</code>, and
                   8975:     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
                   8976:     in which perl5 modules may be installed, and may be used by
                   8977:     perl5 packages that don't have a packlist.  These three
                   8978:     variables are also substituted for in the
                   8979:     <code class="filename">PLIST</code>.</p>
                   8980: </div>
                   8981: <div class="sect2" lang="en">
                   8982: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8983: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  8984: <p>Some packages install info files or use the
                   8985:     &#8220;<span class="quote">makeinfo</span>&#8221;  or &#8220;<span class="quote">install-info</span>&#8221;
                   8986:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8987:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8988:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8989:     handle registration of the info files in the Info directory
                   8990:     file. The &#8220;<span class="quote">install-info</span>&#8221; command used for the info
                   8991:     files registration is either provided by the system, or by a
                   8992:     special purpose package automatically added as dependency if
                   8993:     needed.</p>
                   8994: <p><code class="varname">PKGINFODIR</code> is the directory under
                   8995:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8996:     located. <code class="varname">PKGINFODIR</code> defaults to
                   8997:     &#8220;<span class="quote">info</span>&#8221; and can be overridden by the user.</p>
                   8998: <p>The info files for the package should be listed in the
                   8999:     package <code class="filename">PLIST</code>; however any split info files
                   9000:     need not be listed.</p>
                   9001: <p>A package which needs the &#8220;<span class="quote">makeinfo</span>&#8221; command
                   9002:     at build time must add &#8220;<span class="quote">makeinfo</span>&#8221; to
                   9003:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
                   9004:     version of the &#8220;<span class="quote">makeinfo</span>&#8221; command is needed it
                   9005:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9006:     variable in the package <code class="filename">Makefile</code>. By
                   9007:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  9008:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  9009:     does not match the required minimum, a build dependency on the
                   9010:     <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
                   9011:     be added automatically.</p>
                   9012: <p>The build and installation process of the software provided
                   9013:     by the package should not use the
1.10      hubertf  9014:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  9015:     info files is the task of the package
                   9016:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  9017:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  9018: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  9019:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9020:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  9021:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  9022: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  9023:     no effect except the logging of a message. The script overriding
1.10      hubertf  9024:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  9025:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  9026:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  9027: </div>
                   9028: <div class="sect2" lang="en">
                   9029: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9030: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  9031: <p>All packages that install manual pages should install them
                   9032:     into the same directory, so that there is one common place to look
                   9033:     for them. In pkgsrc, this place is
                   9034:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9035:     should be used in packages. The default for
                   9036:     <code class="varname">PKGMANDIR</code> is
                   9037:     &#8220;<span class="quote"><code class="filename">man</code></span>&#8221;. Another often-used value
                   9038:     is &#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;.</p>
                   9039: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9040: <h3 class="title">Note</h3>
                   9041: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9042:     is far from complete.</p>
                   9043: </div>
                   9044: <p>The <code class="filename">PLIST</code> files can just use
                   9045:     <code class="filename">man/</code> as the top level directory for the man
                   9046:     page file entries, and the pkgsrc framework will convert as
                   9047:     needed. In all other places, the correct
                   9048:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9049: <p>Packages that are
                   9050:     configured with <code class="varname">GNU_CONFIGURE</code> set as
                   9051:     &#8220;<span class="quote">yes</span>&#8221;, by default will use the
                   9052:     <code class="filename">./configure</code>
                   9053:     --mandir switch to set where the man pages should be installed.
                   9054:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9055:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9056: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9057:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
                   9058:     to &#8220;<span class="quote">no</span>&#8221;.
                   9059:     Or if the <code class="filename">./configure</code> script uses
                   9060:     a non-standard use of --mandir, you can set
                   9061:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10      hubertf  9062: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
1.1       dsieger  9063:     information on installation of compressed manual pages.</p>
                   9064: </div>
                   9065: <div class="sect2" lang="en">
                   9066: <div class="titlepage"><div><div><h3 class="title">
1.7       rillig   9067: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1       dsieger  9068: <p>If a package installs <code class="filename">.schemas</code> or
1.7       rillig   9069:     <code class="filename">.entries</code> files, used by GConf,
1.1       dsieger  9070:     you need to take some extra steps to make sure they get registered
                   9071:     in the database:</p>
                   9072: <div class="orderedlist"><ol type="1">
1.7       rillig   9073: <li><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1       dsieger  9074:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.7       rillig   9075:        takes care of rebuilding the GConf database at installation and
1.1       dsieger  9076:        deinstallation time, and tells the package where to install
1.7       rillig   9077:        GConf data files using some standard configure arguments.  It
1.1       dsieger  9078:        also disallows any access to the database directly from the
                   9079:        package.</p></li>
                   9080: <li><p>Ensure that the package installs its
                   9081:        <code class="filename">.schemas</code> files under
                   9082:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9083:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9084:        need to manually patch the package.</p></li>
                   9085: <li><p>Check the PLIST and remove any entries under the etc/gconf
                   9086:        directory, as they will be handled automatically.  See
1.10      hubertf  9087:        <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.7       rillig   9088: <li><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1       dsieger  9089:        your <code class="filename">Makefile</code> with a list of all
                   9090:        <code class="filename">.schemas</code> files installed by the package, if
                   9091:        any.  Names must not contain any directories in them.</p></li>
1.7       rillig   9092: <li><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1       dsieger  9093:        your <code class="filename">Makefile</code> with a
                   9094:        list of all <code class="filename">.entries</code> files installed by the
                   9095:        package, if any. Names must not contain any directories in
                   9096:        them.</p></li>
                   9097: </ol></div>
                   9098: </div>
                   9099: <div class="sect2" lang="en">
                   9100: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9101: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper data files</h3></div></div></div>
1.1       dsieger  9102: <p>If a package installs <code class="filename">.omf</code> files, used by
                   9103:     scrollkeeper, you need to take some extra steps to make sure they
                   9104:     get registered in the database:</p>
                   9105: <div class="orderedlist"><ol type="1">
                   9106: <li><p>Include
1.15      rillig   9107:        <code class="filename">../../textproc/rarian/omf.mk</code>
1.1       dsieger  9108:        instead of its <code class="filename">buildlink3.mk</code> file.  This
                   9109:        takes care of rebuilding the scrollkeeper database at
                   9110:        installation and deinstallation time, and disallows any access
                   9111:        to it directly from the package.</p></li>
                   9112: <li><p>Check the PLIST and remove any entries under the
                   9113:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9114:        will be handled automatically.</p></li>
                   9115: <li><p>Remove the <code class="filename">share/omf</code> directory from
                   9116:        the PLIST.  It will be handled by scrollkeeper.</p></li>
                   9117: </ol></div>
                   9118: </div>
                   9119: <div class="sect2" lang="en">
                   9120: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9121: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  9122: <p>If a package installs font files, you will need to rebuild
                   9123:     the fonts database in the directory where they get installed at
                   9124:     installation and deinstallation time.  This can be automatically
                   9125:     done by using the pkginstall framework.</p>
                   9126: <p>You can list the directories where fonts are installed in the
                   9127:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9128:     variables, where <em class="replaceable"><code>type</code></em> can be one of
                   9129:     &#8220;<span class="quote">ttf</span>&#8221;, &#8220;<span class="quote">type1</span>&#8221; or &#8220;<span class="quote">x11</span>&#8221;.
                   9130:     Also make sure that the database file
                   9131:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   9132: <p>Note that you should not create new directories for fonts;
                   9133:     instead use the standard ones to avoid that the user needs to
                   9134:     manually configure his X server to find them.</p>
                   9135: </div>
                   9136: <div class="sect2" lang="en">
                   9137: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9138: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1       dsieger  9139: <p>If a package installs GTK2 immodules or loaders, you need to
                   9140:     take some extra steps to get them registered in the GTK2 database
                   9141:     properly:</p>
                   9142: <div class="orderedlist"><ol type="1">
                   9143: <li><p>Include
                   9144:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9145:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9146:       rebuilding the database at installation and deinstallation time.</p></li>
                   9147: <li><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
                   9148:       your package installs GTK2 immodules.</p></li>
                   9149: <li><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
                   9150:       GTK2 loaders.</p></li>
                   9151: <li>
                   9152: <p>Patch the package to not touch any of the GTK2
                   9153:       databases directly.  These are:</p>
                   9154: <div class="itemizedlist"><ul type="disc">
                   9155: <li><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9156: <li><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
                   9157: </ul></div>
                   9158: </li>
                   9159: <li><p>Check the <code class="filename">PLIST</code> and remove
                   9160:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9161:       directory, as they will be handled automatically.</p></li>
                   9162: </ol></div>
                   9163: </div>
                   9164: <div class="sect2" lang="en">
                   9165: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9166: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  9167: <p>If a package installs SGML or XML data files that need to be
                   9168:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9169:     etc.), you need to take some extra steps:</p>
                   9170: <div class="orderedlist"><ol type="1">
                   9171: <li><p>Include
                   9172:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9173:        your <code class="filename">Makefile</code>, which takes care of
                   9174:        registering those files in system-wide catalogs at
                   9175:        installation and deinstallation time.</p></li>
                   9176: <li><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
                   9177:        any SGML catalogs installed by the package.</p></li>
                   9178: <li><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
                   9179:        any XML catalogs installed by the package.</p></li>
                   9180: <li><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
                   9181:        to be added to the SGML catalog.  These come in groups of
                   9182:        three strings; see xmlcatmgr(1) for more information
                   9183:        (specifically, arguments recognized by the 'add' action).
                   9184:        Note that you will normally not use this variable.</p></li>
                   9185: <li><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
                   9186:        to be added to the XML catalog.  These come in groups of three
                   9187:        strings; see xmlcatmgr(1) for more information (specifically,
                   9188:        arguments recognized by the 'add' action).  Note that you will
                   9189:        normally not use this variable.</p></li>
                   9190: </ol></div>
                   9191: </div>
                   9192: <div class="sect2" lang="en">
                   9193: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9194: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  9195: <p>If a package provides extensions to the MIME database by
                   9196:     installing <code class="filename">.xml</code> files inside
                   9197:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9198:     need to take some extra steps to ensure that the database is kept
                   9199:     consistent with respect to these new files:</p>
                   9200: <div class="orderedlist"><ol type="1">
                   9201: <li><p>Include
                   9202:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9203:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9204:        this same directory, which is reserved for inclusion from
                   9205:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9206:        care of rebuilding the MIME database at installation and
                   9207:        deinstallation time, and disallows any access to it directly
                   9208:        from the package.</p></li>
                   9209: <li><p>Check the PLIST and remove any entries under the
                   9210:        <code class="filename">share/mime</code> directory,
                   9211:        <span class="emphasis"><em>except</em></span> for files saved under
                   9212:        <code class="filename">share/mime/packages</code>.  The former are
                   9213:        handled automatically by
                   9214:        the update-mime-database program, but the latter are
                   9215:        package-dependent and must be removed by the package that
                   9216:        installed them in the first place.</p></li>
                   9217: <li><p>Remove any <code class="filename">share/mime/*</code> directories
                   9218:        from the PLIST.  They will be handled by the shared-mime-info
                   9219:        package.</p></li>
                   9220: </ol></div>
                   9221: </div>
                   9222: <div class="sect2" lang="en">
                   9223: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9224: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1       dsieger  9225: <p>If a package uses intltool during its build, add
                   9226:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   9227:     which forces it to use the intltool package provided by pkgsrc,
                   9228:     instead of the one bundled with the distribution file.</p>
                   9229: <p>This tracks intltool's build-time dependencies and uses the
                   9230:     latest available version; this way, the package benefits of any
                   9231:     bug fixes that may have appeared since it was released.</p>
                   9232: </div>
                   9233: <div class="sect2" lang="en">
                   9234: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9235: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  9236: <p>If a package contains a rc.d script, it won't be copied into
                   9237:     the startup directory by default, but you can enable it, by adding
                   9238:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  9239:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  9240:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9241:     it will automatically remove the scripts when the package is
                   9242:     deinstalled.</p>
                   9243: </div>
                   9244: <div class="sect2" lang="en">
                   9245: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9246: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  9247: <p>If a package installs TeX packages into the texmf tree,
                   9248:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9249:     updated.</p>
                   9250: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9251: <h3 class="title">Note</h3>
                   9252: <p>Except the main TeX packages such as teTeX-texmf,
                   9253:     packages should install files
                   9254:     into <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9255:     not <code class="varname">PKG_TEXMFPREFIX</code>.</p>
                   9256: </div>
                   9257: <div class="orderedlist"><ol type="1">
                   9258: <li><p>Include
                   9259:       <code class="filename">../../print/teTeX/module.mk</code> instead
                   9260:       of <code class="filename">../../mk/tex.buildlink3.mk</code>.  This
                   9261:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9262:       database at installation and deinstallation time.</p></li>
                   9263: <li>
                   9264: <p>If your package installs files into a texmf
                   9265:       tree other than the one
                   9266:       at <code class="varname">PKG_LOCALTEXMFPREFIX</code>,
                   9267:       set <code class="varname">TEXMFDIRS</code> to the list of all texmf
                   9268:       trees that need database update.</p>
                   9269: <p>If your package also installs font map files that need
1.10      hubertf  9270:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.1       dsieger  9271:       set <code class="varname">TEX_FONTMAPS</code> to the list of all
1.10      hubertf  9272:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  9273:       be run automatically at installation/deinstallation to
                   9274:       enable/disable font map files for TeX output
                   9275:       drivers.</p>
                   9276: </li>
                   9277: <li><p>Make sure that none of <code class="filename">ls-R</code>
                   9278:       databases are included in <code class="filename">PLIST</code>, as
                   9279:       they will be removed only by the teTeX-bin package.</p></li>
                   9280: </ol></div>
                   9281: </div>
                   9282: <div class="sect2" lang="en">
                   9283: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9284: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1       dsieger  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>
                   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>
                   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.10      hubertf  9293:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  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.6       rillig   9301: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1       dsieger  9302: <p>If a package installs images under the
                   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>
                   9308: <div class="orderedlist"><ol type="1">
                   9309: <li><p>Include
                   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>
                   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.10      hubertf  9319:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1       dsieger  9320: </div>
                   9321: <div class="sect2" lang="en">
                   9322: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9323: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1       dsieger  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.10      hubertf  9336:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.1       dsieger  9337:       print-PLIST</strong></span>.</p>
                   9338: </div>
                   9339: </div>
                   9340: <div class="sect1" lang="en">
                   9341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9342: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1       dsieger  9343: <p>In some cases one does not have the time to solve a problem
                   9344:   immediately.  There are currently two ways to declare that one knows
                   9345:   that a package has problems.</p>
                   9346: <div class="itemizedlist"><ul type="disc">
                   9347: <li><p>The first way is to plainly mark it as broken.  For
                   9348:     this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9349:     reason why the package is broken (similar to the
                   9350:     <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9351:     the package will immediately be shown this message, and the build
                   9352:     will not be even tried.</p></li>
                   9353: <li><p>After each pkgsrc freeze period (a time when the
                   9354:     tree is stabilized and a new pkgsrc branch is cut), the packages
                   9355:     that were not building in the official branch build on the latest
                   9356:     NetBSD release will be marked as broken on that branch.  This is
                   9357:     done by setting the <code class="varname">BROKEN_IN</code> variable to the
                   9358:     branch name (or appending the branch name to it).  If a user tries
                   9359:     to build such a package and the build fails, the user gets a
                   9360:     message that says that the package was broken on the respective
                   9361:     branch(es).</p></li>
                   9362: </ul></div>
                   9363: <p>Both types of packages are removed from pkgsrc in irregular
                   9364:   intervals.</p>
                   9365: </div>
                   9366: </div>
                   9367: <div class="chapter" lang="en">
                   9368: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9369: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1       dsieger  9370: <p>To check out all the gotchas when building a package, here are
                   9371:   the steps that I do in order to get a package working.  Please note
                   9372:   this is basically the same as what was explained in the previous
                   9373:   sections, only with some debugging aids.</p>
                   9374: <div class="itemizedlist"><ul type="disc">
1.10      hubertf  9375: <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.1       dsieger  9376: <li>
                   9377: <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>,
                   9378:       create a directory for a new package, change into it, then run
1.10      hubertf  9379:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.1       dsieger  9380: <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>
                   9381: <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>
                   9382: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9383: </li>
                   9384: <li><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9385: <li><p>Fill in the <code class="filename">DESCR</code> file</p></li>
1.10      hubertf  9386: <li><p>Run <span class="command"><strong>make configure</strong></span></p></li>
1.1       dsieger  9387: <li><p>Add any dependencies glimpsed from documentation and the
                   9388:       configure step to the package's
                   9389:       <code class="filename">Makefile</code>.</p></li>
                   9390: <li>
                   9391: <p>Make the package compile, doing multiple rounds of</p>
                   9392: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9393: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9394: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9395: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9396: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9397: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9398: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   9399: <p>Doing this step as non-root user will ensure that no files
                   9400:       are modified that shouldn't be, especially during the build
1.10      hubertf  9401:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9402:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.1       dsieger  9403:       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>
                   9404:       package.</p>
                   9405: </li>
                   9406: <li><p>Look at the <code class="filename">Makefile</code>, fix if
1.15      rillig   9407:       necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, &#8220;Makefile&#8221;</a>.</p></li>
1.1       dsieger  9408: <li>
                   9409: <p>Generate a <code class="filename">PLIST</code>:</p>
                   9410: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9411: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9412: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9413: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9414: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
                   9415: <p>You usually need to be <code class="username">root</code> to do
                   9416:       this.  Look if there are any files left:</p>
                   9417: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9418: <p>If this reveals any files that are missing in
                   9419:       <code class="filename">PLIST</code>, add them.</p>
                   9420: </li>
                   9421: <li>
                   9422: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9423:       package again and make a binary package:</p>
                   9424: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9425: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9426: </li>
                   9427: <li>
                   9428: <p>Delete the installed package:</p>
                   9429: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
                   9430: </li>
                   9431: <li>
1.10      hubertf  9432: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  9433:       command, which shouldn't find anything now:</p>
                   9434: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9435: </li>
                   9436: <li>
                   9437: <p>Reinstall the binary package:</p>
                   9438: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
                   9439: </li>
                   9440: <li><p>Play with it.  Make sure everything works.</p></li>
                   9441: <li>
1.10      hubertf  9442: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.1       dsieger  9443:       reports:</p>
                   9444: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9445: </li>
1.10      hubertf  9446: <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.1       dsieger  9447: </ul></div>
                   9448: </div>
                   9449: <div class="chapter" lang="en">
                   9450: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9451: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1       dsieger  9452: <div class="toc">
                   9453: <p><b>Table of Contents</b></p>
                   9454: <dl>
1.6       rillig   9455: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9456: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9457: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9458: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
                   9459: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
                   9460: <dt><span class="sect1"><a href="#moving-package">21.6. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  9461: </dl>
                   9462: </div>
                   9463: <div class="sect1" lang="en">
                   9464: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9465: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  9466: <p>Our policy is that we accept binaries only from pkgsrc
                   9467:        developers to guarantee that the packages don't contain any
                   9468:        trojan horses etc. This is not to annoy anyone but rather to
                   9469:        protect our users! You're still free to put up your home-made
                   9470:        binary packages and tell the world where to get them. NetBSD
                   9471:        developers doing bulk builds and wanting to upload them please
1.10      hubertf  9472:        see <a class="xref" href="#bulk-upload" title="7.3.8. Uploading results of a bulk build">Section 7.3.8, &#8220;Uploading results of a bulk build&#8221;</a>.</p>
1.1       dsieger  9473: </div>
                   9474: <div class="sect1" lang="en">
                   9475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9476: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  9477: <p>First, check that your package is complete, compiles and
1.10      hubertf  9478:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
                   9479:        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.1       dsieger  9480:        archive that contains all files that make up the package.
                   9481:        Finally, send this package to the pkgsrc bug tracking system,
1.10      hubertf  9482:        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.1       dsieger  9483:        that, go to the web page
1.10      hubertf  9484:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.1       dsieger  9485:        which contains some instructions and a link to a form, where you
                   9486:        can submit packages.</p>
                   9487: <p>In the form of the problem report, the category should be
                   9488:        &#8220;<span class="quote">pkg</span>&#8221;, the synopsis should include the package name
                   9489:        and version number, and the description field should contain a
                   9490:        short description of your package (contents of the COMMENT
                   9491:        variable or DESCR file are OK). The uuencoded package data should
                   9492:        go into the &#8220;<span class="quote">fix</span>&#8221; field.</p>
                   9493: <p>If you want to submit several packages, please send a
                   9494:        separate PR for each one, it's easier for us to track things
                   9495:        that way.</p>
                   9496: <p>Alternatively, you can also import new packages into
                   9497:        pkgsrc-wip (&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;); see the
1.10      hubertf  9498:        homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
1.1       dsieger  9499:        for details.</p>
                   9500: </div>
                   9501: <div class="sect1" lang="en">
                   9502: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9503: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  9504: <p>Please note all package additions, updates, moves, and
                   9505:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   9506:        important to keep this file up to date and conforming to the
                   9507:        existing format, because it will be used by scripts to
1.10      hubertf  9508:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  9509:        sites. Additionally, check the
                   9510:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   9511:        for the package you updated or removed, in case it was mentioned
                   9512:        there.</p>
                   9513: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9514:        bumped, the change should appear in
                   9515:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   9516:        related or otherwise relevant. Mass bumps that result from a
                   9517:        dependency being updated should not be mentioned. In all other
                   9518:        cases it's the developer's decision.</p>
                   9519: <p>There is a make target that helps in creating proper
1.10      hubertf  9520:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  9521:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9522:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   9523:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   9524:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  9525:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9526:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  9527:   For new packages, or package moves or removals, set the
                   9528:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9529:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  9530:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.1       dsieger  9531:   not the same as your NetBSD login name. Don't forget to commit
                   9532:   the changes to <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>!</p>
                   9533: </div>
                   9534: <div class="sect1" lang="en">
                   9535: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9536: <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
1.1       dsieger  9537: <p>This section is only of interest for pkgsrc developers with write
                   9538:   access to the pkgsrc repository. Please remember that cvs
                   9539:   imports files relative to the current working directory, and that
                   9540:   the pathname that you
1.10      hubertf  9541:   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
1.1       dsieger  9542:   to place the files in the repository.  Newly created packages should be
                   9543:   imported with a vendor tag of &#8220;<span class="quote">TNF</span>&#8221; and a release tag of
                   9544:   &#8220;<span class="quote">pkgsrc-base</span>&#8221;, e.g:</p>
                   9545: <pre class="programlisting">
                   9546: <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
                   9547: <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
                   9548: </pre>
                   9549: <p>Remember to move the directory from which you imported out of
                   9550:   the way, or cvs will complain the next time you &#8220;<span class="quote">cvs
                   9551:   update</span>&#8221; your source tree.  Also don't forget to add the new
                   9552:   package to the category's <code class="filename">Makefile</code>.</p>
                   9553: <p>The commit message of the initial import should include part of the
                   9554:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   9555:   what the package is/does.</p>
                   9556: <p>For new packages, &#8220;<span class="quote">cvs import</span>&#8221; is preferred to &#8220;<span class="quote">cvs
                   9557:   add</span>&#8221; because the former gets everything with a single command,
                   9558:   and provides a consistent tag.</p>
                   9559: </div>
                   9560: <div class="sect1" lang="en">
                   9561: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9562: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  9563: <p>Please always put a concise, appropriate and relevant summary of the
                   9564:   changes between old and new versions into the commit log when updating
                   9565:   a package. There are various reasons for this:</p>
                   9566: <div class="itemizedlist"><ul type="disc">
                   9567: <li><p>A URL is volatile, and can change over time. It may go away completely
                   9568:   or its information may be overwritten by newer information.</p></li>
                   9569: <li><p>Having the change information between old and new versions in our CVS
                   9570:   repository is very useful for people who use either cvs or anoncvs.</p></li>
                   9571: <li><p>Having the change information between old and new versions in our CVS
                   9572:   repository is very useful for people who read the pkgsrc-changes mailing
                   9573:   list, so that they can make tactical decisions about when to upgrade
                   9574:   the package.</p></li>
                   9575: </ul></div>
                   9576: <p>Please also recognize that, just because a new version of a package
                   9577:   has been released, it should not automatically be upgraded in the CVS
                   9578:   repository.  We prefer to be conservative in the packages that are
                   9579:   included in pkgsrc - development or beta packages are not really the
                   9580:   best thing for most places in which pkgsrc is used. Please use your
                   9581:   judgement about what should go into pkgsrc, and bear in mind that
                   9582:   stability is to be preferred above new and possibly untested features.</p>
                   9583: </div>
                   9584: <div class="sect1" lang="en">
                   9585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9586: <a name="moving-package"></a>21.6. Moving a package in pkgsrc</h2></div></div></div>
1.1       dsieger  9587: <div class="orderedlist"><ol type="1">
                   9588: <li><p>Make a copy of the directory somewhere else.</p></li>
                   9589: <li>
                   9590: <p>Remove all CVS dirs.</p>
                   9591: <p>Alternatively to the first two steps you can also do:</p>
                   9592: <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>
                   9593: <p>and use that for further work.</p>
                   9594: </li>
                   9595: <li><p>Fix <code class="varname">CATEGORIES</code> and any
                   9596: <code class="varname">DEPENDS</code> paths that just did &#8220;<span class="quote">../package</span>&#8221;
                   9597: instead of &#8220;<span class="quote">../../category/package</span>&#8221;.</p></li>
1.10      hubertf  9598: <li><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  9599: place.</p></li>
                   9600: <li>
                   9601: <p>Check if any package depends on it:
                   9602: </p>
                   9603: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9604: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9605: </li>
                   9606: <li><p>Fix paths in packages from step 5 to point to new location.</p></li>
1.10      hubertf  9607: <li><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
1.1       dsieger  9608: <li><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9609: <li><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9610: <li>
                   9611: <p>Commit the changed and removed files:</p>
                   9612: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   9613: <p>(and any packages from step 5, of course).</p>
                   9614: </li>
                   9615: </ol></div>
                   9616: </div>
                   9617: </div>
                   9618: <div class="chapter" lang="en">
                   9619: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9620: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  9621: <p>This section contains the answers to questions that may
                   9622:        arise when you are writing a package. If you don't find your
                   9623:        question answered here, first have a look in the other chapters,
                   9624:        and if you still don't have the answer, ask on the
                   9625:        <code class="literal">pkgsrc-users</code> mailing list.</p>
                   9626: <div class="qandaset">
                   9627: <dl>
1.6       rillig   9628: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  9629:        MAKEFLAGS, .MAKEFLAGS and
                   9630:        MAKE_FLAGS?</a>
                   9631: </dt>
1.6       rillig   9632: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  9633:        MAKE, GMAKE and
                   9634:        MAKE_PROGRAM?</a>
                   9635: </dt>
1.6       rillig   9636: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  9637:        CC, PKG_CC and
                   9638:        PKGSRC_COMPILER?</a>
                   9639: </dt>
1.6       rillig   9640: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  9641:        BUILDLINK_LDFLAGS,
                   9642:        BUILDLINK_LDADD and
                   9643:        BUILDLINK_LIBS?</a>
                   9644: </dt>
1.6       rillig   9645: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  9646:        VARNAME=BUILDLINK_PREFIX.foo
                   9647:        say it's empty?</a>
                   9648: </dt>
1.6       rillig   9649: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  9650:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9651:        don't understand the := inside
                   9652:        it.</a>
                   9653: </dt>
1.6       rillig   9654: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  9655:        developers?</a>
                   9656: </dt>
1.6       rillig   9657: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  9658:        documentation?</a>
                   9659: </dt>
1.6       rillig   9660: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.1       dsieger  9661: do?</a>
                   9662: </dt>
                   9663: </dl>
                   9664: <table border="0" summary="Q and A Set">
                   9665: <col align="left" width="1%">
                   9666: <tbody>
                   9667: <tr class="question">
                   9668: <td align="left" valign="top">
1.17    ! imil     9669: <a name="devfaq.makeflags"></a><a name="id52059900"></a><p><b>22.1.</b></p>
1.1       dsieger  9670: </td>
                   9671: <td align="left" valign="top"><p>What is the difference between
                   9672:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9673:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9674: </tr>
                   9675: <tr class="answer">
                   9676: <td align="left" valign="top"></td>
                   9677: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.10      hubertf  9678:        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.1       dsieger  9679:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9680:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9681:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9682: </tr>
                   9683: <tr class="question">
                   9684: <td align="left" valign="top">
1.17    ! imil     9685: <a name="devfaq.make"></a><a name="id52059936"></a><p><b>22.2.</b></p>
1.1       dsieger  9686: </td>
                   9687: <td align="left" valign="top"><p>What is the difference between
                   9688:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9689:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9690: </tr>
                   9691: <tr class="answer">
                   9692: <td align="left" valign="top"></td>
                   9693: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.10      hubertf  9694:        <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.1       dsieger  9695:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9696:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9697:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9698:        Make program that is used for building the
                   9699:        package.</p></td>
                   9700: </tr>
                   9701: <tr class="question">
                   9702: <td align="left" valign="top">
1.17    ! imil     9703: <a name="devfaq.cc"></a><a name="id52059974"></a><p><b>22.3.</b></p>
1.1       dsieger  9704: </td>
                   9705: <td align="left" valign="top"><p>What is the difference between
                   9706:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9707:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9708: </tr>
                   9709: <tr class="answer">
                   9710: <td align="left" valign="top"></td>
                   9711: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9712:        compiler, which can be configured by the pkgsrc user.
                   9713:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9714:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9715:        path to a compiler, but the type of compiler that should be
                   9716:        used. See <code class="filename">mk/compiler.mk</code> for more
                   9717:        information about the latter variable.</p></td>
                   9718: </tr>
                   9719: <tr class="question">
                   9720: <td align="left" valign="top">
1.17    ! imil     9721: <a name="devfaq.bl3flags"></a><a name="id52060009"></a><p><b>22.4.</b></p>
1.1       dsieger  9722: </td>
                   9723: <td align="left" valign="top"><p>What is the difference between
                   9724:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9725:        <code class="varname">BUILDLINK_LDADD</code> and
                   9726:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9727: </tr>
                   9728: <tr class="answer">
                   9729: <td align="left" valign="top"></td>
                   9730: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9731: </tr>
                   9732: <tr class="question">
                   9733: <td align="left" valign="top">
1.17    ! imil     9734: <a name="devfaq.bl3prefix"></a><a name="id52060097"></a><p><b>22.5.</b></p>
1.1       dsieger  9735: </td>
1.10      hubertf  9736: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  9737:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9738:        say it's empty?</p></td>
                   9739: </tr>
                   9740: <tr class="answer">
                   9741: <td align="left" valign="top"></td>
                   9742: <td align="left" valign="top"><p>For optimization reasons, some variables are only
                   9743:        available in the &#8220;<span class="quote">wrapper</span>&#8221; phase and later. To
                   9744:        &#8220;<span class="quote">simulate</span>&#8221; the wrapper phase, append
1.10      hubertf  9745:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  9746:        command.</p></td>
                   9747: </tr>
                   9748: <tr class="question">
                   9749: <td align="left" valign="top">
1.17    ! imil     9750: <a name="devfaq.master_sites"></a><a name="id52060122"></a><p><b>22.6.</b></p>
1.1       dsieger  9751: </td>
                   9752: <td align="left" valign="top"><p>What does
                   9753:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9754:        don't understand the <code class="literal">:=</code> inside
                   9755:        it.</p></td>
                   9756: </tr>
                   9757: <tr class="answer">
                   9758: <td align="left" valign="top"></td>
                   9759: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9760:        assignment operator, like you might expect at first sight.
                   9761:        Instead, it is a degenerate form of
                   9762:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.10      hubertf  9763:        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.1       dsieger  9764:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9765:        case of <code class="varname">MASTER_SITE_*</code>,
                   9766:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9767:        <em class="replaceable"><code>new_string</code></em> is
                   9768:        <code class="literal">package/</code>. That's where the
                   9769:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9770:        together.</p></td>
                   9771: </tr>
                   9772: <tr class="question">
                   9773: <td align="left" valign="top">
1.17    ! imil     9774: <a name="devfaq.mailinglists"></a><a name="id52060325"></a><p><b>22.7.</b></p>
1.1       dsieger  9775: </td>
                   9776: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9777:        developers?</p></td>
                   9778: </tr>
                   9779: <tr class="answer">
                   9780: <td align="left" valign="top"></td>
                   9781: <td align="left" valign="top"><div class="variablelist"><dl>
1.10      hubertf  9782: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1       dsieger  9783: <dd><p>This is a list for technical discussions related
                   9784:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9785:        pkgsrc infrastructure, proposed new features, questions related
                   9786:        to porting pkgsrc to a new platform, advice for maintaining a
                   9787:        package, patches that affect many packages, help requests moved
                   9788:        from pkgsrc-users when an infrastructure bug is found,
                   9789:        etc.</p></dd>
1.10      hubertf  9790: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1       dsieger  9791: <dd><p>All bug reports in category "pkg" sent with
1.10      hubertf  9792:        <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.1       dsieger  9793:        directly; use one of the other mailing
                   9794:        lists.</p></dd>
                   9795: </dl></div></td>
                   9796: </tr>
                   9797: <tr class="question">
                   9798: <td align="left" valign="top">
1.17    ! imil     9799: <a name="devfaq.documentation"></a><a name="id52060359"></a><p><b>22.8.</b></p>
1.1       dsieger  9800: </td>
                   9801: <td align="left" valign="top"><p>Where is the pkgsrc
                   9802:        documentation?</p></td>
                   9803: </tr>
                   9804: <tr class="answer">
                   9805: <td align="left" valign="top"></td>
                   9806: <td align="left" valign="top">
                   9807: <p>There are many places where you can find
                   9808:        documentation about pkgsrc:</p>
                   9809: <div class="itemizedlist"><ul type="disc">
                   9810: <li><p>The pkgsrc guide (this document) is a collection
                   9811:        of chapters that explain large parts of pkgsrc, but some
                   9812:        chapters tend to be outdated. Which ones they are is hard to
                   9813:        say.</p></li>
1.10      hubertf  9814: <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.1       dsieger  9815:        about certain features, announcements of new parts of the pkgsrc
                   9816:        infrastructure and sometimes even announcements that a certain
                   9817:        feature has been marked as obsolete. The benefit here is that
                   9818:        each message has a date appended to it.</p></li>
                   9819: <li><p>Many of the files in the
                   9820:        <code class="filename">mk/</code> directory start with a comment that
                   9821:        describes the purpose of the file and how it can be used by the
                   9822:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  9823:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  9824:        help</strong></span>.</p></li>
                   9825: <li><p>The CVS log messages are a rich source of
                   9826:        information, but they tend to be highly abbreviated, especially
                   9827:        for actions that occur often. Some contain a detailed
                   9828:        description of what has changed, but they are geared towards the
                   9829:        other pkgsrc developers, not towards an average pkgsrc user.
                   9830:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9831:        don't know what has been before, these messages may not be worth
                   9832:        too much to you.</p></li>
                   9833: <li><p>Some parts of pkgsrc are only &#8220;<span class="quote">implicitly
                   9834:        documented</span>&#8221;, that is the documentation exists only in the
                   9835:        mind of the developer who wrote the code. To get this
1.10      hubertf  9836:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  9837:        to see who has written it and ask on the
                   9838:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9839:        find your questions later (see above). To be sure that the
                   9840:        developer in charge reads the mail, you may CC him or
                   9841:        her.</p></li>
                   9842: </ul></div>
                   9843: </td>
                   9844: </tr>
                   9845: <tr class="question">
                   9846: <td align="left" valign="top">
1.17    ! imil     9847: <a name="devfaq.too-much-time"></a><a name="id52060413"></a><p><b>22.9.</b></p>
1.1       dsieger  9848: </td>
                   9849: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9850: do?</p></td>
                   9851: </tr>
                   9852: <tr class="answer">
                   9853: <td align="left" valign="top"></td>
                   9854: <td align="left" valign="top">
                   9855: <p>This is not really an FAQ yet, but here's the answer
                   9856: anyway.</p>
                   9857: <div class="itemizedlist"><ul type="disc">
1.10      hubertf  9858: <li><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.1       dsieger  9859:     <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
                   9860:     will tell you about newer versions of installed packages that are
                   9861:     available, but not yet updated in pkgsrc.</p></li>
                   9862: <li><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14      jmcneill 9863:     &mdash; it contains a list of suggested new packages and a list of
1.1       dsieger  9864:     cleanups and enhancements for pkgsrc that would be nice to
                   9865:     have.</p></li>
                   9866: <li><p>Review packages for which review was requested on
1.10      hubertf  9867:     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
1.1       dsieger  9868:     mailing list.</p></li>
                   9869: </ul></div>
                   9870: </td>
                   9871: </tr>
                   9872: </tbody>
                   9873: </table>
                   9874: </div>
                   9875: </div>
                   9876: <div class="chapter" lang="en">
                   9877: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9878: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1       dsieger  9879: <div class="toc">
                   9880: <p><b>Table of Contents</b></p>
                   9881: <dl>
1.6       rillig   9882: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9883: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9884: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9885: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  9886: </dl>
                   9887: </div>
1.10      hubertf  9888: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1       dsieger  9889: site</a>:</p>
                   9890: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9891:   environment, an intuitive and attractive desktop for users, and the
                   9892:   GNOME development platform, an extensive framework for building
                   9893:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9894: <p>pkgsrc provides a seamless way to automatically build and install
                   9895: a complete GNOME environment <span class="emphasis"><em>under many different
                   9896: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9897: the most advanced build and packaging systems for GNOME due to its
                   9898: included technologies buildlink3, the wrappers and tools framework and
                   9899: automatic configuration file management.  Lots of efforts are put into
                   9900: achieving a completely clean deinstallation of installed software
                   9901: components.</p>
1.10      hubertf  9902: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1       dsieger  9903: the above also means that great efforts are put into making GNOME work
1.10      hubertf  9904: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1       dsieger  9905: pkgsrc as its preferred packaging system, contributing lots of
                   9906: portability fixes to make GNOME build and install under it.</p>
                   9907: <p>This chapter is aimed at pkgsrc developers and other people
                   9908: interested in helping our GNOME porting and packaging efforts.  It
                   9909: provides instructions on how to manage the existing packages and some
                   9910: important information regarding their internals.</p>
                   9911: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9912: <h3 class="title">We need your help!</h3>
                   9913: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9914:   and GNOME and are willing to learn new exciting stuff, please jump
1.10      hubertf  9915:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1       dsieger  9916:   work</a> list!  There is still a long way to go to get a
                   9917:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9918:   achieve it!</p>
                   9919: </div>
                   9920: <div class="sect1" lang="en">
                   9921: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9922: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1       dsieger  9923: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9924: <div class="itemizedlist"><ul type="disc">
                   9925: <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
                   9926:     the core GNOME desktop environment.  It only includes the necessary
                   9927:     bits to get it to boot correctly, although it may lack important
                   9928:     functionality for daily operation.  The idea behind this package is
                   9929:     to let end users build their own configurations on top of this one,
                   9930:     first installing this meta package to achieve a functional setup and
                   9931:     then adding individual applications.</p></li>
                   9932: <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
                   9933:     complete installation of the GNOME platform and desktop as defined
                   9934:     by the GNOME project; this is based on the components distributed in
                   9935:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9936:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9937:     official FTP server.  Developer-only tools found in those
                   9938:     directories are not installed unless required by some other
                   9939:     component to work properly.  Similarly, packages from the bindings
                   9940:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9941:     in unless required as a dependency for an end-user component.  This
                   9942:     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>
                   9943: <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>:
                   9944:     Installs all the tools required to build a GNOME component when
                   9945:     fetched from the CVS repository.  These are required to let the
1.10      hubertf  9946:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1       dsieger  9947: </ul></div>
                   9948: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9949: sorted in a way that eases updates: a package may depend on other
                   9950: packages listed before it but not on any listed after it.  It is very
                   9951: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9952: change it to alphabetical sorting!</em></span></p>
                   9953: </div>
                   9954: <div class="sect1" lang="en">
                   9955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9956: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1       dsieger  9957: <p>Almost all GNOME applications are written in C and use a common
                   9958: set of tools as their build system.  Things get different with the new
                   9959: bindings to other languages (such as Python), but the following will
                   9960: give you a general idea on the minimum required tools:</p>
                   9961: <div class="itemizedlist"><ul type="disc">
                   9962: <li>
                   9963: <p>Almost all GNOME applications use the GNU Autotools as their
                   9964:     build system.  As a general rule you will need to tell this to your
                   9965:     package:</p>
                   9966: <pre class="programlisting">
                   9967: GNU_CONFIGURE=yes
                   9968: USE_LIBTOOL=yes
                   9969: USE_TOOLS+=gmake
                   9970: </pre>
                   9971: </li>
                   9972: <li>
                   9973: <p>If the package uses pkg-config to detect dependencies, add this
                   9974:     tool to the list of required utilities:</p>
                   9975: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
                   9976: <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
                   9977:     the end of the build process to ensure that you did not miss to
                   9978:     specify any dependency in your package and that the version
                   9979:     requirements are all correct.</p>
                   9980: </li>
                   9981: <li><p>If the package uses intltool, be sure to add
                   9982:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9983:     to handle dependencies and to force the package to use the latest
                   9984:     available version.</p></li>
                   9985: <li>
                   9986: <p>If the package uses gtk-doc (a documentation generation
                   9987:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9988:     tool is rather big and the distfile should come with pregenerated
                   9989:     documentation anyway; if it does not, it is a bug that you ought to
                   9990:     report.  For such packages you should disable gtk-doc (unless it is
                   9991:     the default):</p>
                   9992: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9993: <p>The default location of installed HTML files
                   9994:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9995:     and should not be changed unless the package insists on installing
                   9996:     them somewhere else.  Otherwise programs as
1.10      hubertf  9997:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.1       dsieger  9998:     do that with an entry similar to:</p>
                   9999: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
                   10000: </li>
                   10001: </ul></div>
                   10002: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   10003: files under the installation prefix to maintain databases.  In this
                   10004: context, shared means that those exact same directories and files are
                   10005: used among several different packages, leading to conflicts in the
                   10006: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   10007: handle the most common cases, so you have to forget about using
                   10008: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   10009: omitting shared files from them.  If you find yourself doing those,
                   10010: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   10011: <p>The following table lists the common situations that result in
                   10012: using shared directories or files.  For each of them, the appropriate
                   10013: solution is given.  After applying the solution be sure to
                   10014: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10      hubertf  10015: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1       dsieger  10016: <div class="table">
1.6       rillig   10017: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.1       dsieger  10018: <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
                   10019: <colgroup>
                   10020: <col>
                   10021: <col>
                   10022: </colgroup>
                   10023: <thead><tr>
                   10024: <th>If the package...</th>
                   10025: <th>Then...</th>
                   10026: </tr></thead>
                   10027: <tbody>
                   10028: <tr>
                   10029: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.10      hubertf  10030: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper data files">Section 19.6.10, &#8220;Packages installing scrollkeeper data files&#8221;</a>.</td>
1.1       dsieger  10031: </tr>
                   10032: <tr>
                   10033: <td>Installs icons under the
                   10034:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   10035:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10      hubertf  10036: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.1       dsieger  10037: </tr>
                   10038: <tr>
                   10039: <td>Installs files under
                   10040:         <code class="filename">share/mime/packages</code>.</td>
1.10      hubertf  10041: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.1       dsieger  10042: </tr>
                   10043: <tr>
                   10044: <td>Installs <code class="filename">.desktop</code> files under
                   10045:         <code class="filename">share/applications</code> and these include MIME
                   10046:         information.</td>
1.10      hubertf  10047: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.1       dsieger  10048: </tr>
                   10049: </tbody>
                   10050: </table></div>
                   10051: </div>
                   10052: <br class="table-break">
                   10053: </div>
                   10054: <div class="sect1" lang="en">
                   10055: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10056: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1       dsieger  10057: <p>When seeing GNOME as a whole, there are two kinds of
                   10058: updates:</p>
                   10059: <div class="variablelist"><dl>
                   10060: <dt><span class="term">Major update</span></dt>
                   10061: <dd>
                   10062: <p>Given that there is still a very long way for GNOME 3 (if it
                   10063:       ever appears), we consider a major update one that goes from a
                   10064:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   10065:       where <code class="literal">Y</code> is even and greater than
                   10066:       <code class="literal">X</code>.  These are hard to achieve because they
                   10067:       introduce lots of changes in the components' code and almost all
                   10068:       GNOME distfiles are updated to newer versions.  Some of them can
                   10069:       even break API and ABI compatibility with the previous major
                   10070:       version series.  As a result, the update needs to be done all at
                   10071:       once to minimize breakage.</p>
                   10072: <p>A major update typically consists of around 80 package
                   10073:       updates and the addition of some new ones.</p>
                   10074: </dd>
                   10075: <dt><span class="term">Minor update</span></dt>
                   10076: <dd>
                   10077: <p>We consider a minor update one that goes from a
                   10078:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   10079:       one where <code class="literal">Y</code> is greater than
                   10080:       <code class="literal">X</code>.  These are easy to achieve because they do
                   10081:       not update all GNOME components, can be done in an incremental way
                   10082:       and do not break API nor ABI compatibility.</p>
                   10083: <p>A minor update typically consists of around 50 package
                   10084:       updates, although the numbers here may vary a lot.</p>
                   10085: </dd>
                   10086: </dl></div>
                   10087: <p>In order to update the GNOME components in pkgsrc to a new stable
                   10088: release (either major or minor), the following steps should be
                   10089: followed:</p>
                   10090: <div class="orderedlist"><ol type="1">
                   10091: <li>
                   10092: <p>Get a list of all the tarballs that form the new release by
                   10093:     using the following commands.  These will leave the full list of the
                   10094:     components's distfiles into the <code class="filename">list.txt</code>
                   10095:     file:</p>
                   10096: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10097:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   10098:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   10099: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   10100:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   10101:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   10102: </li>
                   10103: <li><p>Open each meta package's <code class="filename">Makefile</code> and
                   10104:     bump their version to the release you are updating them to.  The
                   10105:     three meta packages should be always consistent with versioning.
                   10106:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   10107:     in them.</p></li>
                   10108: <li>
                   10109: <p>For each meta package, update all its
                   10110:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   10111:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   10112:     newer version (even if found in the FTP) because the meta packages
                   10113:     are supposed to list the exact versions that form a specific GNOME
                   10114:     release.  Exceptions are permitted here if a newer version solves a
                   10115:     serious issue in the overall desktop experience; these typically
                   10116:     come in the form of a revision bump in pkgsrc, not in newer versions
                   10117:     from the developers.</p>
                   10118: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   10119:     should be updated to the latest version available (if found in
                   10120:     pkgsrc).  This is the case, for example, of the dependencies on the
                   10121:     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>
                   10122: </li>
                   10123: <li>
                   10124: <p>Generate a patch from the modified meta packages and extract the
                   10125:     list of "new" lines.  This will provide you an outline on what
                   10126:     packages need to be updated in pkgsrc and in what order:</p>
                   10127: <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>
                   10128: </li>
                   10129: <li><p>For major desktop updates it is recommended to zap all your
                   10130:     installed packages and start over from scratch at this point.</p></li>
                   10131: <li><p>Now comes the longest step by far: iterate over the contents
                   10132:     of <code class="filename">todo.txt</code> and update the packages listed in
                   10133:     it in order.  For major desktop updates none of these should be
                   10134:     committed until the entire set is completed because there are chances
                   10135:     of breaking not-yet-updated packages.</p></li>
                   10136: <li><p>Once the packages are up to date and working, commit them to
                   10137:     the tree one by one with appropriate log messages.  At the end,
                   10138:     commit the three meta package updates and all the corresponding
                   10139:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   10140:     <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>
                   10141: </ol></div>
                   10142: </div>
                   10143: <div class="sect1" lang="en">
                   10144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10145: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1       dsieger  10146: <p>GNOME is a very big component in pkgsrc which approaches 100
                   10147: packages.  Please, it is very important that you always, always,
                   10148: <span class="strong"><strong>always</strong></span> feed back any portability
1.10      hubertf  10149: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.1       dsieger  10150: their attention on portability issues and to ensure that future versions
                   10151: can be built out-of-the box on NetBSD.  The less custom patches in
                   10152: pkgsrc, the easier further updates are.  Those developers in charge of
                   10153: issuing major GNOME updates will be grateful if you do that.</p>
1.10      hubertf  10154: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.1       dsieger  10155: Bugzilla</a>.  Not all components use these to track bugs, but most
                   10156: of them do.  Do not be short on your reports: always provide detailed
                   10157: explanations of the current failure, how it can be improved to achieve
                   10158: maximum portability and, if at all possible, provide a patch against CVS
                   10159: head.  The more verbose you are, the higher chances of your patch being
                   10160: accepted.</p>
                   10161: <p>Also, please avoid using preprocessor magic to fix portability
                   10162: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10163: GNOME to their operating system, the official GNOME sources are now
                   10164: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10165: and similar macros.  This hurts portability.  Please see our patching
1.10      hubertf  10166: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.1       dsieger  10167: details.</p>
                   10168: </div>
                   10169: </div>
                   10170: </div>
                   10171: <div class="part" lang="en">
                   10172: <div class="titlepage"><div><div><h1 class="title">
                   10173: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
                   10174: <div class="partintro" lang="en">
                   10175: <div></div>
                   10176: <p>This part of the guide deals with everything
                   10177:        from the infrastructure that is behind the interfaces described
                   10178:        in the developer's guide. A casual package maintainer should not
                   10179:        need anything from this part.</p>
                   10180: <div class="toc">
                   10181: <p><b>Table of Contents</b></p>
                   10182: <dl>
1.6       rillig   10183: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  10184: <dd><dl>
1.6       rillig   10185: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10186: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10187: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10188: <dd><dl>
1.6       rillig   10189: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10190: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10191: </dl></dd>
1.6       rillig   10192: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10193: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10194: <dd><dl>
1.6       rillig   10195: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10196: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10197: </dl></dd>
1.6       rillig   10198: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10199: <dd><dl>
1.15      rillig   10200: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
                   10201: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.1       dsieger  10202: </dl></dd>
                   10203: </dl></dd>
1.6       rillig   10204: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger  10205: <dd><dl>
1.6       rillig   10206: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10207: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10208: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10209: <dd><dl>
1.6       rillig   10210: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10211: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10212: </dl></dd>
                   10213: </dl></dd>
1.6       rillig   10214: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.1       dsieger  10215: <dd><dl>
1.6       rillig   10216: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10217: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10218: </dl></dd>
                   10219: </dl>
                   10220: </div>
                   10221: </div>
                   10222: <div class="chapter" lang="en">
                   10223: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10224: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  10225: <div class="toc">
                   10226: <p><b>Table of Contents</b></p>
                   10227: <dl>
1.6       rillig   10228: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10229: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10230: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  10231: <dd><dl>
1.6       rillig   10232: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10233: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  10234: </dl></dd>
1.6       rillig   10235: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10236: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10237: <dd><dl>
1.6       rillig   10238: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10239: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10240: </dl></dd>
1.6       rillig   10241: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10242: <dd><dl>
1.15      rillig   10243: <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in bsd.prefs.mk</a></span></dt>
                   10244: <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in bsd.pkg.mk</a></span></dt>
1.1       dsieger  10245: </dl></dd>
                   10246: </dl>
                   10247: </div>
                   10248: <p>The pkgsrc infrastructure consists of many small Makefile
                   10249:        fragments. Each such fragment needs a properly specified
                   10250:        interface. This chapter explains how such an interface looks
                   10251:        like.</p>
                   10252: <div class="sect1" lang="en">
                   10253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10254: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  10255: <p>Whenever a variable is defined in the pkgsrc
                   10256:        infrastructure, the location and the way of definition provide
                   10257:        much information about the intended use of that variable.
                   10258:        Additionally, more documentation may be found in a header
                   10259:        comment or in this pkgsrc guide.</p>
                   10260: <p>A special file is
                   10261:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10262:        variables that are intended to be user-defined. They are either
                   10263:        defined using the <code class="literal">?=</code> operator or they are
                   10264:        left undefined because defining them to anything would
                   10265:        effectively mean &#8220;<span class="quote">yes</span>&#8221;. All these variables may be
                   10266:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10267:        file.</p>
                   10268: <p>Outside this file, the following conventions apply:
                   10269:        Variables that are defined using the <code class="literal">?=</code>
                   10270:        operator may be overridden by a package.</p>
                   10271: <p>Variables that are defined using the <code class="literal">=</code>
                   10272:        operator may be used read-only at run-time.</p>
                   10273: <p>Variables whose name starts with an underscore must not be
                   10274:        accessed outside the pkgsrc infrastructure at all. They may
                   10275:        change without further notice.</p>
                   10276: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   10277: <h3 class="title">Note</h3>
                   10278: <p>These conventions are currently not applied
                   10279:        consistently to the complete pkgsrc
                   10280:        infrastructure.</p>
                   10281: </div>
                   10282: </div>
                   10283: <div class="sect1" lang="en">
                   10284: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10285: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  10286: <p>All variables that contain lists of things should default
                   10287:        to being empty. Two examples that do not follow this rule are
                   10288:        <code class="varname">USE_LANGUAGES</code> and
                   10289:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10290:        modified using the <code class="literal">+=</code> operator in package
                   10291:        <code class="filename">Makefile</code>s (or other files included by
                   10292:        them), since there is no guarantee whether the variable is
                   10293:        already set or not, and what its value is. In the case of
                   10294:        <code class="varname">DISTFILES</code>, the packages &#8220;<span class="quote">know</span>&#8221;
                   10295:        the default value and just define it as in the following
                   10296:        example.</p>
                   10297: <pre class="programlisting">
                   10298: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   10299: </pre>
                   10300: <p>Because of the selection of this default value, the same
                   10301:        value appears in many package Makefiles. Similarly for
                   10302:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
                   10303:        value (&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;) is so short that it
                   10304:        doesn't stand out. Nevertheless it is mentioned in many
                   10305:        files.</p>
                   10306: </div>
                   10307: <div class="sect1" lang="en">
                   10308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10309: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.1       dsieger  10310: <div class="sect2" lang="en">
                   10311: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10312: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1       dsieger  10313: <p>Variable evaluation takes place either at load time or at
                   10314:        runtime, depending on the context in which they occur. The
                   10315:        contexts where variables are evaluated at load time are:</p>
                   10316: <div class="itemizedlist"><ul type="disc">
                   10317: <li><p>The right hand side of the <code class="literal">:=</code>
                   10318:        and <code class="literal">!=</code> operators,</p></li>
                   10319: <li><p>Make directives like <code class="literal">.if</code> or
                   10320:        <code class="literal">.for</code>,</p></li>
                   10321: <li><p>Dependency lines.</p></li>
                   10322: </ul></div>
                   10323: <p>A special exception are references to the iteration
                   10324:        variables of <code class="literal">.for</code> loops, which are expanded
                   10325:        inline, no matter in which context they appear.</p>
                   10326: <p>As the values of variables may change during load time,
                   10327:        care must be taken not to evaluate them by accident. Typical
                   10328:        examples for variables that should not be evaluated at load time
                   10329:        are <code class="varname">DEPENDS</code> and
                   10330:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10331:        clear, here is an example:</p>
                   10332: <pre class="programlisting">
                   10333: CONFIGURE_ARGS=         # none
                   10334: CFLAGS=                 -O
                   10335: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   10336: 
                   10337: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   10338: 
                   10339: CFLAGS+=                -Wall
                   10340:        </pre>
                   10341: <p>This code shows how the use of the <code class="literal">:=</code>
                   10342:        operator can quickly lead to unexpected results. The first
                   10343:        paragraph is fairly common code. The second paragraph evaluates
                   10344:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10345:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10346:        <code class="literal">-Wall</code> is appended to the
                   10347:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10348:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10349:        paragraphs from above typically occur in completely unrelated
                   10350:        files.</p>
                   10351: </div>
                   10352: <div class="sect2" lang="en">
                   10353: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10354: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1       dsieger  10355: <p>After all the files have been loaded, the values of the
                   10356:        variables cannot be changed anymore. Variables that are used in
                   10357:        the shell commands are expanded at this point.</p>
                   10358: </div>
                   10359: </div>
                   10360: <div class="sect1" lang="en">
                   10361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10362: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  10363: <p>There are many ways in which the definition and use of a
                   10364:        variable can be restricted in order to detect bugs and
                   10365:        violations of the (mostly unwritten) policies. See the
                   10366:        <code class="literal">pkglint</code> developer's documentation for further
                   10367:        details.</p>
                   10368: </div>
                   10369: <div class="sect1" lang="en">
                   10370: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10371: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  10372: <p>Most of the <code class="filename">.mk</code> files fall into one
                   10373:        of the following classes. Cases where a file falls into more
                   10374:        than one class should be avoided as it often leads to subtle
                   10375:        bugs.</p>
                   10376: <div class="sect2" lang="en">
                   10377: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10378: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  10379: <p>In a traditional imperative programming language some of
                   10380:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 10381:        procedures. They take some input parameters and&mdash;after
                   10382:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  10383:        variables in <code class="filename">Makefile</code>s have global scope
                   10384:        care must be taken not to use parameter names that have already
                   10385:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10386:        bad choice for a parameter name.</p>
                   10387: <p>Procedures are completely evaluated at preprocessing time.
                   10388:        That is, when calling a procedure all input parameters must be
                   10389:        completely resolvable. For example,
                   10390:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10391:        parameter since it is very likely that further text will be
                   10392:        added after calling the procedure, which would effectively apply
                   10393:        the procedure to only a part of the variable. Also, references
                   10394:        to other variables wit will be modified after calling the
                   10395:        procedure.</p>
                   10396: <p>A procedure can declare its output parameters either as
                   10397:        suitable for use in preprocessing directives or as only
                   10398:        available at runtime. The latter alternative is for variables
                   10399:        that contain references to other runtime variables.</p>
                   10400: <p>Procedures shall be written such that it is possible to
                   10401:        call the procedure more than once. That is, the file must not
                   10402:        contain multiple-inclusion guards.</p>
                   10403: <p>Examples for procedures are
                   10404:        <code class="filename">mk/bsd.options.mk</code> and
                   10405:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   10406:        that the parameters are evaluated at load time, they should be
                   10407:        assigned using the <code class="literal">:=</code> operator, which should
                   10408:        be used only for this purpose.</p>
                   10409: </div>
                   10410: <div class="sect2" lang="en">
                   10411: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10412: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  10413: <p>Action files take some input parameters and may define
                   10414:        runtime variables. They shall not define loadtime variables.
                   10415:        There are action files that are included implicitly by the
                   10416:        pkgsrc infrastructure, while other must be included
                   10417:        explicitly.</p>
                   10418: <p>An example for action files is
                   10419:        <code class="filename">mk/subst.mk</code>.</p>
                   10420: </div>
                   10421: </div>
                   10422: <div class="sect1" lang="en">
                   10423: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10424: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  10425: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10426:        a set of variable definitions, and include the file
                   10427:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10428:        Before that, they may also include various other
                   10429:        <code class="filename">*.mk</code> files if they need to query the
                   10430:        availability of certain features like the type of compiler or
                   10431:        the X11 implementation. Due to the heavy use of preprocessor
                   10432:        directives like <code class="literal">.if</code> and
                   10433:        <code class="literal">.for</code>, the order in which the files are loaded
                   10434:        matters.</p>
                   10435: <p>This section describes at which point the various files
                   10436:        are loaded and gives reasons for that order.</p>
                   10437: <div class="sect2" lang="en">
                   10438: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10439: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  10440: </h3></div></div></div>
                   10441: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   10442:        is to define some essential variables like
                   10443:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10444:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10445: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  10446:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4       rillig   10447:        After that, those variables
1.1       dsieger  10448:        that have not been overridden by the user are loaded from
                   10449:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10450: <p>After the user settings, the system settings and platform
                   10451:        settings are loaded, which may override the user
                   10452:        settings.</p>
                   10453: <p>Then, the tool definitions are loaded. The tool wrappers
                   10454:        are not yet in effect. This only happens when building a
                   10455:        package, so the proper variables must be used instead of the
                   10456:        direct tool names.</p>
                   10457: <p>As the last steps, some essential variables from the
                   10458:        wrapper and the package system flavor are loaded, as well as the
                   10459:        variables that have been cached in earlier phases of a package
                   10460:        build.</p>
                   10461: </div>
                   10462: <div class="sect2" lang="en">
                   10463: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10464: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  10465: </h3></div></div></div>
                   10466: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10467: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10468:        loaded, which fill default values for those variables that have
                   10469:        not been defined by the package. These variables may later
                   10470:        be used even in unrelated files.</p>
                   10471: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10472:        provides the target <code class="literal">error-check</code> that is added
                   10473:        as a special dependency to all other targets that use
                   10474:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10475:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10476: <p>Then, the package-specific hacks from
                   10477:        <code class="filename">hacks.mk</code> are included.</p>
                   10478: <p>Then, various other files follow. Most of them don't have
                   10479:        any dependencies on what they need to have included before or
                   10480:        after them, though some do.</p>
                   10481: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10482:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10483:        restricts the use of these variables to all the files that have
                   10484:        been included before. Appearances in later files will be
                   10485:        silently ignored.</p>
                   10486: <p>Then, the files for the main targets are included, in the
                   10487:        order of later execution, though the actual order should not
                   10488:        matter.</p>
                   10489: <p>At last, some more files are included that don't set any
                   10490:        interesting variables but rather just define make targets to be
                   10491:        executed.</p>
                   10492: </div>
                   10493: </div>
                   10494: </div>
                   10495: <div class="chapter" lang="en">
                   10496: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10497: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1       dsieger  10498: <div class="toc">
                   10499: <p><b>Table of Contents</b></p>
                   10500: <dl>
1.6       rillig   10501: <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
                   10502: <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
                   10503: <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
1.1       dsieger  10504: <dd><dl>
1.6       rillig   10505: <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
                   10506: <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
1.1       dsieger  10507: </dl></dd>
                   10508: </dl>
                   10509: </div>
                   10510: <p>The pkgsrc infrastructure consists of a large codebase,
                   10511:        and there are many corners where every little bit of a file is
                   10512:        well thought out, making pkgsrc likely to fail as soon as
                   10513:        anything is changed near those parts. To prevent most changes
                   10514:        from breaking anything, a suite of regression tests should go
                   10515:        along with every important part of the pkgsrc infrastructure.
                   10516:        This chapter describes how regression tests work in pkgsrc and
                   10517:        how you can add new tests.</p>
                   10518: <div class="sect1" lang="en">
                   10519: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10520: <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
1.1       dsieger  10521: <p></p>
                   10522: </div>
                   10523: <div class="sect1" lang="en">
                   10524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10525: <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
1.1       dsieger  10526: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10      hubertf  10527:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  10528:        can simply run that command, which will run all tests in the
                   10529:        <code class="filename">regress</code> category.</p>
                   10530: </div>
                   10531: <div class="sect1" lang="en">
                   10532: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10533: <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
1.1       dsieger  10534: <p>Every directory in the <code class="filename">regress</code>
                   10535:        category that contains a file called <code class="filename">spec</code>
                   10536:        is considered a regression test. This file is a shell program
1.10      hubertf  10537:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  10538:        The following functions can be overridden to suit your
                   10539:        needs.</p>
                   10540: <div class="sect2" lang="en">
                   10541: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10542: <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
1.1       dsieger  10543: <p>These functions do not take any parameters. They are all
                   10544:        called in &#8220;<span class="quote">set -e</span>&#8221; mode, so you should be careful
                   10545:        to check the exitcodes of any commands you run in the
                   10546:        test.</p>
                   10547: <div class="variablelist"><dl>
                   10548: <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
                   10549: <dd><p>This function prepares the environment for the
                   10550:        test. By default it does nothing.</p></dd>
                   10551: <dt><span class="term"><code class="varname">do_test()</code></span></dt>
                   10552: <dd><p>This function runs the actual test. By default,
                   10553:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10554:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10555:        error messages into the file
                   10556:        <code class="varname">TEST_OUTFILE</code>.</p></dd>
                   10557: <dt><span class="term"><code class="varname">check_result()</code></span></dt>
                   10558: <dd><p>This function is run after the test and is
                   10559:        typically used to compare the actual output from the one that is
                   10560:        expected. It can make use of the various helper functions from
                   10561:        the next section.</p></dd>
                   10562: <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
                   10563: <dd><p>This function cleans everything up after the
                   10564:        test has been run. By default it does nothing.</p></dd>
                   10565: </dl></div>
                   10566: </div>
                   10567: <div class="sect2" lang="en">
                   10568: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   10569: <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
1.1       dsieger  10570: <div class="variablelist"><dl>
                   10571: <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
                   10572: <dd><p>This function compares the exitcode of the
1.10      hubertf  10573:        <span class="command"><strong>do_test()</strong></span> function with its first parameter.
1.1       dsieger  10574:        If they differ, the test will fail.</p></dd>
                   10575: <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
                   10576: <dd><p>This function checks for each of its parameters
1.10      hubertf  10577:        if the output from <span class="command"><strong>do_test()</strong></span> matches the
1.1       dsieger  10578:        extended regular expression. If it does not, the test will
                   10579:        fail.</p></dd>
                   10580: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10581: <dd><p>This function checks for each of its parameters
1.10      hubertf  10582:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  10583:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10584:        If any of the regular expressions matches, the test will
                   10585:        fail.</p></dd>
                   10586: </dl></div>
                   10587: </div>
                   10588: </div>
                   10589: </div>
                   10590: <div class="chapter" lang="en">
                   10591: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   10592: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  10593: <div class="toc">
                   10594: <p><b>Table of Contents</b></p>
                   10595: <dl>
1.6       rillig   10596: <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
                   10597: <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
1.1       dsieger  10598: </dl>
                   10599: </div>
                   10600: <p>The pkgsrc system has already been ported to many
                   10601:        operating systems, hardware architectures and compilers. This
                   10602:        chapter explains the necessary steps to make pkgsrc even more
                   10603:        portable.</p>
                   10604: <div class="sect1" lang="en">
                   10605: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10606: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10607: <p>To port pkgsrc to a new operating system (called
                   10608:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10609:        following files:</p>
                   10610: <div class="variablelist"><dl>
                   10611: <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>
                   10612: <dd><p>This file contains some basic definitions, for
                   10613:        example the name of the C
                   10614:        compiler.</p></dd>
                   10615: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10616: <dd><p>Insert code that defines the variables
                   10617:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10618:        <code class="varname">LOWER_OS_VERSION</code>,
                   10619:        <code class="varname">LOWER_VENDOR</code>,
                   10620:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10621:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10622:        appear in this file.</p></dd>
                   10623: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10624: <dd><p>This file contains the platform-specific
                   10625:        definitions that are used by pkgsrc. Start by copying one of the
                   10626:        other files and edit it to your
                   10627:        needs.</p></dd>
                   10628: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
                   10629: <dd><p>This file contains a list of directories,
                   10630:        together with their permission bits and ownership. These
                   10631:        directories will be created automatically with every package
                   10632:        that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
                   10633:        be removed.</p></dd>
                   10634: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
                   10635: <dd><p>Just copy one of the pre-existing x11.dist files
                   10636:        to your
                   10637:        <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
                   10638: <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
                   10639: <dd><p>On some operating systems, the tools that are
                   10640:        provided with the base system are not good enough for pkgsrc.
1.10      hubertf  10641:        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.1       dsieger  10642:        narrow limit on the line length they can process. Therefore
                   10643:        pkgsrc brings its own tools, which can be enabled
                   10644:        here.</p></dd>
                   10645: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10646: <dd><p>This file defines the paths to all the tools
                   10647:        that are needed by one or the other package in pkgsrc, as well
                   10648:        as by pkgsrc itself. Find out where these tools are on your
                   10649:        platform and add them.</p></dd>
                   10650: </dl></div>
                   10651: <p>Now, you should be able to build some basic packages, like
                   10652:        <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>
                   10653: </div>
                   10654: <div class="sect1" lang="en">
                   10655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   10656: <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
1.1       dsieger  10657: <p>TODO</p>
                   10658: </div>
                   10659: </div>
                   10660: </div>
                   10661: <div class="appendix" lang="en">
                   10662: <div class="titlepage"><div><div><h2 class="title">
                   10663: <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
                   10664: <div class="toc">
                   10665: <p><b>Table of Contents</b></p>
                   10666: <dl>
                   10667: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10668: <dd><dl>
                   10669: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10670: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10671: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.15      rillig   10672: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1       dsieger  10673: </dl></dd>
                   10674: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10675: </dl>
                   10676: </div>
                   10677: <p>We checked to find a piece of software that wasn't in the packages
                   10678:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  10679:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  10680:     present in the tree is beyond us, but it's useful for the purposes of
                   10681:     this exercise.</p>
                   10682: <div class="sect1" lang="en">
                   10683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10684: <a name="example-files"></a>A.1. files</h2></div></div></div>
                   10685: <div class="sect2" lang="en">
                   10686: <div class="titlepage"><div><div><h3 class="title">
                   10687: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10688: <pre class="programlisting">
                   10689: # $NetBSD$
                   10690: #
                   10691: 
                   10692: DISTNAME=       bison-1.25
                   10693: CATEGORIES=     devel
                   10694: MASTER_SITES=   ${MASTER_SITE_GNU}
                   10695: 
                   10696: MAINTAINER=     thorpej@NetBSD.org
                   10697: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10698: COMMENT=        GNU yacc clone
                   10699: 
                   10700: GNU_CONFIGURE=  yes
                   10701: INFO_FILES=     bison.info
                   10702: 
                   10703: .include "../../mk/bsd.pkg.mk"
                   10704: </pre>
                   10705: </div>
                   10706: <div class="sect2" lang="en">
                   10707: <div class="titlepage"><div><div><h3 class="title">
                   10708: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10709: <pre class="programlisting">
                   10710: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.10      hubertf  10711: 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.1       dsieger  10712: of the NetBSD source tree is beyond me.
                   10713: </pre>
                   10714: </div>
                   10715: <div class="sect2" lang="en">
                   10716: <div class="titlepage"><div><div><h3 class="title">
                   10717: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10718: <pre class="programlisting">
                   10719: @comment $NetBSD$
                   10720: bin/bison
                   10721: man/man1/bison.1.gz
                   10722: share/bison.simple
                   10723: share/bison.hairy
                   10724: </pre>
                   10725: </div>
                   10726: <div class="sect2" lang="en">
                   10727: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  10728: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1       dsieger  10729: </h3></div></div></div>
                   10730: <p>The NetBSD package system comes with
                   10731:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
                   10732:        which helps to check the contents of these
                   10733:        files. After installation it is quite easy to use, just change to the
                   10734:        directory of the package you wish to examine and execute
1.10      hubertf  10735:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  10736: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10737: looks fine.</pre>
                   10738: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10      hubertf  10739:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1       dsieger  10740:        -Wall</strong></span> for a very thorough check.</p>
                   10741: </div>
                   10742: </div>
                   10743: <div class="sect1" lang="en">
                   10744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10745: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10746: <p>Create the directory where the package lives,
                   10747:       plus any auxiliary directories:</p>
                   10748: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10749: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10750: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10751: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10752: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10      hubertf  10753:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.1       dsieger  10754:       then continue with fetching the distfile:</p>
                   10755: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10756: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10757: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10758: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10759: ftp: Error retrieving file: 500 Internal error
                   10760: 
                   10761: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10762: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10763: ftp: Error retrieving file: 500 Internal error
                   10764: 
                   10765: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10766: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10767: Successfully retrieved file.</pre>
                   10768: <p>Generate the checksum of the distfile into
                   10769:       <code class="filename">distinfo</code>:</p>
                   10770: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10771: <p>Now compile:</p>
                   10772: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10773: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10774: ===&gt;  Extracting for bison-1.25
                   10775: ===&gt;  Patching for bison-1.25
                   10776: ===&gt;   Ignoring empty patch directory
                   10777: ===&gt;  Configuring for bison-1.25
                   10778: creating cache ./config.cache
                   10779: checking for gcc... cc
                   10780: checking whether we are using GNU C... yes
                   10781: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10782: checking how to run the C preprocessor... cc -E
                   10783: checking for minix/config.h... no
                   10784: checking for POSIXized ISC... no
                   10785: checking whether cross-compiling... no
                   10786: checking for ANSI C header files... yes
                   10787: checking for string.h... yes
                   10788: checking for stdlib.h... yes
                   10789: checking for memory.h... yes
                   10790: checking for working const... yes
                   10791: checking for working alloca.h... no
                   10792: checking for alloca... yes
                   10793: checking for strerror... yes
                   10794: updating cache ./config.cache
                   10795: creating ./config.status
                   10796: creating Makefile
                   10797: ===&gt;  Building for bison-1.25
                   10798: 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
                   10799: 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
                   10800: 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
                   10801: 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
                   10802: 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
                   10803: 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
                   10804: 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
                   10805: 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
                   10806: 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
                   10807: 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
                   10808: 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
                   10809: 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
                   10810: 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
                   10811: 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
                   10812: 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
                   10813: 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
                   10814: 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
                   10815: 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
                   10816: 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
                   10817: 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
                   10818: 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
                   10819: 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
                   10820: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10821: rm -f bison.s1
                   10822: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10823: <p>Everything seems OK, so install the files:</p>
                   10824: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10825: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10826: ===&gt;  Installing for bison-1.25
                   10827: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10828: rm -f /usr/pkg/bin/bison
                   10829: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10830: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10831: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10832: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10833: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10834: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10835: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10836: ===&gt;  Registering installation for bison-1.25</pre>
                   10837: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10838:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10839:       binary package, do this now:</p>
                   10840: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10841: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10842: ===&gt;  Building package for bison-1.25
                   10843: Creating package bison-1.25.tgz
                   10844: Registering depends:.
                   10845: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10846: <p>Now that you don't need the source and object files
                   10847:       any more, clean up:</p>
                   10848: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10849: ===&gt;  Cleaning for bison-1.25</pre>
                   10850: </div>
                   10851: </div>
                   10852: <div class="appendix" lang="en">
                   10853: <div class="titlepage"><div><div><h2 class="title">
                   10854: <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
                   10855: <div class="toc">
                   10856: <p><b>Table of Contents</b></p>
                   10857: <dl>
                   10858: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10859: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10860: </dl>
                   10861: </div>
                   10862: <div class="sect1" lang="en">
                   10863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10864: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10865: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10866: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10867: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10868: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10869: =&gt; [172219 bytes]
                   10870: Connected to ftp.plig.net.
                   10871: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10872: 331 Guest login ok, send your complete e-mail address as password.
                   10873: 230-You are user #5 of 500 simultaneous users allowed.
                   10874: 230-
                   10875: 230-  ___ _             _ _
                   10876: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10877: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10878: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10879: 230-         |_|   |_|     |___|         |___|
                   10880: 230-
                   10881: 230-** Welcome to ftp.plig.org **
                   10882: 230-
                   10883: 230-Please note that all transfers from this FTP site are logged. If you
                   10884: 230-do not like this, please disconnect now.
                   10885: 230-
                   10886: 230-This arhive is available via
                   10887: 230-
                   10888: 230-HTTP:  http://ftp.plig.org/
                   10889: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10890: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10891: 230-
                   10892: 230-Please email comments, bug reports and requests for packages to be
                   10893: 230-mirrored to ftp-admin@plig.org.
                   10894: 230-
                   10895: 230-
                   10896: 230 Logged in anonymously.
                   10897: Remote system type is UNIX.
                   10898: Using binary mode to transfer files.
                   10899: 200 Type okay.
                   10900: 250 "/pub" is new cwd.
                   10901: 250-"/pub/figlet" is new cwd.
                   10902: 250-
                   10903: 250-Welcome to the figlet archive at ftp.figlet.org
                   10904: 250-
                   10905: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10906: 250-
                   10907: 250-The official FIGlet web page is:
                   10908: 250-   http://www.figlet.org/
                   10909: 250-
                   10910: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10911: 250-contribute a font or something else, you can email us.
                   10912: 250
                   10913: 250 "/pub/figlet/program" is new cwd.
                   10914: 250 "/pub/figlet/program/unix" is new cwd.
                   10915: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10916: 502 Unimplemented command.
                   10917: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10918: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10919: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10920: 226 Transfer completed.
                   10921: 172219 bytes received in 00:02 (75.99 KB/s)
                   10922: 221 Goodbye.
                   10923: =&gt; Checksum OK for figlet221.tar.gz.
                   10924: ===&gt; Extracting for figlet-2.2.1nb2
                   10925: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10926: ===&gt; Patching for figlet-2.2.1nb2
                   10927: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10928: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10929: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10930: ===&gt; Configuring for figlet-2.2.1nb2
                   10931: ===&gt; Building for figlet-2.2.1nb2
                   10932: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10933: chmod a+x figlet
                   10934: gcc -O2 -o chkfont chkfont.c
                   10935: =&gt; Unwrapping files-to-be-installed.
                   10936: <code class="prompt">#</code>
                   10937: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10938: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10939: ===&gt; Installing for figlet-2.2.1nb2
                   10940: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10941: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10942: mkdir -p /usr/pkg/share/figlet
                   10943: cp figlet /usr/pkg/bin
                   10944: cp chkfont /usr/pkg/bin
                   10945: chmod 555 figlist showfigfonts
                   10946: cp figlist /usr/pkg/bin
                   10947: cp showfigfonts /usr/pkg/bin
                   10948: cp fonts/*.flf /usr/pkg/share/figlet
                   10949: cp fonts/*.flc /usr/pkg/share/figlet
                   10950: cp figlet.6 /usr/pkg/man/man6
                   10951: ===&gt; Registering installation for figlet-2.2.1nb2
                   10952: <code class="prompt">#</code></pre>
                   10953: </div>
                   10954: <div class="sect1" lang="en">
                   10955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10956: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10957: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10958: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10959: ===&gt; Packaging figlet-2.2.1nb2
                   10960: ===&gt; Building binary package for figlet-2.2.1nb2
                   10961: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10962: Using SrcDir value of /usr/pkg
                   10963: Registering depends:.
                   10964: <code class="prompt">#</code></pre>
                   10965: </div>
                   10966: </div>
                   10967: <div class="appendix" lang="en">
                   10968: <div class="titlepage"><div><div><h2 class="title">
                   10969: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
                   10970: <div class="toc">
                   10971: <p><b>Table of Contents</b></p>
                   10972: <dl>
1.15      rillig   10973: <dt><span class="sect1"><a href="#ftp-bootstrap">C.1. bootstrap-pkgsrc: Bootstrap kits</a></span></dt>
                   10974: <dt><span class="sect1"><a href="#ftp-distfiles">C.2. distfiles: The distributed source files</a></span></dt>
                   10975: <dt><span class="sect1"><a href="#ftp-iso">C.3. iso: Currently empty</a></span></dt>
                   10976: <dt><span class="sect1"><a href="#ftp-misc">C.4. misc: Miscellaneous things</a></span></dt>
                   10977: <dt><span class="sect1"><a href="#ftp-packages">C.5. packages: Binary packages</a></span></dt>
                   10978: <dt><span class="sect1"><a href="#ftp-reports">C.6. reports: Bulk build reports</a></span></dt>
                   10979: <dt><span class="sect1"><a href="#ftp-source">C.7. current,
                   10980: pkgsrc-200xQy:
1.1       dsieger  10981: source packages</a></span></dt>
                   10982: </dl>
                   10983: </div>
                   10984: <p>As in other big projects, the directory layout of pkgsrc
                   10985:        is quite complex for newbies. This chapter explains where you
                   10986:        find things on the FTP server. The base directory on
1.10      hubertf  10987:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.1       dsieger  10988:        On other servers it may be different, but inside this directory,
                   10989:        everything should look the same, no matter on which server you
                   10990:        are. This directory contains some subdirectories, which are
                   10991:        explained below.</p>
                   10992: <div class="sect1" lang="en">
                   10993: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10994: <a name="ftp-bootstrap"></a>C.1. <code class="filename">bootstrap-pkgsrc</code>: Bootstrap kits</h2></div></div></div>
1.9       rillig   10995: <p>This directory used to contain binary packages of the
                   10996:        package management tools for various platforms. For those
                   10997:        package collections that need them, they are now stored near the
1.10      hubertf  10998:        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.9       rillig   10999:        directory</a>.</p>
1.1       dsieger  11000: </div>
                   11001: <div class="sect1" lang="en">
                   11002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11003: <a name="ftp-distfiles"></a>C.2. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
                   11004: <p>The directory <code class="filename">distfiles</code> contains lots
                   11005:        of archive files from all pkgsrc packages, which are mirrored
                   11006:        here. The subdirectories are called after their package names
                   11007:        and are used when the distributed files have names that don't
                   11008:        explicitly contain a version number or are otherwise too generic
                   11009:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11010: </div>
                   11011: <div class="sect1" lang="en">
                   11012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11013: <a name="ftp-iso"></a>C.3. <code class="filename">iso</code>: Currently empty</h2></div></div></div>
                   11014: <p>This directory is currently not in use.</p>
                   11015: </div>
                   11016: <div class="sect1" lang="en">
                   11017: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11018: <a name="ftp-misc"></a>C.4. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
                   11019: <p>This directory contains things that individual pkgsrc
                   11020:        developers find worth publishing.</p>
                   11021: </div>
                   11022: <div class="sect1" lang="en">
                   11023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.3       rillig   11024: <a name="ftp-packages"></a>C.5. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
                   11025: <p>This directory contains binary packages for the various
                   11026:        platforms that are supported by pkgsrc.
                   11027:        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>
                   11028: <div class="itemizedlist"><ul type="disc">
1.8       rillig   11029: <li><p><code class="varname">OPSYS</code> is the name of the
1.9       rillig   11030:        operating system for which the packages have been built. The
1.10      hubertf  11031:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9       rillig   11032:        command, so it may differ from the one you are used to
                   11033:        hear.</p></li>
1.8       rillig   11034: <li><p><code class="varname">ARCH</code> is the hardware
                   11035:        architecture of the platform for which the packages have been
1.10      hubertf  11036:        built. It also includes the <code class="varname">ABI</code> (Application
                   11037:        Binary Interface) for platforms that have several of
                   11038:        them.</p></li>
1.8       rillig   11039: <li><p><code class="varname">OSVERSION</code> is the version of
                   11040:        the operating system. For version numbers that change often (for
                   11041:        example NetBSD-current), the often-changing part should be
                   11042:        replaced with an <code class="literal">x</code>, for example
                   11043:        <code class="literal">4.99.x</code>.</p></li>
                   11044: <li><p><code class="varname">TAG</code> is either
                   11045:        <code class="literal">200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11046:        for a stable branch, or <code class="literal">head</code> for packages
                   11047:        built from the HEAD branch. The latter should only be used when
                   11048:        the packages are updated on a regular basis. Otherwise the date
                   11049:        from checking out pkgsrc should be appended, for example
                   11050:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   11051: </ul></div>
                   11052: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11053:        can quickly click through the directories on the
                   11054:        server and find the best binary packages for their machines. Since they
                   11055:        usually know the operating system and the hardware architecture, OPSYS
                   11056:        and ARCH are placed first. After these choices, they can select the
                   11057:        best combination of OSVERSION and TAG together, since it is usually the
                   11058:        case that packages stay compatible between different version of the
                   11059:        operating system.</p>
                   11060: <p>In each of these directories, there is a
                   11061:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  11062:        <code class="filename">All</code> which contains all binary packages.
                   11063:        Besides that, there are various category directories that
                   11064:        contain symbolic links to the real binary packages.</p>
                   11065: </div>
                   11066: <div class="sect1" lang="en">
                   11067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.8       rillig   11068: <a name="ftp-reports"></a>C.6. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
                   11069: <p>Here are the reports from bulk builds, for those who want
                   11070:        to fix packages that didn't build on some of the platforms. The
1.15      rillig   11071:        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.8       rillig   11072: </div>
                   11073: <div class="sect1" lang="en">
                   11074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11075: <a name="ftp-source"></a>C.7. <code class="filename">current</code>,
1.1       dsieger  11076: <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em></code>:
                   11077: source packages</h2></div></div></div>
                   11078: <p>These directories contain the &#8220;<span class="quote">real</span>&#8221; pkgsrc,
                   11079:        that is the files that define how to create binary packages from
                   11080:        source archives.</p>
                   11081: <p>The directory <code class="filename">pkgsrc</code> contains a
                   11082:        snapshot of the CVS repository, which is updated regularly. The
                   11083:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   11084:        directory, ready to be downloaded as a whole.</p>
                   11085: <p>In the directories for the quarterly branches, there is an
                   11086:        additional file called
                   11087:        <code class="filename">pkgsrc-200<em class="replaceable"><code>x</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
                   11088:        which contains the state of pkgsrc when it was branched.</p>
                   11089: </div>
                   11090: </div>
                   11091: <div class="appendix" lang="en">
                   11092: <div class="titlepage"><div><div><h2 class="title">
                   11093: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
                   11094: <div class="toc">
                   11095: <p><b>Table of Contents</b></p>
                   11096: <dl>
                   11097: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                   11098: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   11099: </dl>
                   11100: </div>
                   11101: <p>This section contains information on editing the pkgsrc
                   11102:        guide itself.</p>
                   11103: <div class="sect1" lang="en">
                   11104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11105: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   11106: <p>The pkgsrc guide's source code is stored in
                   11107:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   11108:        are created from it:</p>
                   11109: <div class="itemizedlist"><ul type="disc">
                   11110: <li><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   11111: <li><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.10      hubertf  11112: <li><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   11113: <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.1       dsieger  11114:        The PDF version of the pkgsrc guide.</p></li>
1.10      hubertf  11115: <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.1       dsieger  11116:        PostScript version of the pkgsrc guide.</p></li>
                   11117: </ul></div>
                   11118: </div>
                   11119: <div class="sect1" lang="en">
                   11120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11121: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
                   11122: <p>The procedure to edit the pkgsrc guide is:</p>
                   11123: <div class="procedure"><ol type="1">
                   11124: <li><p>Make sure you have the packages needed to
                   11125:        regenerate the pkgsrc guide (and other XML-based NetBSD
                   11126:        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
                   11127:        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
                   11128:        PostScript and PDF versions. You will need both packages
                   11129:        installed, to make sure documentation is consistent across all
                   11130:        formats.</p></li>
1.10      hubertf  11131: <li><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  11132:        right directory. All further steps will take place
                   11133:        here.</p></li>
                   11134: <li><p>Edit the XML file(s) in
                   11135:        <code class="filename">files/</code>.</p></li>
1.10      hubertf  11136: <li><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  11137:        guide for valid XML and to build the final output files. If you
                   11138:        get any errors at this stage, you can just edit the files, as
                   11139:        there are only symbolic links in the working directory, pointing
                   11140:        to the files in <code class="filename">files/</code>.</p></li>
1.10      hubertf  11141: <li><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  11142:        commit)</strong></span></p></li>
1.10      hubertf  11143: <li><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  11144:        regenerate the output files with the proper RCS
                   11145:        Ids.</p></li>
                   11146: <li>
1.10      hubertf  11147: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  11148:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   11149:        <code class="filename">htdocs</code>.</p>
                   11150: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   11151: <h3 class="title">Note</h3>
                   11152: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  11153:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   11154:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  11155:        directory.</p>
                   11156: </div>
                   11157: </li>
                   11158: </ol></div>
                   11159: </div>
                   11160: </div>
                   11161: </div></body>
                   11162: </html>

CVSweb <webmaster@jp.NetBSD.org>