doc/pkgsrc.html

   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>
   6 <link rel="stylesheet" href="/global.css" type="text/css">
   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" title="The pkgsrc guide">
  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>
  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>
  22 </div>
  23 <div class="author">
  24 <h3 class="author">
  25 <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
  26 </h3>
  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>
  28 </div>
  29 <h3 class="corpauthor">
  30         The pkgsrc Developers
  31       </h3>
  32 </div></div>
  33 <div><p class="copyright">Copyright © 1994-2007 The NetBSD Foundation, Inc</p></div>
  34 <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.26 2007/09/18 08:17:21 rillig Exp $</p></div>
  35 <div><div class="abstract" title="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-cvs">2.1.2. Via anonymous CVS</a></span></dt>
  69 </dl></dd>
  70 <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
  71 <dd><dl>
  72 <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
  73 <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
  74 </dl></dd>
  75 </dl></dd>
  76 <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
  77 <dd><dl>
  78 <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
  79 <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
  80 <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
  81 <dd><dl>
  82 <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
  83 <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
  84 <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
  85 <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
  86 <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
  87 <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
  88 <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
  89 </dl></dd>
  90 </dl></dd>
  91 <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
  92 <dd><dl>
  93 <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
  94 <dd><dl>
  95 <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
  96 <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
  97 <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
  98 <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
  99 <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
 100 <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
 101 <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
 102 <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
 103 </dl></dd>
 104 <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
 105 <dd><dl>
 106 <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
 107 <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
 108 <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
 109 </dl></dd>
 110 </dl></dd>
 111 <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
 112 <dd><dl>
 113 <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
 114 <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
 115 <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
 116 <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
 117 <dd><dl>
 118 <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
 119 <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
 120 <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
 121 </dl></dd>
 122 <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
 123 <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
 124 </dl></dd>
 125 <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
 126 <dd><dl>
 127 <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
 128 <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
 129 </dl></dd>
 130 <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
 131 builds)</a></span></dt>
 132 <dd><dl>
 133 <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
 134 <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
 135 <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
 136 <dd><dl>
 137 <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
 138 <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
 139 <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
 140 <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
 141 <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
 142 <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
 143 <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
 144 <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
 145 </dl></dd>
 146 <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
 147 <dd><dl>
 148 <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
 149 <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
 150 </dl></dd>
 151 <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
 152 <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
 153 </dl></dd>
 154 <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
 155 <dd><dl>
 156 <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
 157 <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
 158 </dl></dd>
 159 <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
 160 <dd><dl>
 161 <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
 162 <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
 163 <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
 164 <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
 165 <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
 166 <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
 167 <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
 168 <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
 169 <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
 170 <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
 171 /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
 172 <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
 173 <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
 174 <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
 175 <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
 176 <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
 177 <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
 178 <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
 179 </dl></dd>
 180 </dl></dd>
 181 <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
 182 <dd><dl>
 183 <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
 184 <dd><dl>
 185 <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
 186 <dd><dl>
 187 <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
 188 <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
 189 <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
 190 </dl></dd>
 191 <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
 192 <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
 193 </dl></dd>
 194 <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
 195 <dd><dl>
 196 <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
 197 <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
 198 <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
 199 <dd><dl>
 200 <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
 201 <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
 202 <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
 203 <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
 204 <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
 205 </dl></dd>
 206 <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
 207 <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
 208 <dd><dl>
 209 <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
 210 <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
 211 <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
 212 </dl></dd>
 213 <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
 214 <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
 215 </dl></dd>
 216 <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
 217 <dd><dl>
 218 <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
 219 <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
 220 <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
 221 <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
 222 <dd><dl>
 223 <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
 224 <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
 225 <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
 226 <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
 227 <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
 228 </dl></dd>
 229 </dl></dd>
 230 <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
 231 <dd><dl>
 232 <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
 233 <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
 234 <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
 235 <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
 236 <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
 237 <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
 238 <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
 239 <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
 240 </dl></dd>
 241 <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
 242 <dd><dl>
 243 <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
 244 <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
 245 <dd><dl>
 246 <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
 247 <dt><span class="sect2"><a href="#updating-buildlink-depends">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</a></span></dt>
 248 </dl></dd>
 249 <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
 250 <dd><dl>
 251 <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
 252 <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
 253 </dl></dd>
 254 </dl></dd>
 255 <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
 256 <dd><dl>
 257 <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
 258 <dd><dl>
 259 <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
 260 <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
 261 </dl></dd>
 262 <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
 263 <dd><dl>
 264 <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
 265 <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
 266 <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
 267 <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
 268 </dl></dd>
 269 <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
 270 <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>
 271 <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
 272 <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
 273 <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
 274 <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
 275 <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>
 276 </dl></dd>
 277 <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
 278 <dd><dl>
 279 <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
 280 <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
 281 <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
 282 <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
 283 </dl></dd>
 284 <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
 285 <dd><dl>
 286 <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
 287 <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
 288 <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
 289 <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
 290 <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
 291 <dd><dl>
 292 <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
 293 <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
 294 </dl></dd>
 295 <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
 296 <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
 297 <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
 298 <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
 299 <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
 300 <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
 301 <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
 302 <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
 303 <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
 304 <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
 305 <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
 306 <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
 307 </dl></dd>
 308 <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
 309 <dd><dl>
 310 <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
 311 <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
 312 <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
 313 <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
 314 </dl></dd>
 315 <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
 316 <dd><dl>
 317 <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
 318 <dd><dl>
 319 <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
 320 <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
 321 <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
 322 <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
 323 <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
 324 <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
 325 <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
 326 <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
 327 <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
 328 <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
 329 <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
 330 <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
 331 </dl></dd>
 332 <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
 333 <dd><dl>
 334 <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
 335 <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>
 336 </dl></dd>
 337 <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
 338 <dd><dl>
 339 <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
 340 <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
 341 <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
 342 </dl></dd>
 343 <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
 344 <dd><dl>
 345 <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
 346 <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
 347 <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
 348 <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
 349 </dl></dd>
 350 <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
 351 <dd><dl>
 352 <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
 353 <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
 354 <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
 355 <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
 356 </dl></dd>
 357 <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
 358 <dd><dl>
 359 <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
 360 <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
 361 <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
 362 <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
 363 <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
 364 <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
 365 <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
 366 <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
 367 <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
 368 <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
 369 <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
 370 <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
 371 <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
 372 <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
 373 <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
 374 <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
 375 <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
 376 <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
 377     emulation</a></span></dt>
 378 <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
 379 <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
 380 </dl></dd>
 381 <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
 382 </dl></dd>
 383 <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
 384 <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
 385 <dd><dl>
 386 <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
 387 <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
 388 <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
 389 <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
 390 <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
 391 <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
 392 <dt><span class="sect1"><a href="#moving-package">21.7. 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>
 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>
 405 <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
 406 <dd><dl>
 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>
 410 <dd><dl>
 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>
 413 </dl></dd>
 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>
 416 <dd><dl>
 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>
 419 </dl></dd>
 420 <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
 421 <dd><dl>
 422 <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
 423 <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
 424 </dl></dd>
 425 </dl></dd>
 426 <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
 427 <dd><dl>
 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>
 431 <dd><dl>
 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>
 434 </dl></dd>
 435 </dl></dd>
 436 <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
 437 <dd><dl>
 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>
 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>
 449 <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
 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>
 460 <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
 461 <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
 462 <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
 463 <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
 464 <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
 465 <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
 466 source packages</a></span></dt>
 467 </dl></dd>
 468 <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
 469 <dd><dl>
 470 <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
 471 <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
 472 </dl></dd>
 473 </dl>
 474 </div>
 475 <div class="list-of-tables">
 476 <p><b>List of Tables</b></p>
 477 <dl>
 478 <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
 479 </dt>
 480 <dt>11.1. <a href="#patch-examples">Patching examples</a>
 481 </dt>
 482 <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
 483 </dt>
 484 </dl>
 485 </div>
 486 <div class="chapter" title="Chapter 1. What is pkgsrc?">
 487 <div class="titlepage"><div><div><h2 class="title">
 488 <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
 489 <div class="toc">
 490 <p><b>Table of Contents</b></p>
 491 <dl>
 492 <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
 493 <dd><dl>
 494 <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
 495 <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
 496 </dl></dd>
 497 <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
 498 <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
 499 <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
 500 <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
 501 </dl>
 502 </div>
 503 <div class="sect1" title="1.1. Introduction">
 504 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 505 <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
 506 <p>There is a lot of software freely available for Unix-based
 507 systems, which is usually available in form of the source code. Before
 508 such software can be used, it needs to be configured to the local
 509 system, compiled and installed, and this is exactly what The NetBSD
 510 Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
 511 to handle binary packages, so that not every user has to build the
 512 packages for himself, which is a time-costly task.</p>
 513 <p>pkgsrc currently contains several thousand packages,
 514       including:</p>
 515 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 516 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
 517           web server</p></li>
 518 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
 519           web browser</p></li>
 520 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
 521           Desktop Environment</p></li>
 522 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
 523           Desktop Environment</p></li>
 524 </ul></div>
 525 <p>...just to name a few.</p>
 526 <p>pkgsrc has built-in support for handling varying dependencies,
 527       such as pthreads and X11, and extended features such as IPv6 support on
 528       a range of platforms.</p>
 529 <div class="sect2" title="1.1.1. Why pkgsrc?">
 530 <div class="titlepage"><div><div><h3 class="title">
 531 <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
 532 <p>
 533 pkgsrc provides the following key features:
 534 </p>
 535 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 536 <li class="listitem"><p>Easy building of software from source as well as the creation
 537   and installation of binary packages. The source and latest
 538   patches are retrieved from a master or mirror download site, checksum
 539   verified, then built on your system. Support for binary-only
 540   distributions is available for both native platforms and NetBSD
 541   emulated platforms.</p></li>
 542 <li class="listitem"><p>All packages are installed in a consistent directory tree,
 543   including binaries, libraries, man pages and other
 544   documentation.</p></li>
 545 <li class="listitem"><p>Package dependencies, including when performing package updates,
 546   are handled automatically. The configuration files of various
 547   packages are handled automatically during updates, so local changes
 548   are preserved.</p></li>
 549 <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
 550   consists of highly portable code. This allows the greatest speed of
 551   development when porting to new a platform. This portability also
 552   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
 553   platforms</em></span>.</p></li>
 554 <li class="listitem"><p>The installation prefix, acceptable software licenses,
 555   international encryption requirements and build-time options for a
 556   large number of packages are all set in a simple, central
 557   configuration file.</p></li>
 558 <li class="listitem"><p>The entire source (not including the distribution files) is
 559   freely available under a BSD license, so you may extend and adapt
 560   pkgsrc to your needs. Support for local packages and patches is
 561   available right out of the box, so you can configure it specifically
 562   for your environment.</p></li>
 563 </ul></div>
 564 <p>The following principles are basic to pkgsrc:</p>
 565 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 566 <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
 567 &mdash; That means, if a package contains bugs, it's better to find
 568 them and to complain about them rather than to just install the package
 569 and hope that it works. There are numerous checks in pkgsrc that try to
 570 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
 571 of shell scripts), and post-installation checks (installed files,
 572 references to shared libraries, script interpreters).</p></li>
 573 <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
 574 &mdash; Like NetBSD has been ported to many hardware architectures,
 575 pkgsrc has been ported to many operating systems. Care is taken that
 576 packages behave the same on all platforms.</p></li>
 577 </ul></div>
 578 </div>
 579 <div class="sect2" title="1.1.2. Supported platforms">
 580 <div class="titlepage"><div><div><h3 class="title">
 581 <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
 582 <p>pkgsrc consists of both a source distribution and a binary
 583 distribution for these operating systems. After retrieving the required
 584 source or binaries, you can be up and running with pkgsrc in just
 585 minutes!</p>
 586 <p>pkgsrc was derived from FreeBSD's ports system, and
 587       initially developed for NetBSD only. Since then, pkgsrc has
 588       grown a lot, and now supports the following platforms:</p>
 589 <div class="table">
 590 <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
 591 <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
 592 <colgroup>
 593 <col>
 594 <col>
 595 </colgroup>
 596 <thead><tr>
 597 <th>Platform</th>
 598 <th>Date Support Added</th>
 599 </tr></thead>
 600 <tbody>
 601 <tr>
 602 <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
 603 <td align="center">Aug 1997</td>
 604 </tr>
 605 <tr>
 606 <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
 607 <td align="center">Mar 1999</td>
 608 </tr>
 609 <tr>
 610 <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
 611 <td align="center">Jun 1999</td>
 612 </tr>
 613 <tr>
 614 <td>
 615           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
 616           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
 617         </td>
 618 <td align="center">Oct 2001</td>
 619 </tr>
 620 <tr>
 621 <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
 622 <td align="center">Nov 2002</td>
 623 </tr>
 624 <tr>
 625 <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
 626 <td align="center">Nov 2002</td>
 627 </tr>
 628 <tr>
 629 <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
 630 <td align="center">Dec 2002</td>
 631 </tr>
 632 <tr>
 633 <td>BSD/OS</td>
 634 <td align="center">Dec 2003</td>
 635 </tr>
 636 <tr>
 637 <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
 638 <td align="center">Dec 2003</td>
 639 </tr>
 640 <tr>
 641 <td>
 642           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
 643           (Microsoft Windows Services for Unix)
 644         </td>
 645 <td align="center">Mar 2004</td>
 646 </tr>
 647 <tr>
 648 <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
 649 <td align="center">Oct 2004</td>
 650 </tr>
 651 <tr>
 652 <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
 653 <td align="center">Nov 2004</td>
 654 </tr>
 655 <tr>
 656 <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
 657 <td align="center">Apr 2007</td>
 658 </tr>
 659 <tr>
 660 <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
 661 <td align="center">Sep 2010</td>
 662 </tr>
 663 </tbody>
 664 </table></div>
 665 </div>
 666 <br class="table-break">
 667 </div>
 668 </div>
 669 <div class="sect1" title="1.2. Overview">
 670 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 671 <a name="overview"></a>1.2. Overview</h2></div></div></div>
 672 <p>This document is divided into three parts. The first,
 673         <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
 674         describes how one can use one of the packages in the Package
 675         Collection, either by installing a precompiled binary package,
 676         or by building one's own copy using the NetBSD package system.
 677         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
 678         package so it can be easily built by other NetBSD users without
 679         knowing about the package's building details. The third part,
 680         <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
 681         is intended for those who want to understand how pkgsrc is
 682         implemented.</p>
 683 <p>This document is available in various formats:
 684         <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>
 685 </div>
 686 <div class="sect1" title="1.3. Terminology">
 687 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 688 <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
 689 <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
 690       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
 691       terminology used within this document.</p>
 692 <div class="variablelist"><dl>
 693 <dt><span class="term">Package</span></dt>
 694 <dd><p>A set of files and building instructions
 695             that describe what's necessary
 696             to build a certain piece of software using
 697             pkgsrc. Packages are traditionally stored under
 698             <code class="filename">/usr/pkgsrc</code>.</p></dd>
 699 <dt><span class="term">The NetBSD package system</span></dt>
 700 <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
 701           is part of the NetBSD operating system and can be bootstrapped
 702           to run on non-NetBSD operating systems as well.  It handles
 703           building (compiling), installing, and removing of
 704           packages.</p></dd>
 705 <dt><span class="term">Distfile</span></dt>
 706 <dd><p>This term describes the file or files that are
 707             provided by the author of the piece of software to
 708             distribute his work. All the changes necessary to build on
 709             NetBSD are reflected in the corresponding package. Usually
 710             the distfile is in the form of a compressed tar-archive,
 711             but other types are possible, too. Distfiles are usually
 712             stored below
 713             <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
 714 <dt><span class="term">Port</span></dt>
 715 <dd><p>This is the term used by FreeBSD and OpenBSD people
 716             for what we call a package.
 717             In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
 718             architecture.</p></dd>
 719 <dt><span class="term">Precompiled/binary package</span></dt>
 720 <dd>
 721 <p>A set of binaries built with pkgsrc from a distfile
 722             and stuffed together in a single <code class="filename">.tgz</code>
 723             file so it can be installed on machines of the same
 724             machine architecture without the need to
 725             recompile. Packages are usually generated in
 726             <code class="filename">/usr/pkgsrc/packages</code>; there is also
 727             an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/NetBSD/packages/" target="_top">ftp.NetBSD.org</a>.</p>
 728 <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
 729             especially in the context of precompiled packages.</p>
 730 </dd>
 731 <dt><span class="term">Program</span></dt>
 732 <dd><p>The piece of software to be installed which will be
 733           constructed from all the files in the distfile by the
 734           actions defined in the corresponding package.</p></dd>
 735 </dl></div>
 736 <div class="sect2" title="1.3.1. Roles involved in pkgsrc">
 737 <div class="titlepage"><div><div><h3 class="title">
 738 <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
 739 <div class="variablelist"><dl>
 740 <dt><span class="term">pkgsrc users</span></dt>
 741 <dd>
 742 <p>The
 743         pkgsrc users are people who use the packages provided by pkgsrc.
 744         Typically they are system administrators. The people using the
 745         software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
 746         users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
 747 <p>There are two kinds of pkgsrc users: Some only want to
 748         install pre-built binary packages. Others build the pkgsrc
 749         packages from source, either for installing them directly or for
 750         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
 751         documentation.</p>
 752 </dd>
 753 <dt><span class="term">package maintainers</span></dt>
 754 <dd><p>A
 755         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>
 756 <dt><span class="term">infrastructure developers</span></dt>
 757 <dd><p>These people are involved in all those files
 758         that live in the <code class="filename">mk/</code> directory and below.
 759         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,
 760         too.</p></dd>
 761 </dl></div>
 762 </div>
 763 </div>
 764 <div class="sect1" title="1.4. Typography">
 765 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 766 <a name="typography"></a>1.4. Typography</h2></div></div></div>
 767 <p>When giving examples for commands, shell prompts are used to
 768       show if the command should/can be issued as root, or if
 769       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
 770       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
 771       shell prompt, assuming they use the C-shell or tcsh.</p>
 772 </div>
 773 </div>
 774 <div class="part" title="Part I. The pkgsrc user's guide">
 775 <div class="titlepage"><div><div><h1 class="title">
 776 <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
 777 <div class="toc">
 778 <p><b>Table of Contents</b></p>
 779 <dl>
 780 <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
 781 <dd><dl>
 782 <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
 783 <dd><dl>
 784 <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
 785 <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
 786 </dl></dd>
 787 <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
 788 <dd><dl>
 789 <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
 790 <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
 791 </dl></dd>
 792 </dl></dd>
 793 <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
 794 <dd><dl>
 795 <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
 796 <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
 797 <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
 798 <dd><dl>
 799 <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
 800 <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
 801 <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
 802 <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
 803 <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
 804 <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
 805 <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
 806 </dl></dd>
 807 </dl></dd>
 808 <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
 809 <dd><dl>
 810 <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
 811 <dd><dl>
 812 <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
 813 <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
 814 <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
 815 <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
 816 <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
 817 <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
 818 <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
 819 <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
 820 </dl></dd>
 821 <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
 822 <dd><dl>
 823 <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
 824 <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
 825 <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
 826 </dl></dd>
 827 </dl></dd>
 828 <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
 829 <dd><dl>
 830 <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
 831 <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
 832 <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
 833 <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
 834 <dd><dl>
 835 <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
 836 <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
 837 <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
 838 </dl></dd>
 839 <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
 840 <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
 841 </dl></dd>
 842 <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
 843 <dd><dl>
 844 <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
 845 <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
 846 </dl></dd>
 847 <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
 848 builds)</a></span></dt>
 849 <dd><dl>
 850 <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
 851 <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
 852 <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
 853 <dd><dl>
 854 <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
 855 <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
 856 <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
 857 <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
 858 <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
 859 <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
 860 <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
 861 <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
 862 </dl></dd>
 863 <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
 864 <dd><dl>
 865 <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
 866 <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
 867 </dl></dd>
 868 <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
 869 <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
 870 </dl></dd>
 871 <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
 872 <dd><dl>
 873 <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
 874 <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
 875 </dl></dd>
 876 <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
 877 <dd><dl>
 878 <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
 879 <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
 880 <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
 881 <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
 882 <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
 883 <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
 884 <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
 885 <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
 886 <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
 887 <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
 888 /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
 889 <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
 890 <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
 891 <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
 892 <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
 893 <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
 894 <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
 895 <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
 896 </dl></dd>
 897 </dl>
 898 </div>
 899 <div class="chapter" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">
 900 <div class="titlepage"><div><div><h2 class="title">
 901 <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
 902 <div class="toc">
 903 <p><b>Table of Contents</b></p>
 904 <dl>
 905 <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
 906 <dd><dl>
 907 <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
 908 <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. 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" title="2.1. Getting pkgsrc for the first time">
 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
 934         <code class="literal">2009Q1</code>.</p>
 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 or via CVS.
 937         Both ways are described here.</p>
 938 <div class="sect2" title="2.1.1. As tar file">
 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
 942         <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
 943         number of subdirectories for different purposes, which are
 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>
 945 <p>The tar file for the current branch is in the directory
 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>.
 947         It is autogenerated daily.</p>
 948 <p>The tar file for the stable branch 2009Q1 is in the
 949         directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
 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-20xxQy</code></em>/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz</code></strong></pre>
 953 <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
 954         stable branch to be downloaded, for example,
 955         <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span>.</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-20xxQy</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>
 963 </div>
 964 <div class="sect2" title="2.1.2. Via anonymous CVS">
 965 <div class="titlepage"><div><div><h3 class="title">
 966 <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
 967 <p>To fetch a specific pkgsrc stable branch, run:</p>
 968 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
 969 </pre>
 970 <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
 971         branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span></p>
 972 <p>This will create the directory <code class="filename">pkgsrc/</code>
 973         in your <code class="filename">/usr/</code> directory and all the package source
 974         will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
 975 <p>To fetch the pkgsrc current branch, run:</p>
 976 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
 977 </pre>
 978 <p>Refer to <a class="ulink" href="http://NetBSD.org/FIXME" target="_top">list of available CVS mirrors</a> to choose faster one.</p>
 979 <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
 980 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
 981 </pre>
 982 <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
 983         For Bourne shells, you can set it in your <code class="filename">.profile</code>
 984         or better globally in <code class="filename">/etc/profile</code>:</p>
 985 <pre class="programlisting">
 986 # set CVS remote shell command
 987 CVS_RSH=ssh
 988 export CVS_RSH
 989 </pre>
 990 <p>By default, CVS doesn't do things like most people would expect it to do.
 991         But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
 992         in your home directory and saving the following lines to it.
 993         This file will save you lots of headache and some bug reports, so we strongly recommend it.
 994         You can find an explanation of this file in the CVS documentation.</p>
 995 <pre class="programlisting">
 996 # recommended CVS configuration file from the pkgsrc guide
 997 cvs -q -z3
 998 checkout -P
 999 update -dP
1000 diff -upN
1001 rdiff -u
1002 release -d
1003 </pre>
1004 </div>
1005 </div>
1006 <div class="sect1" title="2.2. Keeping pkgsrc up-to-date">
1007 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1008 <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1009 <p>The preferred way to keep pkgsrc up-to-date is via CVS
1010         (which also works if you have first installed it via a tar
1011         file). It saves bandwidth and hard disk activity, compared to
1012         downloading the tar file again.</p>
1013 <div class="sect2" title="2.2.1. Via tar files">
1014 <div class="titlepage"><div><div><h3 class="title">
1015 <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1016 <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1017 <h3 class="title">Warning</h3>
1018 <p>When updating from a tar file, you first need to
1019         completely remove the old pkgsrc directory. Otherwise those
1020         files that have been removed from pkgsrc in the mean time will
1021         not be removed on your local disk, resulting in inconsistencies.
1022         When removing the old files, any changes that you have done to
1023         the pkgsrc files will be lost after updating. Therefore updating
1024         via CVS is strongly recommended.</p>
1025 </div>
1026 <p>Note that by default the distfiles and the binary packages
1027         are saved in the pkgsrc tree, so don't forget to rescue them
1028         before updating. You can also configure pkgsrc to use other than
1029         the default directories by setting the
1030         <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1031         variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1032 <p>To update pkgsrc from a tar file, download the tar file as
1033         explained above. Then, make sure that you have not made any
1034         changes to the files in the pkgsrc directory. Remove the pkgsrc
1035         directory and extract the new tar file. Done.</p>
1036 </div>
1037 <div class="sect2" title="2.2.2. Via CVS">
1038 <div class="titlepage"><div><div><h3 class="title">
1039 <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1040 <p>To update pkgsrc via CVS, make sure the environment
1041         variable <code class="varname">CVS_RSH</code> is set as above. Then,
1042         change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1043 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
1044 <code class="prompt">$</code> <strong class="userinput"><code>cvs update -dP</code></strong></pre>
1045 <div class="sect3" title="2.2.2.1. Switching between different pkgsrc branches">
1046 <div class="titlepage"><div><div><h4 class="title">
1047 <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1048 <p>When updating pkgsrc, the CVS program keeps track of the
1049         branch you selected. But if you, for whatever reason, want to
1050         switch from the stable branch to the current one, you can do it
1051         by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
1052         <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1053         back to the stable branch, add the
1054         <span class="quote">&#8220;<span class="quote">-rpkgsrc-2009Q3</span>&#8221;</span> option.</p>
1055 </div>
1056 <div class="sect3" title="2.2.2.2. What happens to my changes when updating?">
1057 <div class="titlepage"><div><div><h4 class="title">
1058 <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1059 <p>When you update pkgsrc, the CVS program will only touch
1060         those files that are registered in the CVS repository. That
1061         means that any packages that you created on your own will stay
1062         unmodified. If you change files that are managed by CVS, later
1063         updates will try to merge your changes with those that have been
1064         done by others. See the CVS manual, chapter
1065         <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1066 </div>
1067 </div>
1068 </div>
1069 </div>
1070 <div class="chapter" title="Chapter 3. Using pkgsrc on systems other than NetBSD">
1071 <div class="titlepage"><div><div><h2 class="title">
1072 <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1073 <div class="toc">
1074 <p><b>Table of Contents</b></p>
1075 <dl>
1076 <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1077 <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1078 <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1079 <dd><dl>
1080 <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1081 <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1082 <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1083 <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1084 <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1085 <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1086 <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1087 </dl></dd>
1088 </dl>
1089 </div>
1090 <div class="sect1" title="3.1. Binary distribution">
1091 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1092 <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1093 <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1094 </div>
1095 <div class="sect1" title="3.2. Bootstrapping pkgsrc">
1096 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1097 <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1098 <p>Installing the bootstrap kit from source should be as simple as:</p>
1099 <pre class="screen">
1100 <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1101 <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1102 <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1103     </pre>
1104 <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
1105     pkgsrc before bootstrapping. The given
1106     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1107     <code class="filename">/usr/pkg</code> for the
1108     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1109     and <code class="filename">/var/db/pkg</code> for the package database
1110     directory where pkgsrc will do its internal bookkeeping.
1111     However, these can also be set using command-line
1112     arguments.</p>
1113 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1114 <h3 class="title">Note</h3>
1115 <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1116       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1117       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1118       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1119 </div>
1120 </div>
1121 <div class="sect1" title="3.3. Platform-specific notes">
1122 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1123 <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1124 <p>Here are some platform-specific notes you should be aware of.</p>
1125 <div class="sect2" title="3.3.1. Darwin (Mac OS X)">
1126 <div class="titlepage"><div><div><h3 class="title">
1127 <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1128 <p>Darwin 5.x and up are supported. Before you start, you
1129       will need to download and install the Mac OS X Developer Tools
1130       from Apple's Developer Connection. See
1131       <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1132       for details.  Also, make sure you install X11 (an optional
1133       package included with the Developer Tools) if you intend to
1134       build packages that use the X11 Window System.</p>
1135 </div>
1136 <div class="sect2" title="3.3.2. FreeBSD">
1137 <div class="titlepage"><div><div><h3 class="title">
1138 <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1139 <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1140       other versions may work.</p>
1141 <p>Care should be taken so that the tools that this kit installs do not conflict
1142       with the FreeBSD userland tools. There are several steps:</p>
1143 <div class="orderedlist"><ol class="orderedlist" type="1">
1144 <li class="listitem"><p>FreeBSD stores its ports pkg database in
1145           <code class="filename">/var/db/pkg</code>. It is therefore
1146           recommended that you choose a different location (e.g.
1147           <code class="filename">/usr/pkgdb</code>) by
1148           using the --pkgdbdir option to the bootstrap script.</p></li>
1149 <li class="listitem">
1150 <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1151           good idea to move them out of the way to avoid confusion, e.g.</p>
1152 <pre class="screen">
1153 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1154 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1155 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1156 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1157 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1158           </pre>
1159 </li>
1160 <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1161           <code class="filename">/etc/mk.conf.example</code> file
1162           when you use the bootstrap script.</p></li>
1163 </ol></div>
1164 </div>
1165 <div class="sect2" title="3.3.3. Interix">
1166 <div class="titlepage"><div><div><h3 class="title">
1167 <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1168 <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1169       providing a Unix-like environment with a tighter kernel integration than
1170       available with Cygwin.  It is part of the Windows Services for Unix
1171       package, available for free for any licensed copy of Windows 2000, XP
1172       (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>
1173 <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
1174       are not officially supported.  (The main difference in 3.0/3.1 is lack
1175       of pthreads, but other parts of libc may also be lacking.)</p>
1176 <p>Services for Unix Applications (aka SUA) is an integrated
1177       component of Windows Server 2003 R2 (5.2), Windows Vista and
1178       Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1179       (6.1).  As of this writing, the SUA's Interix 6.0 (32bit) and
1180       6.1 (64bit) subsystems have been tested.  Other versions may
1181       work as well. The Interix 5.x subsystem has not yet been tested
1182       with pkgsrc.</p>
1183 <div class="sect3" title="3.3.3.1. When installing Interix/SFU">
1184 <div class="titlepage"><div><div><h4 class="title">
1185 <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1186 <p>At an absolute minimum, the following packages must be installed from
1187         the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1188 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1189 <li class="listitem"><p>Utilities -&gt; Base Utilities</p></li>
1190 <li class="listitem"><p>Interix GNU Components -&gt; (all)</p></li>
1191 <li class="listitem"><p>Remote Connectivity</p></li>
1192 <li class="listitem"><p>Interix SDK</p></li>
1193 </ul></div>
1194 <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1195         "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
1196         /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1197         pkgsrc (or from a binary package).</p>
1198 <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1199         not need to be installed, but Remote Connectivity itself should be
1200         installed in order to have a working inetd.</p>
1201 <p>During installation you may be asked whether to enable setuid
1202         behavior for Interix programs, and whether to make pathnames default to
1203         case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
1204         enabled.  (Without case-sensitivity, a large number of packages including
1205         perl will not build.)</p>
1206 <p>NOTE:  Newer Windows service packs change the way binary execution
1207         works (via the Data Execution Prevention feature).  In order to use
1208         pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1209         POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1210         must be installed.  Hotfixes are available from Microsoft through a
1211         support contract; however, Debian Interix Port has made most Interix
1212         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>
1213 <p>In addition to the hotfix noted above, it may be necessary to
1214         disable Data Execution Prevention entirely to make Interix functional.
1215         This may happen only with certain types of CPUs; the cause is not fully
1216         understood at this time.  If gcc or other applications still segfault
1217         repeatedly after installing one of the hotfixes note above, the
1218         following option can be added to the appropriate "boot.ini" line on the
1219         Windows boot drive:  /NoExecute=AlwaysOff
1220         (WARNING, this will disable DEP completely, which may be a security
1221         risk if applications are often run as a user in the Administrators
1222         group!)</p>
1223 </div>
1224 <div class="sect3" title="3.3.3.2. What to do if Interix/SFU is already installed">
1225 <div class="titlepage"><div><div><h4 class="title">
1226 <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1227 <p>If SFU is already installed and you wish to alter these settings to work
1228         with pkgsrc, note the following things.</p>
1229 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1230 <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1231             Windows Services for UNIX, then click Change.  In the installer, choose
1232             Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1233 <li class="listitem">
1234 <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1235             change the following registry key:</p>
1236 <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1237 <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1238 </li>
1239 <li class="listitem">
1240 <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1241             following registry key:</p>
1242 <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1243 <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1244 </li>
1245 </ul></div>
1246 </div>
1247 <div class="sect3" title="3.3.3.3. Important notes for using pkgsrc">
1248 <div class="titlepage"><div><div><h4 class="title">
1249 <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1250 <p>The package manager (either the pkgsrc "su" user, or the user
1251         running "pkg_add") must be a member of the local Administrators
1252         group.  Such a user must also be used to run the bootstrap.  This is
1253         slightly relaxed from the normal pkgsrc requirement of "root".</p>
1254 <p>The package manager should use a umask of 002.  "make install" will
1255         automatically complain if this is not the case.  This ensures that
1256         directories written in /var/db/pkg are Administrators-group writeable.</p>
1257 <p>The popular Interix binary packages from http://www.interopsystems.com/
1258         use an older version of pkgsrc's pkg_* tools.  Ideally, these should
1259         NOT be used in conjunction with pkgsrc.  If you choose to use them at
1260         the same time as the pkgsrc packages, ensure that you use the proper
1261         pkg_* tools for each type of binary package.</p>
1262 <p>The TERM setting used for DOS-type console windows (including those
1263         invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
1264         don't have a termcap/terminfo entry for it, but the following .termcap
1265         entry provides adequate emulation in most cases:</p>
1266 <pre class="programlisting">
1267 interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1268         </pre>
1269 </div>
1270 <div class="sect3" title="3.3.3.4. Limitations of the Interix platform">
1271 <div class="titlepage"><div><div><h4 class="title">
1272 <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1273 <p>Though Interix suffices as a familiar and flexible substitute
1274         for a full Unix-like platform, it has some drawbacks that should
1275         be noted for those desiring to make the most of Interix.</p>
1276 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1277 <li class="listitem">
1278 <p><span class="strong"><strong>X11:</strong></span></p>
1279 <p>Interix comes with the standard set of X11R6 client libraries,
1280           and can run X11 based applications, but it does
1281           <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1282           <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1283           <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1284           (available in a trimmed version for Interix from Interop Systems as the
1285           <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1286           and the free X11 server included with
1287           <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1288 </li>
1289 <li class="listitem">
1290 <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1291 <p>Because Interix runs in a completely different NT subsystem from
1292           Win32 applications, it does not currently support various X11
1293           protocol extensions for acceleration (such as MIT-SHM or DGA).
1294           Most interactive applications to a local X server will run
1295           reasonably fast, but full motion video and other graphics
1296           intensive applications may require a faster-than-expected CPU.</p>
1297 </li>
1298 <li class="listitem">
1299 <p><span class="strong"><strong>Audio:</strong></span></p>
1300 <p>Interix has no native support for audio output.  For audio
1301           support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1302           audio system on Interix.  Unlike on most platforms, the
1303           <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
1304           <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1305           server component.  To output audio via an Interix host, the
1306           <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
1307           must also be installed.</p>
1308 </li>
1309 <li class="listitem">
1310 <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1311 <p>Direct device access is not currently supported in Interix, so it
1312           is not currently possible to access CD/DVD drives, USB devices,
1313           or SCSI devices through non-filesystem means.  Among other things,
1314           this makes it impossible to use Interix directly for CD/DVD
1315           burning.</p>
1316 </li>
1317 <li class="listitem">
1318 <p><span class="strong"><strong>Tape drives:</strong></span></p>
1319 <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1320           drives are also not directly accessible in Interix.  However,
1321           support is in work to make tape drive access possible by using
1322           Cygwin as a bridge (similarly to audio bridged via Cygwin's
1323           esound server).</p>
1324 </li>
1325 </ul></div>
1326 </div>
1327 <div class="sect3" title="3.3.3.5. Known issues for pkgsrc on Interix">
1328 <div class="titlepage"><div><div><h4 class="title">
1329 <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1330 <p>It is not necessary, in general, to have a "root" user on the
1331         Windows system; any member of the local Administrators group will
1332         suffice.  However, some packages currently assume that the user
1333         named "root" is the privileged user.  To accommodate these, you
1334         may create such a user; make sure it is in the local group
1335         Administrators (or your language equivalent).</p>
1336 <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1337         0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
1338         time being, install packages as the local Administrator (or
1339         your language equivalent), or run the following command after
1340         installing a package to work around the issue:</p>
1341 <pre class="screen">
1342 <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1343         </pre>
1344 </div>
1345 </div>
1346 <div class="sect2" title="3.3.4. IRIX">
1347 <div class="titlepage"><div><div><h3 class="title">
1348 <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1349 <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1350       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
1351       according to your preference.  If you do not have a license for the MIPSpro
1352       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>
1353 <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1354       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>,
1355       etc.</p>
1356 <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1357         switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
1358         you start out using "abi=n32", that's what all your packages will be built
1359         with.</p>
1360 <p>Therefore, please make sure that you have no conflicting
1361       <code class="varname">CFLAGS</code> in your environment or the
1362       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1363       try to link n32 object files with lib64 or vice versa.  Check your
1364       <code class="filename">/etc/compiler.defaults</code>!</p>
1365 <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1366       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1367       as it appears that IRIX linker occasionally runs into issues when trying to
1368       link over a network-mounted file system.</p>
1369 <p>The bootstrapping process should set all the right options for programs such
1370       as imake(1), but you may want to set some options depending on your local
1371       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1372       course, your compiler's man pages for details.</p>
1373 <p>If you are using SGI's MIPSPro compiler, please set
1374
1375       </p>
1376 <pre class="programlisting">
1377 PKGSRC_COMPILER=        mipspro
1378       </pre>
1379 <p>
1380
1381       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1382       are using gcc and may end up passing invalid flags to the compiler.  Note that
1383       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1384       default.</p>
1385 <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1386       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1387       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1388       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1389       '--preserve-path' flag.</p>
1390 </div>
1391 <div class="sect2" title="3.3.5. Linux">
1392 <div class="titlepage"><div><div><h3 class="title">
1393 <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1394 <p>Some versions of Linux (for example Debian GNU/Linux) need
1395       either libtermcap or libcurses (libncurses).  Installing the
1396       distributions libncurses-dev package (or equivalent) should fix
1397       the problem.</p>
1398 <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1399       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1400       i386 have been tested.</p>
1401 <p>To bootstrap using icc, assuming the default icc installation
1402       directory:</p>
1403 <pre class="programlisting">
1404 env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1405 ac_cv___attribute__=yes ./bootstrap
1406       </pre>
1407 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1408 <h3 class="title">Note</h3>
1409 <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1410 </div>
1411 <p>icc supports __attribute__, but the GNU configure test uses a nested
1412       function, which icc does not support. #undef'ing __attribute__ has the
1413       unfortunate side-effect of breaking many of the Linux header files, which
1414       cannot be compiled properly without __attribute__. The test must be
1415       overridden so that __attribute__ is assumed supported by the
1416       compiler.</p>
1417 <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1418       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1419 <pre class="programlisting">
1420 PKGSRC_COMPILER=        icc
1421       </pre>
1422 <p>The default installation directory for icc is
1423       <code class="filename">/opt/intel_cc_80</code>, which
1424       is also the pkgsrc default. If you have installed it into a different
1425       directory, set <code class="varname">ICCBASE</code> in
1426       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1427 <pre class="programlisting">
1428 ICCBASE=                /opt/icc
1429       </pre>
1430 <p>pkgsrc uses the static linking method of the runtime libraries
1431       provided by icc, so binaries can be run on other systems which do not
1432       have the shared libraries installed.</p>
1433 <p>Libtool, however, extracts a list of libraries from the
1434       <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
1435       records it, throwing away the -Bstatic and -Bdynamic options
1436       interspersed between the libraries.  This means that
1437       libtool-linked C++ shared libraries will have a runtime
1438       dependency on the icc libraries until this is fixed in
1439       libtool.</p>
1440 </div>
1441 <div class="sect2" title="3.3.6. OpenBSD">
1442 <div class="titlepage"><div><div><h3 class="title">
1443 <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1444 <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1445 <p>Care should be taken so that the tools that this kit installs do not conflict
1446       with the OpenBSD userland tools. There are several steps:</p>
1447 <div class="orderedlist"><ol class="orderedlist" type="1">
1448 <li class="listitem"><p>OpenBSD stores its ports pkg database in
1449           <code class="filename">/var/db/pkg</code>. It is therefore
1450           recommended that you choose a different location (e.g.
1451           <code class="filename">/usr/pkgdb</code>) by
1452           using the --pkgdbdir option to the bootstrap script.</p></li>
1453 <li class="listitem">
1454 <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1455           good idea to move them out of the way to avoid confusion, e.g.</p>
1456 <pre class="screen">
1457 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1458 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1459 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1460 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1461 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1462           </pre>
1463 </li>
1464 <li class="listitem">
1465 <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1466           <code class="filename">/etc/mk.conf.example</code> file
1467           when you use the bootstrap script. OpenBSD's make program uses
1468           <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1469           as well. You can work around this by enclosing all the pkgsrc-specific parts
1470           of the file with:</p>
1471 <pre class="programlisting">
1472 .ifdef BSD_PKG_MK
1473 # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1474 .else
1475 # OpenBSD stuff
1476 .endif
1477           </pre>
1478 </li>
1479 </ol></div>
1480 </div>
1481 <div class="sect2" title="3.3.7. Solaris">
1482 <div class="titlepage"><div><div><h3 class="title">
1483 <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1484 <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1485       You will need a working C compiler. Both gcc 2.95.3 and
1486       Sun WorkShop 5 have been tested.</p>
1487 <p>The following packages are required on Solaris 8 for the bootstrap
1488       process and to build packages.</p>
1489 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1490 <li class="listitem"><p>SUNWsprot</p></li>
1491 <li class="listitem"><p>SUNWarc</p></li>
1492 <li class="listitem"><p>SUNWbtool</p></li>
1493 <li class="listitem"><p>SUNWtoo</p></li>
1494 <li class="listitem"><p>SUNWlibm</p></li>
1495 </ul></div>
1496 <p>Please note that the use of GNU binutils on Solaris is
1497       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1498 <p>Whichever compiler you use, please ensure the compiler tools and
1499       your $prefix are in your <code class="varname">PATH</code>. This includes
1500       <code class="filename">/usr/ccs/{bin,lib}</code>
1501       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1502 <div class="sect3" title="3.3.7.1. If you are using gcc">
1503 <div class="titlepage"><div><div><h4 class="title">
1504 <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1505 <p>It makes life much simpler if you only use the same gcc consistently
1506         for building all packages.</p>
1507 <p>It is recommended that an external gcc be used only for bootstrapping,
1508         then either build gcc from
1509         <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
1510         package, then remove gcc used during bootstrapping.</p>
1511 <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>
1512 </div>
1513 <div class="sect3" title="3.3.7.2. If you are using Sun WorkShop">
1514 <div class="titlepage"><div><div><h4 class="title">
1515 <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1516 <p>You will need at least the following packages installed (from WorkShop
1517         5.0)</p>
1518 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1519 <li class="listitem"><p>SPROcc
1520           - Sun WorkShop Compiler C 5.0</p></li>
1521 <li class="listitem"><p>SPROcpl
1522           - Sun WorkShop Compiler C++ 5.0</p></li>
1523 <li class="listitem"><p>SPROild
1524           - Sun WorkShop Incremental Linker</p></li>
1525 <li class="listitem"><p>SPROlang
1526           - Sun WorkShop Compilers common components</p></li>
1527 </ul></div>
1528 <p>You should set the following variables in your
1529         <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1530 <pre class="programlisting">
1531 CC=     cc
1532 CXX=    CC
1533 CPP=    cc -E
1534 CXXCPP= CC -E
1535 </pre>
1536 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1537 <h3 class="title">Note</h3>
1538 <p>The <code class="varname">CPP</code> setting might break some
1539         packages that use the C preprocessor for processing things other
1540         than C source code.</p>
1541 </div>
1542 </div>
1543 <div class="sect3" title="3.3.7.3. Building 64-bit binaries with SunPro">
1544 <div class="titlepage"><div><div><h4 class="title">
1545 <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1546 <p>To build 64-bit packages, you just need to have the
1547         following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1548 <pre class="programlisting">
1549 PKGSRC_COMPILER=        sunpro
1550 ABI=                    64
1551 </pre>
1552 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1553 <h3 class="title">Note</h3>
1554 <p>This setting has been tested for the SPARC
1555         architecture. Intel and AMD machines need some more
1556         work.</p>
1557 </div>
1558 </div>
1559 <div class="sect3" title="3.3.7.4. Common problems">
1560 <div class="titlepage"><div><div><h4 class="title">
1561 <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1562 <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1563       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1564       The workaround is to use another shell for the configure
1565       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
1566       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1567 <pre class="programlisting">
1568 CONFIG_SHELL=   ${LOCALBASE}/bin/bash
1569 WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1570       </pre>
1571 <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>
1572 </div>
1573 </div>
1574 </div>
1575 </div>
1576 <div class="chapter" title="Chapter 4. Using pkgsrc">
1577 <div class="titlepage"><div><div><h2 class="title">
1578 <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1579 <div class="toc">
1580 <p><b>Table of Contents</b></p>
1581 <dl>
1582 <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1583 <dd><dl>
1584 <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1585 <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1586 <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1587 <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1588 <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1589 <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>
1590 <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1591 <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1592 </dl></dd>
1593 <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1594 <dd><dl>
1595 <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1596 <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1597 <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1598 </dl></dd>
1599 </dl>
1600 </div>
1601 <p>Basically, there are two ways of using pkgsrc. The first
1602 is to only install the package tools and to use binary packages
1603 that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
1604 in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1605 of pkgsrc, too. Then you are able to build your own packages,
1606 and you can still use binary packages from someone else.</p>
1607 <div class="sect1" title="4.1. Using binary packages">
1608 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1609 <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1610 <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1611   server and its mirrors, there are collections of binary packages,
1612   ready to be installed. These binary packages have been built using the
1613   default settings for the directories, that is:</p>
1614 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1615 <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
1616 <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1617 <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1618 </ul></div>
1619 <p>If you cannot use these directories for whatever reasons (maybe
1620   because you're not root), you cannot use these binary packages, but
1621   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>
1622 <div class="sect2" title="4.1.1. Finding binary packages">
1623 <div class="titlepage"><div><div><h3 class="title">
1624 <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1625 <p>To install binary packages, you first need to know from where
1626     to get them. The first place where you should look is on the main
1627     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>
1628 <p>This directory contains binary packages for multiple
1629     platforms. First, select your operating system. (Ignore the
1630     directories with version numbers attached to it, they just exist for
1631     legacy reasons.) Then, select your hardware architecture, and in the
1632     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1633 <p>In this directory, you often find a file called
1634     <code class="filename">bootstrap.tar.gz</code> which contains the package
1635     management tools. If the file is missing, it is likely that your
1636     operating system already provides those tools. Download the file and
1637     extract it in the <code class="filename">/</code> directory. It will create
1638     the directories <code class="filename">/usr/pkg</code> (containing the tools
1639     for managing binary packages) and <code class="filename">/var/db/pkg</code>
1640     (the database of installed packages).</p>
1641 </div>
1642 <div class="sect2" title="4.1.2. Installing binary packages">
1643 <div class="titlepage"><div><div><h3 class="title">
1644 <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1645 <p>In the directory from the last section, there is a
1646     subdirectory called <code class="filename">All</code>, which contains all the
1647     binary packages that are available for the platform, excluding those
1648     that may not be distributed via FTP or CDROM (depending on which
1649     medium you are using).</p>
1650 <p>To install packages directly from an FTP or HTTP server, run
1651     the following commands in a Bourne-compatible shell (be sure to
1652     <span class="command"><strong>su</strong></span> to root first):</p>
1653 <pre class="screen">
1654 <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1655 <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>
1656 <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1657 </pre>
1658 <p>Instead of URLs, you can also use local paths, for example if
1659     you are installing from a set of CDROMs, DVDs or an NFS-mounted
1660     repository. If you want to install packages from multiple sources,
1661     you can separate them by a semicolon in
1662     <code class="varname">PKG_PATH</code>.</p>
1663 <p>After these preparations, installing a package is very
1664     easy:</p>
1665 <pre class="screen">
1666 <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1667 <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1668 <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1669 </pre>
1670 <p>Note that any prerequisite packages needed to run the
1671     package in question will be installed, too, assuming they are
1672     present where you install from.</p>
1673 <p>Adding packages might install vulnerable packages.
1674     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1675     regularly, especially after installing new packages, and verify
1676     that the vulnerabilities are acceptable for your configuration.</p>
1677 <p>After you've installed packages, be sure to have
1678     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1679     <code class="varname">PATH</code> so you can actually start the just
1680     installed program.</p>
1681 </div>
1682 <div class="sect2" title="4.1.3. Deinstalling packages">
1683 <div class="titlepage"><div><div><h3 class="title">
1684 <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1685 <p>To deinstall a package, it does not matter whether it was
1686     installed from source code or from a binary package. The
1687     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1688     To delete a package, you can just run <span class="command"><strong>pkg_delete
1689     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1690     name can be given with or without version number. Wildcards can
1691     also be used to deinstall a set of packages, for example
1692     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1693     so that the shell does not expand them before
1694     <code class="literal">pkg_delete</code> sees them.</p>
1695 <p>The <code class="option">-r</code> option is very powerful: it
1696     removes all the packages that require the package in question
1697     and then removes the package itself. For example:
1698
1699     </p>
1700 <pre class="screen">
1701 <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1702     </pre>
1703 <p>
1704
1705     will remove jpeg and all the packages that used it; this allows
1706     upgrading the jpeg package.</p>
1707 </div>
1708 <div class="sect2" title="4.1.4. Getting information about installed packages">
1709 <div class="titlepage"><div><div><h3 class="title">
1710 <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1711 <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1712     installed packages or binary package files.</p>
1713 </div>
1714 <div class="sect2" title="4.1.5. Checking for security vulnerabilities in installed packages">
1715 <div class="titlepage"><div><div><h3 class="title">
1716 <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1717 <p>
1718       The NetBSD Security-Officer and Packages Groups maintain a list of
1719       known security vulnerabilities to packages which are (or have been)
1720       included in pkgsrc.  The list is available from the NetBSD
1721       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>.
1722     </p>
1723 <p>
1724       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1725       this list can be downloaded
1726       automatically, and a security audit of all packages installed on a system
1727       can take place.
1728     </p>
1729 <p>
1730       There are two components to auditing.  The first
1731       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1732       is for downloading
1733       the list of vulnerabilities from the NetBSD FTP site.  The second
1734       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1735       installed packages are vulnerable.  If a package is vulnerable, you
1736       will see output similar to the following:
1737     </p>
1738 <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1739     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1740 <p>
1741       You may wish to have the
1742       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1743       file downloaded daily so that
1744       it remains current.  This may be done by adding an appropriate entry
1745       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1746       </p>
1747 <pre class="screen">
1748 # download vulnerabilities file
1749 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1750       </pre>
1751 <p>
1752       will update the vulnerability list every day at 3AM. You may wish to do
1753       this more often than once a day.
1754
1755       In addition, you may wish to run the package audit from the daily
1756       security script.  This may be accomplished by adding the following
1757       line to <code class="filename">/etc/security.local</code>:
1758       </p>
1759 <pre class="screen">
1760 /usr/sbin/pkg_admin audit
1761       </pre>
1762 <p>
1763     </p>
1764 </div>
1765 <div class="sect2" title="4.1.6. Finding if newer versions of your installed packages are in pkgsrc">
1766 <div class="titlepage"><div><div><h3 class="title">
1767 <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1768 <p>
1769       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
1770       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1771       argument to check if your packages are up-to-date, e.g.
1772     </p>
1773 <pre class="screen">
1774 <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1775 ...
1776 Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1777     </pre>
1778 <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1779     package on your system and rebuild any dependencies.
1780     </p>
1781 </div>
1782 <div class="sect2" title="4.1.7. Other administrative functions">
1783 <div class="titlepage"><div><div><h3 class="title">
1784 <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1785 <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1786     administrative functions on the package system.</p>
1787 </div>
1788 <div class="sect2" title="4.1.8. A word of warning">
1789 <div class="titlepage"><div><div><h3 class="title">
1790 <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1791 <p>Please pay very careful attention to the warnings
1792     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
1793     inherent dangers of installing binary packages which you did
1794     not create yourself, and the security holes that can be
1795     introduced onto your system by indiscriminate adding of such
1796     files.</p>
1797 <p>The same warning of course applies to every package you
1798     install from source when you haven't completely read and
1799     understood the source code of the package, the compiler that
1800     is used to build the package and all the other tools that are
1801     involved.</p>
1802 </div>
1803 </div>
1804 <div class="sect1" title="4.2. Building packages from source">
1805 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1806 <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1807 <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1808   directory now contains a set of packages, organized into
1809   categories. You can browse the online index of packages, or run
1810   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1811   directory to build local <code class="filename">README.html</code> files for
1812   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>
1813 <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1814   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1815   should do so by setting <code class="varname">LOCALBASE</code> in
1816   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1817   different <code class="varname">LOCALBASE</code> definitions on the same
1818   system (inside a chroot is an exception). </p>
1819 <p>The rest of this chapter assumes that the package is already
1820   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
1821   instructions how to create your own packages.</p>
1822 <div class="sect2" title="4.2.1. Requirements">
1823 <div class="titlepage"><div><div><h3 class="title">
1824 <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1825 <p>To build packages from source, you need a working C
1826     compiler. On NetBSD, you need to install the
1827     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1828     sets. If you want to build X11-related packages, the
1829     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1830     sets are required, too.</p>
1831 </div>
1832 <div class="sect2" title="4.2.2. Fetching distfiles">
1833 <div class="titlepage"><div><div><h3 class="title">
1834 <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1835 <p>The first step for building a package is downloading the
1836     distfiles (i.e. the unmodified source). If they have not yet been
1837     downloaded, pkgsrc will fetch them automatically.</p>
1838 <p>If you have all files that you need in the
1839     <code class="filename">distfiles</code> directory,
1840     you don't need to connect. If the distfiles are on CD-ROM, you can
1841     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1842     </p>
1843 <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1844 <p>
1845     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1846 <p>By default a list of distribution sites will be randomly
1847     intermixed to prevent huge load on servers which holding popular
1848     packages (for example, SourceForge.net mirrors). Thus, every
1849     time when you need to fetch yet another distfile all the mirrors
1850     will be tried in new (random) order. You can turn this feature
1851     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1852     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1853 <p>You can overwrite some of the major distribution sites to
1854     fit to sites that are close to your own.  By setting one or two
1855     variables you can modify the order in which the master sites are
1856     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
1857     delimited list of domain suffixes.
1858     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1859     contains a whitespace delimited list of regular expressions.  It
1860     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
1861     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1862     some examples.  This may save some of your bandwidth and
1863     time.</p>
1864 <p>You can change these settings either in your shell's environment, or,
1865     if you want to keep the settings, by editing the
1866     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1867     and adding the definitions there.</p>
1868 <p>
1869       If a package depends on many other packages (such as
1870       <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
1871       alternate between periods of
1872       downloading source, and compiling. To ensure you have all the source
1873       downloaded initially you can run the command:
1874       </p>
1875 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1876 <p>
1877       which will output and run a set of shell commands to fetch the
1878       necessary files into the <code class="filename">distfiles</code> directory.  You can
1879       also choose to download the files manually.
1880     </p>
1881 </div>
1882 <div class="sect2" title="4.2.3. How to build and install">
1883 <div class="titlepage"><div><div><h3 class="title">
1884 <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1885 <p>
1886       Once the software has downloaded, any patches will be applied, then it
1887       will be compiled for you. This may take some time depending on your
1888       computer, and how many other packages the software depends on and their
1889       compile time.
1890     </p>
1891 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1892 <h3 class="title">Note</h3>
1893 <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1894     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1895     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1896 </div>
1897 <p>For example, type</p>
1898 <pre class="screen">
1899 <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1900 <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1901     </pre>
1902 <p>at the shell prompt to build the various components of the
1903     package.</p>
1904 <p>The next stage is to actually install the newly compiled
1905     program onto your system. Do this by entering:
1906
1907     </p>
1908 <pre class="screen">
1909 <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1910     </pre>
1911 <p>
1912
1913     while you are still in the directory for whatever package you
1914     are installing.</p>
1915 <p>Installing the package on your system may require you to
1916     be root.  However, pkgsrc has a
1917     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1918     to only become root for the actual installation step.</p>
1919 <p>That's it, the software should now be installed and setup for use.
1920     You can now enter:
1921
1922     </p>
1923 <pre class="screen">
1924 <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1925     </pre>
1926 <p>
1927
1928     to remove the compiled files in the work directory, as you shouldn't need
1929     them any more. If other packages were also added to your system
1930     (dependencies) to allow your program to compile, you can tidy these up
1931     also with the command:</p>
1932 <pre class="screen">
1933 <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1934     </pre>
1935 <p>Taking the figlet utility as an example, we can install it on our
1936     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1937 <p>The program is installed under the default root of the
1938     packages tree - <code class="filename">/usr/pkg</code>. Should this not
1939     conform to your tastes, set the <code class="varname">LOCALBASE</code>
1940     variable in your environment, and it will use that value as the
1941     root of your packages tree. So, to use
1942     <code class="filename">/usr/local</code>, set
1943     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1944     Please note that you should use a directory which is dedicated to
1945     packages and not shared with other programs (i.e., do not try and
1946     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
1947     to add any of your own files or directories (such as
1948     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1949     <code class="filename">pkgsrc/</code>) below the
1950     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
1951     conflicts between programs and other files installed by the
1952     package system and whatever else may have been installed
1953     there.</p>
1954 <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1955     alter some configuration options at build time.  Have a look at
1956     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1957     of what will be set there by default.  Environment variables such
1958     as <code class="varname">LOCALBASE</code> can be set in
1959     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1960     set them each time you want to use pkgsrc.</p>
1961 <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
1962     covers</span>&#8221;</span> to see what is going on when a package is building
1963     or being installed. This may be for debugging purposes, or out of
1964     simple curiosity. A number of utility values have been added to
1965     help with this.</p>
1966 <div class="orderedlist"><ol class="orderedlist" type="1">
1967 <li class="listitem">
1968 <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
1969         <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1970         information will be displayed. For example,</p>
1971 <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1972 <p>will show all the commands that are invoked, up to and
1973         including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1974 </li>
1975 <li class="listitem">
1976 <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>
1977         definition, then the <code class="varname">VARNAME</code> definition
1978         should be used, in conjunction with the show-var
1979         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>
1980         variable <code class="varname">LOCALBASE</code>:</p>
1981 <pre class="screen">
1982 <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1983 /usr/pkg
1984 <code class="prompt">%</code>
1985         </pre>
1986 </li>
1987 </ol></div>
1988 <p>If you want to install a binary package that you've either
1989     created yourself (see next section), that you put into
1990     pkgsrc/packages manually or that is located on a remote FTP
1991     server, you can use the "bin-install" target. This target will
1992     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>,
1993     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1994     sites searched is kept in the variable
1995     <code class="varname">BINPKG_SITES</code>, which defaults to
1996     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>
1997     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
1998     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
1999     details.</p>
2000 <p>A final word of warning: If you set up a system that has a
2001     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2002     set that before any packages are installed, as you cannot use
2003     several directories for the same purpose. Doing so will result in
2004     pkgsrc not being able to properly detect your installed packages,
2005     and fail miserably. Note also that precompiled binary packages are
2006     usually built with the default <code class="varname">LOCALBASE</code> of
2007     <code class="filename">/usr/pkg</code>, and that you should
2008     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2009     <code class="varname">LOCALBASE</code>.</p>
2010 </div>
2011 </div>
2012 </div>
2013 <div class="chapter" title="Chapter 5. Configuring pkgsrc">
2014 <div class="titlepage"><div><div><h2 class="title">
2015 <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2016 <div class="toc">
2017 <p><b>Table of Contents</b></p>
2018 <dl>
2019 <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2020 <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
2021 <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
2022 <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
2023 <dd><dl>
2024 <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
2025 <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2026 <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
2027 </dl></dd>
2028 <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2029 <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
2030 </dl>
2031 </div>
2032 <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
2033 called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2034 that file depends on the installation. On NetBSD, when you use
2035 <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
2036 <code class="filename">/etc/</code>. In all other cases the default location is
2037 <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2038 bootstrap program to install the binary packages.</p>
2039 <p>During the bootstrap, an example configuration file is created. To
2040 use that, you have to create the directory
2041 <code class="filename">${PREFIX}/etc</code> and copy the example file
2042 there.</p>
2043 <p>The format of the configuration file is that of the usual
2044 BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2045 is done by setting variables in this file. Note that you can define all
2046 kinds of variables, and no special error checking (for example for
2047 spelling mistakes) takes place, so you have to try it out to see if it
2048 works.</p>
2049 <div class="sect1" title="5.1. General configuration">
2050 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2051 <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2052 <p>In this section, you can find some variables that apply to all
2053     pkgsrc packages. A complete list of the variables that can be
2054     configured by the user is available in
2055     <code class="filename">mk/defaults/mk.conf</code>, together with some
2056     comments that describe each variable's intent.</p>
2057 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2058 <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
2059             packages will be installed. The default is
2060             <code class="filename">/usr/pkg</code>. Do not mix binary packages
2061             with different <code class="varname">LOCALBASE</code>s!</p></li>
2062 <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2063             <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
2064             installed. The default is
2065             <code class="filename">${LOCALBASE}/cross</code>.</p></li>
2066 <li class="listitem"><p><code class="varname">X11BASE</code>: Where
2067             X11 is installed on the system. The default is
2068             <code class="filename">/usr/X11R6</code>.</p></li>
2069 <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
2070             downloaded copies of the original source distributions used
2071             for building pkgsrc packages. The default is
2072             <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
2073 <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
2074             database about installed packages is stored.  The default is
2075             <code class="filename">/var/db/pkg</code>.</p></li>
2076 <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2077             If set, override the packages'
2078             <code class="varname">MASTER_SITES</code> with this value.</p></li>
2079 <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
2080             Backup location(s) for distribution files and patch files
2081             if not found locally or in
2082             <code class="filename">${MASTER_SITES}</code> or
2083             <code class="filename">${PATCH_SITES}</code> respectively.
2084             The defaults are
2085             <code class="filename">ftp://ftp.NetBSD.org/pub/NetBSD/packages/distfiles/${DIST_SUBDIR}/</code>
2086             and
2087             <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
2088 <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
2089             List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2090             <em class="replaceable"><code>arch</code></em> are replaced with OS
2091             release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
2092             (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
2093 <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2094             List of acceptable licenses. License names are case-sensitive.
2095             Whenever you try to build a package whose license is not in this
2096             list, you will get an error message. If the license condition is
2097             simple enough, the error message will include specific
2098             instructions on how to change this variable.</p></li>
2099 </ul></div>
2100 </div>
2101 <div class="sect1" title="5.2. Variables affecting the build process">
2102 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2103 <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2104 <p>XXX
2105       </p>
2106 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2107 <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
2108             directory for the binary packages. The default is
2109             <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
2110 <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
2111             The top level directory where, if defined, the separate
2112             working directories will get created, and symbolically
2113             linked to from <code class="filename">${WRKDIR}</code> (see below).
2114             This is useful for building packages on several
2115             architectures, then <code class="filename">${PKGSRCDIR}</code>
2116             can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2117             is local to every architecture. (It should be noted that
2118             <code class="varname">PKGSRCDIR</code> should not be set by the user
2119             &mdash; it is an internal definition which refers to the
2120             root of the pkgsrc tree. It is possible to have many
2121             pkgsrc tree instances.)</p></li>
2122 <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
2123             Directory for local patches that aren't part of pkgsrc.
2124             See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
2125             information.</p></li>
2126 <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
2127             the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
2128             BSD-style Makefile. If this is not set,
2129             <code class="varname">MAKECONF</code> is set to
2130             <code class="filename">/dev/null</code> to avoid picking up
2131             settings used by builds in <code class="filename">/usr/src</code>.</p></li>
2132 <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
2133             By default, dependencies are only installed, and no binary
2134             package is created for them. You can set this variable to
2135             <code class="literal">package</code> to automatically create binary
2136             packages after installing dependencies.</p></li>
2137 </ul></div>
2138 </div>
2139 <div class="sect1" title="5.3. Variables affecting the installation process">
2140 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2141 <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
2142 <p>Most packages support installation into a
2143     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2144     to be built, before the actual filesystem is touched. DESTDIR
2145     support exists in two variations:</p>
2146 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2147 <li class="listitem"><p>Basic DESTDIR support means that the package
2148       installation and packaging is still run as root.</p></li>
2149 <li class="listitem"><p>Full DESTDIR support can run the complete
2150       build, installation and packaging as normal user. Root
2151       privileges are only needed to add packages.</p></li>
2152 </ul></div>
2153 <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2154     you can set
2155     <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2156     so it's preferable to convert a package to DESTDIR instead.</p>
2157 <p>DESTDIR support changes the behaviour of various targets
2158     slightly. To install a package after building it, use
2159     <code class="literal">package-install</code>. <code class="literal">package</code> and
2160     <code class="literal">install</code> don't do that any
2161     longer. <code class="literal">package-install</code> can be used as
2162     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
2163     will ask for the root password to install the package and fail,
2164     <code class="literal">package-install</code> will ask again.</p>
2165 <p>With basic DESTDIR support, <strong class="userinput"><code>make
2166     clean</code></strong> needs to be run as root.</p>
2167 <p>Considering the <code class="filename">foo/bar</code> package,
2168     DESTDIR full support can be tested using the following commands
2169
2170 </p>
2171 <pre class="programlisting">
2172 <code class="prompt">$</code> id
2173 uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2174 <code class="prompt">$</code> mkdir $HOME/packages
2175 <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2176 </pre>
2177 <p>
2178
2179     Verify <code class="varname">DESTDIR</code> full support, no root privileges
2180     should be needed
2181
2182 </p>
2183 <pre class="programlisting">
2184 <code class="prompt">$</code> make USE_DESTDIR=yes install
2185 </pre>
2186 <p>
2187
2188     Create a package without root privileges
2189
2190 </p>
2191 <pre class="programlisting">
2192 <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
2193 </pre>
2194 <p>
2195
2196     For the following command, you must be able to gain root
2197     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>
2198
2199 </p>
2200 <pre class="programlisting">
2201 <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
2202 </pre>
2203 <p>
2204
2205     Then, as a simple user
2206
2207 </p>
2208 <pre class="programlisting">
2209 <code class="prompt">$</code> make clean
2210 </pre>
2211 <p>
2212
2213     </p>
2214 </div>
2215 <div class="sect1" title="5.4. Selecting and configuring the compiler">
2216 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2217 <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
2218 <div class="sect2" title="5.4.1. Selecting the compiler">
2219 <div class="titlepage"><div><div><h3 class="title">
2220 <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
2221 <p>By default, pkgsrc will use GCC to build packages.  This may be
2222     overridden by setting the following variables in /etc/mk.conf:</p>
2223 <div class="variablelist"><dl>
2224 <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2225 <dd>
2226 <p>This is a list of values specifying the chain of
2227           compilers to invoke when building packages.  Valid values
2228           are:</p>
2229 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2230 <li class="listitem"><p><code class="varname">distcc</code>:
2231             distributed C/C++ (chainable)</p></li>
2232 <li class="listitem"><p><code class="varname">ccache</code>:
2233             compiler cache (chainable)</p></li>
2234 <li class="listitem"><p><code class="varname">gcc</code>:
2235             GNU C/C++ Compiler</p></li>
2236 <li class="listitem"><p><code class="varname">mipspro</code>:
2237             Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2238 <li class="listitem"><p><code class="varname">mipspro</code>:
2239             Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2240 <li class="listitem"><p><code class="varname">sunpro</code>:
2241             Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2242 </ul></div>
2243 <p>The default is
2244           <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
2245           <code class="varname">ccache</code> and/or
2246           <code class="varname">distcc</code> with an appropriate
2247           <code class="varname">PKGSRC_COMPILER</code> setting,
2248           e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
2249           variable should always be terminated with a value for
2250           a real compiler.  Note that only one real compiler
2251           should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
2252           is not allowed).</p>
2253 </dd>
2254 <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2255 <dd><p>This specifies the minimum version of GCC to use
2256           when building packages.  If the system GCC doesn't
2257           satisfy this requirement, then pkgsrc will build and
2258           install one of the GCC packages to use instead.</p></dd>
2259 </dl></div>
2260 </div>
2261 <div class="sect2" title="5.4.2. Additional flags to the compiler (CFLAGS)">
2262 <div class="titlepage"><div><div><h3 class="title">
2263 <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
2264 <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2265         please make sure to use the <code class="literal">+=</code> operator
2266         instead of the <code class="literal">=</code> operator:</p>
2267 <pre class="programlisting">
2268 CFLAGS+=        -your -flags
2269 </pre>
2270 <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2271         <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
2272         need to add their own flags.  You may want to take a look
2273         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>
2274         package if you're interested in optimization specifically
2275         for the current CPU. </p>
2276 </div>
2277 <div class="sect2" title="5.4.3. Additional flags to the linker (LDFLAGS)">
2278 <div class="titlepage"><div><div><h3 class="title">
2279 <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
2280 <p>If you want to pass flags to the linker, both in the configure
2281 step and the build step, you can do this in two ways.  Either set
2282 <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
2283 between the two is that <code class="varname">LIBS</code> will be appended to
2284 the command line, while <code class="varname">LDFLAGS</code> come earlier.
2285 <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2286 machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2287 the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
2288 <code class="varname">CFLAGS</code>, if you do not wish to override these
2289 settings, use the <code class="literal">+=</code> operator:</p>
2290 <pre class="programlisting">
2291 LDFLAGS+=        -your -linkerflags
2292 </pre>
2293 </div>
2294 </div>
2295 <div class="sect1" title="5.5. Developer/advanced settings">
2296 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2297 <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
2298 <p>XXX
2299       </p>
2300 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2301 <li class="listitem">
2302 <p><code class="varname">PKG_DEVELOPER</code>:
2303             Run some sanity checks that package developers want:
2304             </p>
2305 <div class="itemizedlist"><ul class="itemizedlist" type="circle">
2306 <li class="listitem"><p>make sure patches apply with zero
2307               fuzz</p></li>
2308 <li class="listitem"><p>run check-shlibs to see that all
2309               binaries will find their shared libs.</p></li>
2310 </ul></div>
2311 <p>
2312         </p>
2313 </li>
2314 <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2315         of debugging output which is displayed whilst making and
2316         installing the package.  The default value for this is 0,
2317         which will not display the commands as they are executed
2318         (normal, default, quiet operation); the value 1 will display
2319         all shell commands before their invocation, and the value 2
2320         will display both the shell commands before their invocation,
2321         and their actual execution progress with <span class="command"><strong>set
2322         -x</strong></span> will be displayed.</p></li>
2323 </ul></div>
2324 <p>
2325     </p>
2326 </div>
2327 <div class="sect1" title="5.6. Selecting Build Options">
2328 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2329 <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
2330 <p>Some packages have build time options, usually to select
2331     between different dependencies, enable optional support for big
2332     dependencies or enable experimental features.</p>
2333 <p>To see which options, if any, a package supports, and which
2334     options are mutually exclusive, run <span class="command"><strong>make
2335     show-options</strong></span>, for example:</p>
2336 <pre class="programlisting">
2337     The following options are supported by this package:
2338         ssl      Enable SSL support.
2339     Exactly one of the following gecko options is required:
2340         firefox  Use firefox as gecko rendering engine.
2341         mozilla  Use mozilla as gecko rendering engine.
2342     At most one of the following database options may be selected:
2343         mysql    Enable support for MySQL database.
2344         pgsql    Enable support for PostgreSQL database.
2345
2346     These options are enabled by default: firefox
2347     These options are currently enabled: mozilla ssl
2348 </pre>
2349 <p>The following variables can be defined in
2350     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
2351     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2352     which can be used to select or disable options for all packages
2353     that support them, and
2354     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2355     which can be used to select or disable options specifically for
2356     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
2357     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
2358     are disabled. A few examples:</p>
2359 <pre class="screen">
2360 <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>
2361 PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
2362 PKG_OPTIONS.kdebase=    debug -sasl
2363 PKG_OPTIONS.apache=     suexec </pre>
2364 <p>It is important to note that options that were specifically
2365     suggested by the package maintainer must be explicitly removed if
2366     you do not wish to include the option.  If you are unsure you can view
2367     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
2368 <p>The following settings are consulted in the order given, and
2369     the last setting that selects or disables an option is
2370     used:</p>
2371 <div class="orderedlist"><ol class="orderedlist" type="1">
2372 <li class="listitem"><p>the default options as suggested by the package
2373       maintainer</p></li>
2374 <li class="listitem"><p>the options implied by the settings of legacy
2375       variables (see below)</p></li>
2376 <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2377 <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2378 </ol></div>
2379 <p>For groups of mutually exclusive options, the last option
2380     selected is used, all others are automatically disabled.  If an
2381     option of the group is explicitly disabled, the previously
2382     selected option, if any, is used.  It is an error if no option
2383     from a required group of options is selected, and building the
2384     package will fail.</p>
2385 <p>Before the options framework was introduced, build options
2386     were selected by setting a variable (often named
2387     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
2388     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
2389     transition to the options framework for the user, these legacy
2390     variables are converted to the appropriate options setting
2391     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2392     automatically.  A warning is issued to prompt the user to update
2393     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
2394     directly.  Support for the legacy variables will be removed
2395     eventually.</p>
2396 </div>
2397 </div>
2398 <div class="chapter" title="Chapter 6. Creating binary packages">
2399 <div class="titlepage"><div><div><h2 class="title">
2400 <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2401 <div class="toc">
2402 <p><b>Table of Contents</b></p>
2403 <dl>
2404 <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2405 <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2406 </dl>
2407 </div>
2408 <div class="sect1" title="6.1. Building a single binary package">
2409 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2410 <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2411 <p>Once you have built and installed a package, you can create
2412     a <span class="emphasis"><em>binary package</em></span> which can be installed on
2413     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
2414     the same package on a group of hosts and wasting CPU time. It also
2415     provides a simple means for others to install your package, should
2416     you distribute it.</p>
2417 <p>To create a binary package, change into the appropriate
2418     directory in pkgsrc, and run <span class="command"><strong>make
2419     package</strong></span>:</p>
2420 <pre class="screen">
2421 <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2422 <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2423     </pre>
2424 <p>This will build and install your package (if not already done),
2425     and then build a binary package from what was installed. You can
2426     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
2427     it. Binary packages are created by default in
2428     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2429     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
2430     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>
2431 <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
2432     such a binary package.</p>
2433 </div>
2434 <div class="sect1" title="6.2. Settings for creation of binary packages">
2435 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2436 <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
2437 <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>
2438 </div>
2439 </div>
2440 <div class="chapter" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">
2441 <div class="titlepage"><div><div><h2 class="title">
2442 <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2443 builds)</h2></div></div></div>
2444 <div class="toc">
2445 <p><b>Table of Contents</b></p>
2446 <dl>
2447 <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2448 <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2449 <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2450 <dd><dl>
2451 <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2452 <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2453 <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2454 <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2455 <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2456 <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2457 <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2458 <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2459 </dl></dd>
2460 <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
2461 <dd><dl>
2462 <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2463 <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2464 </dl></dd>
2465 <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2466 <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2467 </dl>
2468 </div>
2469 <p>When you have multiple machines that should run the same packages,
2470 it is wasted time if they all build their packages themselves from
2471 source. There are two ways of getting a set of binary packages: The old
2472 bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2473 system. This chapter describes how to set them up so that the packages
2474 are most likely to be usable later.</p>
2475 <div class="sect1" title="7.1. Think first, build later">
2476 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2477 <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2478 <p>Since a bulk build takes several days or even weeks to finish, you
2479 should think about the setup before you start everything. Pay attention
2480 to at least the following points:</p>
2481 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2482 <li class="listitem">
2483 <p>If you want to upload the binary packages to
2484 ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2485 packages:</p>
2486 <div class="itemizedlist"><ul class="itemizedlist" type="circle">
2487 <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
2488 by a NetBSD developer on a trusted machine (that is, where you and only
2489 you have root access).</p></li>
2490 <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
2491 the stable branches (like 2009Q1), so that users browsing the available
2492 collections can see at a glance how old the packages
2493 are.</p></li>
2494 <li class="listitem"><p>The packages must be built as root, since some packages
2495 require set-uid binaries at runtime, and creating those packages as
2496 unprivileged user doesn't work well at the moment.</p></li>
2497 </ul></div>
2498 </li>
2499 <li class="listitem"><p>Make sure that the bulk build cannot break anything in
2500 your system. Most bulk builds run as root, so they should be run at least
2501 in a chroot environment or something even more restrictive, depending on
2502 what the operating system provides. There have been numerous cases where
2503 certain packages tried to install files outside the
2504 <code class="filename">LOCALBASE</code> or wanted to edit some files in
2505 <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2506 deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2507 <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2508 that you don't need any package during the build.</p></li>
2509 </ul></div>
2510 </div>
2511 <div class="sect1" title="7.2. Requirements of a bulk build">
2512 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2513 <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2514 <p>A complete bulk build requires lots of disk space. Some of the
2515 disk space can be read-only, some other must be writable. Some can be on
2516 remote filesystems (such as NFS) and some should be local. Some can be
2517 temporary filesystems, others must survive a sudden reboot.</p>
2518 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2519 <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2520 <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2521 <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2522 <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2523 <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2524 <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2525 </ul></div>
2526 </div>
2527 <div class="sect1" title="7.3. Running an old-style bulk build">
2528 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2529 <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
2530 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
2531 <h3 class="title">Note</h3>
2532 <p>There are two ways of doing a bulk build. The old-style
2533 one and the new-style <span class="quote">&#8220;<span class="quote">pbulk</span>&#8221;</span>. The latter is the recommended
2534 way.</p>
2535 </div>
2536 <div class="sect2" title="7.3.1. Configuration">
2537 <div class="titlepage"><div><div><h3 class="title">
2538 <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
2539 <div class="sect3" title="7.3.1.1. build.conf">
2540 <div class="titlepage"><div><div><h4 class="title">
2541 <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
2542 </h4></div></div></div>
2543 <p>The <code class="filename">build.conf</code> file is the main
2544         configuration file for bulk builds. You can configure how your
2545         copy of pkgsrc is kept up to date, how the distfiles are
2546         downloaded, how the packages are built and how the report is
2547         generated. You can find an annotated example file in
2548         <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2549         it, copy <code class="filename">build.conf-example</code> to
2550         <code class="filename">build.conf</code> and edit it, following the
2551         comments in that file.</p>
2552 </div>
2553 <div class="sect3" title="7.3.1.2. mk.conf">
2554 <div class="titlepage"><div><div><h4 class="title">
2555 <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2556 </h4></div></div></div>
2557 <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
2558         Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2559         details of the default settings. You will want to ensure that
2560         <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2561         As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
2562         completely bypasses the license check.</p>
2563 <pre class="programlisting">
2564 PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2565 WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
2566 BSDSRCDIR=      /usr/src
2567 BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
2568 OBJHOSTNAME?=   yes               # use work.`hostname`
2569 FAILOVER_FETCH= yes               # insist on the correct checksum
2570 PKG_DEVELOPER?= yes
2571 SKIP_LICENSE_CHECK=    yes
2572 </pre>
2573 <p>Some options that are especially useful for bulk builds
2574         can be found at the top lines of the file
2575         <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
2576         options of these are briefly described here.</p>
2577 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2578 <li class="listitem"><p>If you are on a slow machine, you may want to
2579           set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2580           <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.</p></li>
2581 <li class="listitem"><p>If you are doing bulk builds from a read-only
2582           copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2583           to the directory where all log files are created. Otherwise the
2584           log files are created in the pkgsrc directory.</p></li>
2585 <li class="listitem"><p>Another important variable is
2586           <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2587           should be always available while building other
2588           packages.</p></li>
2589 </ul></div>
2590 <p>Some other options are scattered in the pkgsrc
2591         infrastructure:</p>
2592 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2593 <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2594           should be set to <code class="literal">yes</code>. The purpose of the
2595           bulk builds is creating binary packages, no matter if they
2596           are vulnerable or not. Leaving this variable unset would
2597           prevent the bulk build system from even trying to build
2598           them, so possible building errors would not show
2599           up.</p></li>
2600 <li class="listitem"><p><code class="varname">CHECK_FILES</code>
2601           (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
2602           <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed set of files
2603           matches the <code class="filename">PLIST</code>.</p></li>
2604 <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
2605           (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
2606           <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed
2607           <span class="quote">&#8220;<span class="quote">#!</span>&#8221;</span>-scripts will find their
2608           interpreter.</p></li>
2609 <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2610           set to <span class="quote">&#8220;<span class="quote"><code class="literal">yes</code></span>&#8221;</span> to run each
2611           package's self-test before installing it. Note that some
2612           packages make heavy use of <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> random
2613           numbers, so you need to assure that the machine on which you
2614           are doing the bulk builds is not completely idle. Otherwise
2615           some test programs will seem to hang, while they are just
2616           waiting for new random data to be
2617           available.</p></li>
2618 </ul></div>
2619 </div>
2620 <div class="sect3" title="7.3.1.3. pre-build.local">
2621 <div class="titlepage"><div><div><h4 class="title">
2622 <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
2623 </h4></div></div></div>
2624 <p>It is possible to configure the bulk build to perform
2625         certain site-specific tasks at the end of the pre-build
2626         stage.  If the file
2627         <code class="filename">pre-build.local</code> exists in
2628         <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2629         (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
2630         stage.  An example use of
2631         <code class="filename">pre-build.local</code> is to have the line:</p>
2632 <pre class="screen">echo "I do not have enough disk space to build this pig." \
2633         &gt; misc/openoffice/$BROKENF</pre>
2634 <p>to prevent the system from trying to build a particular package
2635         which requires nearly 3 GB of disk space.</p>
2636 </div>
2637 </div>
2638 <div class="sect2" title="7.3.2. Other environmental considerations">
2639 <div class="titlepage"><div><div><h3 class="title">
2640 <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
2641 <p>As <code class="filename">/usr/pkg</code> will be completely
2642       deleted at the start of bulk builds, make sure your login
2643       shell is placed somewhere else. Either drop it into
2644       <code class="filename">/usr/local/bin</code> (and adjust your login
2645       shell in the passwd file), or (re-)install it via
2646       <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
2647       you can login after a reboot (remember that your current
2648       process won't die if the package is removed, you just can't
2649       start any new instances of the shell any more).  Also, if you
2650       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2651       version of ssh for some reason, be sure to install ssh before
2652       starting it from <code class="filename">rc.local</code>:</p>
2653 <pre class="programlisting">
2654 (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
2655 if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2656   /usr/pkg/etc/rc.d/sshd
2657 fi
2658 </pre>
2659 <p>Not doing so will result in you being not able to log in
2660       via ssh after the bulk build is finished or if the machine
2661       gets rebooted or crashes. You have been warned! :)</p>
2662 </div>
2663 <div class="sect2" title="7.3.3. Operation">
2664 <div class="titlepage"><div><div><h3 class="title">
2665 <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
2666 <p>Make sure you don't need any of the packages still
2667       installed.</p>
2668 <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2669 <h3 class="title">Warning</h3>
2670 <p>During the bulk build, <span class="emphasis"><em>all packages, their
2671         configuration files and some more files from
2672         <code class="filename">/var</code>, <code class="filename">/home</code> and
2673         possibly other locations will be removed! So don't run a bulk
2674         build with privileges that might harm your
2675         system.</em></span></p>
2676 </div>
2677 <p>Be sure to remove all other things that might
2678       interfere with builds, like some libs installed in
2679       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2680 <pre class="screen">
2681 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2682 <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2683       </pre>
2684 <p>If for some reason your last build didn't complete (power
2685       failure, system panic, ...), you can continue it by
2686       running:</p>
2687 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
2688 <p>At the end of the bulk build, you will get a summary via mail,
2689       and find build logs in the directory specified by
2690       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2691       file.</p>
2692 </div>
2693 <div class="sect2" title="7.3.4. What it does">
2694 <div class="titlepage"><div><div><h3 class="title">
2695 <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
2696 <p>The bulk builds consist of three steps:</p>
2697 <div class="variablelist"><dl>
2698 <dt><span class="term">1. pre-build</span></dt>
2699 <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2700             cleans out any broken distfiles, and removes all
2701             packages installed.</p></dd>
2702 <dt><span class="term">2. the bulk build</span></dt>
2703 <dd><p>This is basically <span class="quote">&#8220;<span class="quote">make bulk-package</span>&#8221;</span> with
2704             an optimised order in which packages will be
2705             built. Packages that don't require other packages will
2706             be built first, and packages with many dependencies will
2707             be built later.</p></dd>
2708 <dt><span class="term">3. post-build</span></dt>
2709 <dd><p>Generates a report that's placed in the directory
2710             specified in the <code class="filename">build.conf</code> file
2711             named <code class="filename">broken.html</code>, a short version
2712             of that report will also be mailed to the build's
2713             admin.</p></dd>
2714 </dl></div>
2715 <p>During the build, a list of broken packages will be compiled
2716       in <code class="filename">/usr/pkgsrc/.broken</code> (or
2717       <code class="filename">.../.broken.${MACHINE}</code> if
2718       <code class="varname">OBJMACHINE</code> is set), individual build logs
2719       of broken builds can be found in the package's
2720       directory. These files are used by the bulk-targets to mark
2721       broken builds to not waste time trying to rebuild them, and
2722       they can be used to debug these broken package builds
2723       later.</p>
2724 </div>
2725 <div class="sect2" title="7.3.5. Disk space requirements">
2726 <div class="titlepage"><div><div><h3 class="title">
2727 <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
2728 <p>Currently, roughly the following requirements are valid for
2729       NetBSD 2.0/i386:</p>
2730 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2731 <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
2732 <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
2733 <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2734 </ul></div>
2735 <p>Note that all pkgs will be de-installed as soon as they are
2736       turned into a binary package, and that sources are removed,
2737       so there is no excessively huge demand to disk
2738       space. Afterwards, if the package is needed again, it will
2739       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
2740       there are no cycles wasted by recompiling.</p>
2741 </div>
2742 <div class="sect2" title="7.3.6. Setting up a sandbox for chrooted builds">
2743 <div class="titlepage"><div><div><h3 class="title">
2744 <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
2745 <p>If you don't want all the packages nuked from a machine
2746       (rendering it useless for anything but pkg compiling), there
2747       is the possibility of doing the package bulk build inside a
2748       chroot environment.</p>
2749 <p>The first step is to set up a chroot sandbox,
2750       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
2751       using null mounts, or manually.</p>
2752 <p>There is a shell script called
2753       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2754       up the sandbox environment using null mounts. It will also
2755       create a script called <code class="filename">sandbox</code> in the
2756       root of the sandbox environment, which will allow the null
2757       mounts to be activated using the <span class="command"><strong>sandbox
2758       mount</strong></span> command and deactivated using the
2759       <span class="command"><strong>sandbox umount</strong></span> command.</p>
2760 <p>To set up a sandbox environment by hand, after extracting all
2761       the sets from a NetBSD installation or doing a <span class="command"><strong>make
2762       distribution DESTDIR=/usr/sandbox</strong></span> in
2763       <code class="filename">/usr/src/etc</code>, be sure the following items
2764       are present and properly configured:</p>
2765 <div class="procedure"><ol class="procedure" type="1">
2766 <li class="step" title="Step 1">
2767 <p>Kernel</p>
2768 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2769 </li>
2770 <li class="step" title="Step 2">
2771 <p><code class="filename">/dev/*</code></p>
2772 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2773 </li>
2774 <li class="step" title="Step 3">
2775 <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>
2776 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2777 </li>
2778 <li class="step" title="Step 4">
2779 <p>Working(!) mail config (hostname, sendmail.cf):</p>
2780 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2781 </li>
2782 <li class="step" title="Step 5">
2783 <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>
2784 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2785 </li>
2786 <li class="step" title="Step 6">
2787 <p><code class="filename">/usr/src</code> (system sources,
2788           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>
2789 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
2790           <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
2791 </li>
2792 <li class="step" title="Step 7">
2793 <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
2794 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2795 </li>
2796 <li class="step" title="Step 8">
2797 <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
2798 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2799 </li>
2800 <li class="step" title="Step 9">
2801 <p>Checkout pkgsrc via cvs into
2802           <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2803 <pre class="screen">
2804 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2805 <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2806           </pre>
2807 <p>Do not mount/link this to the copy of your pkgsrc tree
2808           you do development in, as this will likely cause problems!</p>
2809 </li>
2810 <li class="step" title="Step 10"><p>Make
2811           <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2812           <code class="filename">.../distfiles</code> point somewhere
2813           appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
2814 <li class="step" title="Step 11"><p>Edit <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, see <a class="xref" href="#binary.mk.conf" title="7.3.1.2. mk.conf">Section 7.3.1.2, &#8220;<code class="filename">mk.conf</code>&#8221;</a>.</p></li>
2815 <li class="step" title="Step 12"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
2816 </ol></div>
2817 <p>When the chroot sandbox is set up, you can start
2818       the build with the following steps:</p>
2819 <pre class="screen">
2820 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2821 <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2822       </pre>
2823 <p>This will just jump inside the sandbox and start building.  At
2824         the end of the build, mail will be sent with the results of
2825         the build. Created binary pkgs will be in
2826         <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2827       (wherever that points/mounts to/from).</p>
2828 </div>
2829 <div class="sect2" title="7.3.7. Building a partial set of packages">
2830 <div class="titlepage"><div><div><h3 class="title">
2831 <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
2832 <p>In addition to building a complete set of all packages in
2833       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2834       may be used to build a subset of the packages contained in
2835       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
2836       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
2837 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2838 <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
2839 <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
2840 <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
2841 <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
2842 </ul></div>
2843 <p>will define the set of packages which should be built.
2844       The bulk build code will also include any packages which are
2845       needed as dependencies for the explicitly listed packages.</p>
2846 <p>One use of this is to do a bulk build with
2847       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2848       periodically to have a complete set of the binary packages
2849       needed for your site available without the overhead of
2850       building extra packages that are not needed.</p>
2851 </div>
2852 <div class="sect2" title="7.3.8. Uploading results of a bulk build">
2853 <div class="titlepage"><div><div><h3 class="title">
2854 <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
2855 <p>This section describes how pkgsrc developers can upload binary
2856       pkgs built by bulk builds to ftp.NetBSD.org.</p>
2857 <p>If you would like to automatically create checksum files for the
2858       binary packages you intend to upload, remember to set
2859       <code class="varname">MKSUMS=yes</code> in your
2860       <code class="filename">mk/bulk/build.conf</code>.</p>
2861 <p>If you would like to PGP sign the checksum files (highly
2862       recommended!), remember to set
2863       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2864       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
2865       your GPG password to sign the files before uploading everything.</p>
2866 <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2867       set properly in your <code class="filename">mk/bulk/build.conf</code>
2868       file, i.e. adjust it to something like one of the following:</p>
2869 <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload </pre>
2870 <p>Please use appropriate values for "packages-20xxQy",
2871       "NetBSD-a.b.c" and "arch" here. If your login on ftp.NetBSD.org
2872       is different from your local login, write your login directly
2873       into the variable, e.g. my local account is "feyrer", but for my
2874       login "hubertf", I use:</p>
2875 <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload</pre>
2876 <p>A separate <code class="filename">upload</code> directory is used
2877       here to allow "closing" the directory during upload. To do
2878       so, run the following command on ftp.NetBSD.org next:</p>
2879 <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch/upload</code></strong></pre>
2880 <p>Please note that <code class="filename">/pub/NetBSD/packages</code> is
2881       only appropriate for packages for the NetBSD operating
2882       system. Binary packages for other operating systems should go
2883       into <code class="filename">/pub/pkgsrc</code>.</p>
2884 <p>Before uploading the binary pkgs, ssh authentication needs
2885       to be set up. This example shows how to set up temporary keys
2886       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2887       (assuming that no keys should be present there usually):</p>
2888 <pre class="screen">
2889 <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
2890 chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2891 chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t dsa</code></strong>
2892 chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-dsa.pub</code></strong>
2893       </pre>
2894 <p>Now take the output of <code class="filename">id-dsa.pub</code> and
2895       append it to your <code class="filename">~/.ssh/authorized_keys</code>
2896       file on ftp.NetBSD.org. You can remove the key after the
2897       upload is done!</p>
2898 <p>Next, test if your ssh connection really works:</p>
2899 <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
2900 <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2901 <p>Now after all this works, you can exit the sandbox and start
2902       the upload:</p>
2903 <pre class="screen">
2904 chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
2905 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2906 <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2907       </pre>
2908 <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
2909       <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
2910       upload. The upload script will take care of not uploading
2911       restricted packages.</p>
2912 <p>After the upload has ended, first thing is to revoke ssh access:</p>
2913 <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
2914       Gdd:x! </pre>
2915 <p>Use whatever is needed to remove the key you've entered
2916       before! Last, move the uploaded packages out of the
2917       <code class="filename">upload</code> directory to have them accessible
2918       to everyone:</p>
2919 <pre class="screen">
2920 nbftp% <strong class="userinput"><code>cd /pub/NetBSD/packages/packages-20xxQy/NetBSD-a.b.c/arch</code></strong>
2921 nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2922 nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
2923 nbftp% <strong class="userinput"><code>chmod 755 .</code></strong>
2924       </pre>
2925 </div>
2926 </div>
2927 <div class="sect1" title="7.4. Running a pbulk-style bulk build">
2928 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2929 <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
2930 <p>Running a pbulk-style bulk build works roughly as follows:</p>
2931 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2932 <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2933 <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
2934 </ul></div>
2935 <div class="sect2" title="7.4.1. Preparation">
2936 <div class="titlepage"><div><div><h3 class="title">
2937 <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
2938 <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>
2939 <pre class="screen">
2940 $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2941 $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2942 $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2943 </pre>
2944 <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>
2945 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2946 <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
2947 <li class="listitem"><p><code class="literal"><code class="varname">WRKOBJDIR</code>=/tmp/pbulk-outer</code>, to keep <code class="filename">/usr/pkgsrc</code> free from any modifications,</p></li>
2948 <li class="listitem"><p><code class="literal"><code class="varname">DISTDIR</code>=/distfiles</code>, to have only one directory in which all distfiles (for the infrastructure and for the actual packages) are downloaded,</p></li>
2949 <li class="listitem"><p><code class="literal"><code class="varname">ACCEPTABLE_LICENSES</code>+=...</code>, to select some licenses additional to the usual Free/Open Source licenses that are acceptable to you,</p></li>
2950 <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
2951 </ul></div>
2952 <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2953 <pre class="screen">
2954 $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2955 $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2956 $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2957 </pre>
2958 <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>
2959 </div>
2960 <div class="sect2" title="7.4.2. Configuration">
2961 <div class="titlepage"><div><div><h3 class="title">
2962 <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
2963 <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
2964 <p>TODO: continue writing</p>
2965 </div>
2966 </div>
2967 <div class="sect1" title="7.5. Creating a multiple CD-ROM packages collection">
2968 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2969 <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
2970 <p>After your pkgsrc bulk-build has completed, you may wish to
2971     create a CD-ROM set of the resulting binary packages to assist
2972     in installing packages on other machines.  The
2973     <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
2974     a simple tool for creating the ISO 9660 images.
2975     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
2976     way that keeps all the dependencies for a given package on the same
2977     CD as that package.</p>
2978 <div class="sect2" title="7.5.1. Example of cdpack">
2979 <div class="titlepage"><div><div><h3 class="title">
2980 <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
2981 <p>Complete documentation for cdpack is found in the cdpack(1)
2982       man page. The following short example assumes that the binary
2983       packages are left in
2984       <code class="filename">/usr/pkgsrc/packages/All</code> and that
2985       sufficient disk space exists in <code class="filename">/u2</code> to
2986       hold the ISO 9660 images.</p>
2987 <pre class="screen">
2988 <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2989 <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2990 <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2991       </pre>
2992 <p>If you wish to include a common set of files
2993       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2994       etc.) on each CD in the collection, then you need to create a
2995       directory which contains these files. e.g.</p>
2996 <pre class="screen">
2997 <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
2998 <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
2999 <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
3000 <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3001 <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
3002 <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
3003 <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3004       </pre>
3005 <p>Now create the images:</p>
3006 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
3007 <p>Each image will contain <code class="filename">README</code>,
3008       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3009       in their root directories.</p>
3010 </div>
3011 </div>
3012 </div>
3013 <div class="chapter" title="Chapter 8. Directory layout of the installed files">
3014 <div class="titlepage"><div><div><h2 class="title">
3015 <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
3016 <div class="toc">
3017 <p><b>Table of Contents</b></p>
3018 <dl>
3019 <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
3020 <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
3021 </dl>
3022 </div>
3023 <p>The files that are installed by pkgsrc are organized in a way that
3024 is similar to what you find in the <code class="filename">/usr</code> directory
3025 of the base system. But some details are different. This is because
3026 pkgsrc initially came from FreeBSD and had adopted its file system
3027 hierarchy. Later it was largely influenced by NetBSD. But no matter
3028 which operating system you are using pkgsrc with, you can expect the
3029 same layout for pkgsrc.</p>
3030 <p>There are mainly four root directories for pkgsrc, which are all
3031 configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3032 When pkgsrc has been installed as root, the default locations
3033 are:</p>
3034 <pre class="programlisting">
3035 LOCALBASE=              /usr/pkg
3036 PKG_SYSCONFBASE=        /usr/pkg/etc
3037 VARBASE=                /var
3038 PKG_DBDIR=              /var/db/pkg
3039 </pre>
3040 <p>In unprivileged mode (when pkgsrc has been installed as any other
3041 user), the default locations are:</p>
3042 <pre class="programlisting">
3043 LOCALBASE=              ${HOME}/pkg
3044 PKG_SYSCONFBASE=        ${HOME}/pkg/etc
3045 VARBASE=                ${HOME}/pkg/var
3046 PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
3047 </pre>
3048 <p>What these four directories are for, and what they look like is
3049 explained below.</p>
3050 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3051 <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
3052 <code class="filename">/usr</code> directory in the base system. It is the
3053 <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
3054 the well-known subdirectories like <code class="filename">bin</code>,
3055 <code class="filename">include</code>, <code class="filename">lib</code>,
3056 <code class="filename">share</code> and
3057 <code class="filename">sbin</code>.</p></li>
3058 <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
3059 <code class="filename">/var</code> in the base system. Some programs (especially
3060 games, network daemons) need write access to it during normal
3061 operation.</p></li>
3062 <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3063 <code class="filename">/etc</code> in the base system. It contains configuration
3064 files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
3065 itself.</p></li>
3066 </ul></div>
3067 <div class="sect1" title="8.1. File system layout in ${LOCALBASE}">
3068 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3069 <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
3070 </h2></div></div></div>
3071 <p>The following directories exist in a typical pkgsrc installation
3072 in <code class="filename">${LOCALBASE}</code>.</p>
3073 <div class="variablelist"><dl>
3074 <dt><span class="term"><code class="filename">bin</code></span></dt>
3075 <dd><p>Contains executable programs that are intended to be
3076 directly used by the end user.</p></dd>
3077 <dt><span class="term"><code class="filename">emul</code></span></dt>
3078 <dd><p>Contains files for the emulation layers of various other
3079 operating systems, especially for
3080 NetBSD.</p></dd>
3081 <dt><span class="term"><code class="filename">etc</code> (the usual location of
3082 <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3083 <dd><p>Contains
3084 the configuration files.</p></dd>
3085 <dt><span class="term"><code class="filename">include</code></span></dt>
3086 <dd><p>Contains headers for the C and C++ programming
3087 languages.</p></dd>
3088 <dt><span class="term"><code class="filename">info</code></span></dt>
3089 <dd><p>Contains GNU info files of various
3090 packages.</p></dd>
3091 <dt><span class="term"><code class="filename">lib</code></span></dt>
3092 <dd><p>Contains shared and static
3093 libraries.</p></dd>
3094 <dt><span class="term"><code class="filename">libdata</code></span></dt>
3095 <dd><p>Contains data files that don't change after
3096 installation. Other data files belong into
3097 <code class="filename">${VARBASE}</code>.</p></dd>
3098 <dt><span class="term"><code class="filename">libexec</code></span></dt>
3099 <dd><p>Contains programs that are not intended to be used by
3100 end users, such as helper programs or network
3101 daemons.</p></dd>
3102 <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3103 <dd><p>Contains programs that are intended to be executed as
3104 CGI scripts by a web server.</p></dd>
3105 <dt><span class="term"><code class="filename">man</code> (the usual value of
3106 <code class="filename">${PKGMANDIR}</code>)</span></dt>
3107 <dd><p>Contains brief
3108 documentation in form of manual pages.</p></dd>
3109 <dt><span class="term"><code class="filename">sbin</code></span></dt>
3110 <dd><p>Contains programs that are intended to be used only by
3111 the super-user.</p></dd>
3112 <dt><span class="term"><code class="filename">share</code></span></dt>
3113 <dd><p>Contains platform-independent data files that don't
3114 change after installation.</p></dd>
3115 <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3116 <dd><p>Contains documentation files provided by the
3117 packages.</p></dd>
3118 <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3119 <dd><p>Contains example files provided by the packages. Among
3120 others, the original configuration files are saved here and copied to
3121 <code class="filename">${PKG_SYSCONFDIR}</code> during
3122 installation.</p></dd>
3123 <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3124 <dd><p>Contains the original files for rc.d
3125 scripts.</p></dd>
3126 <dt><span class="term"><code class="filename">var</code> (the usual location of
3127 <code class="filename">${VARBASE}</code>)</span></dt>
3128 <dd><p>Contains files
3129 that may be modified after
3130 installation.</p></dd>
3131 </dl></div>
3132 </div>
3133 <div class="sect1" title="8.2. File system layout in ${VARBASE}">
3134 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3135 <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
3136 </h2></div></div></div>
3137 <div class="variablelist"><dl>
3138 <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3139 <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3140 <dd><p>Contains
3141 information about the currently installed
3142 packages.</p></dd>
3143 <dt><span class="term"><code class="filename">games</code></span></dt>
3144 <dd><p>Contains highscore
3145 files.</p></dd>
3146 <dt><span class="term"><code class="filename">log</code></span></dt>
3147 <dd><p>Contains log files.</p></dd>
3148 <dt><span class="term"><code class="filename">run</code></span></dt>
3149 <dd><p>Contains informational files about daemons that are
3150 currently running.</p></dd>
3151 </dl></div>
3152 </div>
3153 </div>
3154 <div class="chapter" title="Chapter 9. Frequently Asked Questions">
3155 <div class="titlepage"><div><div><h2 class="title">
3156 <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
3157 <div class="toc">
3158 <p><b>Table of Contents</b></p>
3159 <dl>
3160 <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3161 <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3162 <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3163 <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3164 <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3165 <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>
3166 <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
3167 <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
3168 <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
3169 <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
3170 /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
3171 <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
3172 <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3173 <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3174 <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
3175 <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3176 <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
3177 <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
3178 </dl>
3179 </div>
3180 <p>This section contains hints, tips &amp; tricks on special things in
3181 pkgsrc that we didn't find a better place for in the previous chapters, and
3182 it contains items for both pkgsrc users and developers.</p>
3183 <div class="sect1" title="9.1. Are there any mailing lists for pkg-related discussion?">
3184 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3185 <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
3186 <p>The following mailing lists may be of interest to pkgsrc users:</p>
3187 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3188 <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
3189           This is a general purpose list for most issues regarding
3190           pkgsrc, regardless of platform, e.g. soliciting user help
3191           for pkgsrc configuration, unexpected build failures, using
3192           particular packages, upgrading pkgsrc installations,
3193           questions regarding the pkgsrc release branches, etc.  General announcements or
3194           proposals for changes that impact the pkgsrc user community,
3195           e.g. major infrastructure changes, new features, package
3196           removals, etc., may also be posted.</p></li>
3197 <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
3198           A list where the results of pkgsrc bulk builds are sent and
3199           discussed.</p></li>
3200 <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
3201           This list is for those who are interested in getting a
3202           commit message for every change committed to pkgsrc. It is
3203           also available in digest form, meaning one daily message
3204           containing all commit messages for changes to the package
3205           source tree in that 24 hour period.</p></li>
3206 </ul></div>
3207 <p>To subscribe, do:</p>
3208 <pre class="programlisting">
3209 <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3210 </pre>
3211 <p>Archives for all these mailing lists are available from
3212 <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3213 </div>
3214 <div class="sect1" title="9.2. Where's the pkgviews documentation?">
3215 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3216 <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
3217 <p>Pkgviews is tightly integrated with buildlink.  You can find a
3218 pkgviews User's guide in
3219 <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
3220 </div>
3221 <div class="sect1" title="9.3. Utilities for package management (pkgtools)">
3222 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3223 <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
3224 <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
3225 a number of useful utilities for both users and developers of pkgsrc.  This
3226 section attempts only to make the reader aware of the utilities and when
3227 they might be useful, and not to duplicate the documentation that comes
3228 with each package.</p>
3229 <p>Utilities used by pkgsrc (automatically installed when needed):</p>
3230 <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
3231       Symlinks for use by buildlink.</p></li></ul></div>
3232 <p>OS tool augmentation (automatically installed when needed):</p>
3233 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3234 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
3235       Calculates various kinds of checksums (including SHA1).</p></li>
3236 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
3237       Compatibility library for pkgsrc tools.</p></li>
3238 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
3239       non-BSD systems due to lack of native mtree.</p></li>
3240 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
3241       Up-to-date replacement for
3242       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
3243       systems where pkg_install is not present.</p></li>
3244 </ul></div>
3245 <p>Utilities used by pkgsrc (not automatically installed):</p>
3246 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3247 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
3248       Create a binary package from an
3249       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
3250       save the old package.</p></li>
3251 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
3252       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3253       from multiple locations. It currently supports the following
3254       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
3255 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a>: Put X11
3256       packages someplace else (enabled by default).</p></li>
3257 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
3258       the best compiler flags to optimise code for your current
3259       CPU and compiler. </p></li>
3260 </ul></div>
3261 <p>Utilities for keeping track of installed packages, being up to date,
3262 etc:</p>
3263 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3264 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
3265       packages whose installed versions do not match the latest pkgsrc
3266       entries.</p></li>
3267 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
3268       dependency graphs of packages, to aid in choosing a strategy for
3269       updating.</p></li>
3270 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
3271       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>
3272 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
3273       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
3274 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
3275       does various checks on the complete pkgsrc system.</p></li>
3276 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
3277       packages you have installed.</p></li>
3278 </ul></div>
3279 <p>Utilities for people maintaining or creating individual packages:</p>
3280 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3281 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
3282       making and maintaining patches for a package (includes pkgdiff,
3283       pkgvi, mkpatches, etc.).</p></li>
3284 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>,
3285       <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
3286       converting to pkgsrc.</p></li>
3287 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/gensolpkg/README.html" target="_top"><code class="filename">pkgtools/gensolpkg</code></a>: Convert
3288       pkgsrc to a Solaris package.</p></li>
3289 </ul></div>
3290 <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3291 utilities)</p>
3292 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3293 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
3294       packages in a chrooted area.</p></li>
3295 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
3296       kernel version for chrooted cross builds.</p></li>
3297 </ul></div>
3298 </div>
3299 <div class="sect1" title="9.4. How to use pkgsrc as non-root">
3300 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3301 <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
3302 <p>If you want to use pkgsrc as non-root user, you can set some
3303 variables to make pkgsrc work under these conditions.  At the very least,
3304 you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>; this
3305 will turn on unprivileged mode and set multiple related variables to allow
3306 installation of packages as non-root.</p>
3307 <p>In case the defaults are not enough, you may want to tune some other
3308 variables used.  For example, if the automatic user/group detection leads
3309 to incorrect values (or not the ones you would like to use), you can change
3310 them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3311 <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3312 <p>As regards bootstrapping, please note that the
3313 <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
3314 given the <span class="quote">&#8220;<span class="quote">--ignore-user-check</span>&#8221;</span> flag, as it will choose and
3315 use multiple default directories under <code class="filename">~/pkg</code> as the
3316 installation targets.  These directories can be overridden by the
3317 <span class="quote">&#8220;<span class="quote">--prefix</span>&#8221;</span> flag provided by the script, as well as some others
3318 that allow finer tuning of the tree layout.</p>
3319 </div>
3320 <div class="sect1" title="9.5. How to resume transfers when fetching distfiles?">
3321 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3322 <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
3323 <p>By default, resuming transfers in pkgsrc is disabled, but you can
3324 enable this feature by adding the option
3325 <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
3326 <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
3327 distfile is found, pkgsrc will try to resume it.</p>
3328 <p>You can also
3329 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
3330 <code class="varname">FETCH_USING</code> variable.  You can specify the program by
3331 using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
3332 by using the value manual.  A value of custom disables the system defaults
3333 and dependency tracking for the fetch program.  In that case you have to
3334 provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3335 <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3336 <code class="varname">FETCH_AFTER_ARGS</code>.</p>
3337 <p>For example, if you want to use
3338 <code class="filename">wget</code> to download, you'll have to use something
3339 like:</p>
3340 <pre class="programlisting">
3341 FETCH_USING=    wget
3342 </pre>
3343 </div>
3344 <div class="sect1" title="9.6. How can I install/use modular X.org from pkgsrc?">
3345 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3346 <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
3347 <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
3348 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3349 you will have to add the following line into
3350 <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
3351 <pre class="programlisting">
3352 X11_TYPE=modular
3353 </pre>
3354 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
3355 <h3 class="title">Note</h3>
3356 <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3357 </p>
3358 </div>
3359 </div>
3360 <div class="sect1" title="9.7. How to fetch files from behind a firewall">
3361 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3362 <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
3363 <p>If you are sitting behind a firewall which does not allow direct
3364 connections to Internet hosts (i.e. non-NAT), you may specify the
3365 relevant proxy hosts.  This is done using an environment variable in the
3366 form of a URL, e.g. in Amdahl, the machine
3367 <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
3368 port 80 as the proxy port number.  So the proxy environment variables
3369 are:</p>
3370 <pre class="programlisting">
3371 ftp_proxy=ftp://orpheus.amdahl.com:80/
3372 http_proxy=http://orpheus.amdahl.com:80/
3373 </pre>
3374 </div>
3375 <div class="sect1" title="9.8. How do I tell make fetch to do passive FTP?">
3376 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3377 <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>
3378 <p>This depends on which utility is used to retrieve distfiles.  From
3379 <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3380 the first available command from the following list:</p>
3381 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3382 <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3383 <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
3384 </ul></div>
3385 <p>On a default NetBSD installation, this will be
3386 <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3387 connections first, and falls back to active connections if the server
3388 refuses to do passive.  For the other tools, add the following to your
3389 <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
3390 <code class="varname">PASSIVE_FETCH=1</code>.</p>
3391 <p>Having that option present will prevent
3392 <code class="filename">/usr/bin/ftp</code> from falling back to active
3393 transfers.</p>
3394 </div>
3395 <div class="sect1" title="9.9. How to fetch all distfiles at once">
3396 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3397 <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
3398 <p>You would like to download all the distfiles in a single batch
3399 from work or university, where you can't run a <span class="command"><strong>make
3400 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>,
3401 but downloading the entire directory may not be appropriate.</p>
3402 <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
3403 <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3404 resulting list to your machine at work/school and use it there.  If you
3405 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
3406 forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3407 URL:</p>
3408 <p>At home:</p>
3409 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3410 <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
3411 <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3412 <p>At work:</p>
3413 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3414 <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3415 home.</p>
3416 <p>If you have a machine running NetBSD, and you want to get
3417 <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3418 machine architecture), you can do so by using the above-mentioned
3419 <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
3420 directly by running:</p>
3421 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3422 <p>If you even decide to ignore
3423 <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3424 by running:</p>
3425 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3426 </div>
3427 <div class="sect1" title="9.10. What does &#8220;Don't know how to make /usr/share/tmac/tmac.andoc&#8221; mean?">
3428 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3429 <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
3430 /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
3431 <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>
3432 package, you get the error from make that it doesn't know how to make
3433 <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
3434 you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
3435 the NetBSD base distribution on your machine.  It is recommended to do
3436 that to format man pages.</p>
3437 <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
3438 can get away with setting <code class="varname">NOMAN=YES</code> either in the
3439 environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
3440 </div>
3441 <div class="sect1" title="9.11. What does &#8220;Could not find bsd.own.mk&#8221; mean?">
3442 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3443 <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
3444 <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3445 when you installed your NetBSD machine.  Please get and install it, by
3446 extracting it in <code class="filename">/</code>:</p>
3447 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3448 <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3449 <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
3450 the one that corresponds to your release (determine via <span class="command"><strong>uname
3451 -r</strong></span>).</p>
3452 </div>
3453 <div class="sect1" title="9.12. Using 'sudo' with pkgsrc">
3454 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3455 <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
3456 <p>When installing packages as non-root user and using the just-in-time
3457 <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
3458 password for each required package installed.  To avoid this, the sudo
3459 package can be used, which does password caching over a limited time.  To
3460 use it, install sudo (either as binary package or from
3461 <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
3462 following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
3463 <span class="emphasis"><em>after</em></span> the definition of the
3464 <code class="varname">LOCALBASE</code> variable:</p>
3465 <pre class="programlisting">
3466 .if exists(${LOCALBASE}/bin/sudo)
3467 SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
3468 .endif
3469 </pre>
3470 </div>
3471 <div class="sect1" title="9.13. How do I change the location of configuration files?">
3472 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3473 <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
3474 <p>As the system administrator, you can choose where configuration files
3475 are installed.  The default settings make all these files go into
3476 <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3477 be suboptimal depending on your expectations (e.g., a read-only,
3478 NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3479 configuration of the provided packages).</p>
3480 <p>In order to change the defaults, you can modify the
3481 <code class="varname">PKG_SYSCONFBASE</code> variable (in
3482 <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
3483 directory; some common examples include <code class="filename">/etc</code> or
3484 <code class="filename">/etc/pkg</code>.</p>
3485 <p>Furthermore, you can change this value on a per-package basis by
3486 setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3487 <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3488 package you would like to modify, that is, the contents of
3489 <code class="varname">PKGBASE</code>.</p>
3490 <p>Note that after changing these settings, you must rebuild and
3491 reinstall any affected packages.</p>
3492 </div>
3493 <div class="sect1" title="9.14. Automated security checks">
3494 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3495 <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
3496 <p>Please be aware that there can often be bugs in third-party software,
3497 and some of these bugs can leave a machine vulnerable to exploitation by
3498 attackers.  In an effort to lessen the exposure, the NetBSD packages team
3499 maintains a database of known-exploits to packages which have at one time
3500 been included in pkgsrc.  The database can be downloaded automatically, and
3501 a security audit of all packages installed on a system can take place.  To
3502 do this, refer to the following two tools (installed as part of the
3503 <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>
3504 <div class="orderedlist"><ol class="orderedlist" type="1">
3505 <li class="listitem">
3506 <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
3507     download a list of the security vulnerabilities information.  This list
3508     is kept up to date by the NetBSD security officer and the NetBSD
3509     packages team, and is distributed from the NetBSD ftp server:</p>
3510 <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>
3511 </li>
3512 <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3513     current machine, checking each known vulnerability.  If a
3514     vulnerable package is installed, it will be shown by output to stdout,
3515     including a description of the type of vulnerability, and a URL
3516     containing more information.</p></li>
3517 </ol></div>
3518 <p>Use of these tools is strongly recommended!  After
3519 <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
3520 the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3521 pkg_install</code></strong>.</p>
3522 <p>If this package is installed, pkgsrc builds will use it to
3523 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
3524 check.</p>
3525 </div>
3526 <div class="sect1" title="9.15. Why do some packages ignore my CFLAGS?">
3527 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3528 <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
3529 <p>When you add your own preferences to the
3530         <code class="varname">CFLAGS</code> variable in your
3531         <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
3532         environment variables to the <code class="filename">./configure</code>
3533         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
3534         <code class="varname">CFLAGS</code> from the environment variable by
3535         overriding them in the <code class="filename">Makefile</code>s of their
3536         package.</p>
3537 <p>Currently there is no solution to this problem. If you
3538         really need the package to use your <code class="varname">CFLAGS</code>
3539         you should run <span class="command"><strong>make patch</strong></span> in the package
3540         directory and then inspect any <code class="filename">Makefile</code> and
3541         <code class="filename">Makefile.in</code> for whether they define
3542         <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3543         these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
3544         programmers write so bad code that it only works for the
3545         specific combination of <code class="varname">CFLAGS</code> they have
3546         chosen.</p>
3547 </div>
3548 <div class="sect1" title="9.16. A package does not build. What shall I do?">
3549 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3550 <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
3551 <div class="procedure"><ol class="procedure" type="1">
3552 <li class="step" title="Step 1"><p>Make sure that your copy of pkgsrc is consistent. A
3553         case that occurs often is that people only update pkgsrc in
3554         parts, because of performance reasons. Since pkgsrc is one large
3555         system, not a collection of many small systems, there are
3556         sometimes changes that only work when the whole pkgsrc tree is
3557         updated.</p></li>
3558 <li class="step" title="Step 2"><p>Make sure that you don't have any CVS conflicts.
3559         Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
3560         <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
3561         files.</p></li>
3562 <li class="step" title="Step 3"><p>Make sure that you don't have old copies of the packages
3563         extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
3564         verify this.</p></li>
3565 <li class="step" title="Step 4"><p>If the problem still exists, write a mail to the
3566         <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3567 </ol></div>
3568 </div>
3569 <div class="sect1" title="9.17. What does &#8220;Makefile appears to contain unresolved cvs/rcs/??? merge conflicts&#8221; mean?">
3570 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3571 <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
3572 <p>You have modified a file from pkgsrc, and someone else has
3573 modified that same file afterwards in the CVS repository. Both changes
3574 are in the same region of the file, so when you updated pkgsrc, the
3575 <code class="literal">cvs</code> command marked the conflicting changes in the
3576 file. Because of these markers, the file is no longer a valid
3577 <code class="filename">Makefile</code>.</p>
3578 <p>Have a look at that file, and if you don't need your local changes
3579 anymore, you can remove that file and run <span class="command"><strong>cvs -q update
3580 -dP</strong></span> in that directory to download the current version.</p>
3581 </div>
3582 </div>
3583 </div>
3584 <div class="part" title="Part II. The pkgsrc developer's guide">
3585 <div class="titlepage"><div><div><h1 class="title">
3586 <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
3587 <div class="partintro" title="The pkgsrc developer's guide">
3588 <div></div>
3589 <p>This part of the book deals with creating and
3590         modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
3591         guide on creating a new package. The remaining chapters are more
3592         like a reference manual for pkgsrc.</p>
3593 <div class="toc">
3594 <p><b>Table of Contents</b></p>
3595 <dl>
3596 <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
3597 <dd><dl>
3598 <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
3599 <dd><dl>
3600 <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3601 <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
3602 <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
3603 </dl></dd>
3604 <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3605 <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>
3606 </dl></dd>
3607 <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3608 <dd><dl>
3609 <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3610 <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
3611 <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3612 <dd><dl>
3613 <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3614 <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3615 <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3616 <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3617 <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3618 </dl></dd>
3619 <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3620 <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3621 <dd><dl>
3622 <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3623 <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3624 <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3625 </dl></dd>
3626 <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3627 <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
3628 </dl></dd>
3629 <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3630 <dd><dl>
3631 <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
3632 <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
3633 <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3634 <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3635 <dd><dl>
3636 <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3637 <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3638 <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3639 <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3640 <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3641 </dl></dd>
3642 </dl></dd>
3643 <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3644 <dd><dl>
3645 <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
3646 <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3647 <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
3648 <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3649 <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
3650 <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3651 <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3652 <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3653 </dl></dd>
3654 <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3655 <dd><dl>
3656 <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
3657 <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3658 <dd><dl>
3659 <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3660 <dt><span class="sect2"><a href="#updating-buildlink-depends">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</a></span></dt>
3661 </dl></dd>
3662 <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3663 <dd><dl>
3664 <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
3665 <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3666 </dl></dd>
3667 </dl></dd>
3668 <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3669 <dd><dl>
3670 <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3671 <dd><dl>
3672 <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3673 <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3674 </dl></dd>
3675 <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3676 <dd><dl>
3677 <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3678 <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3679 <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3680 <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3681 </dl></dd>
3682 <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3683 <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
3684 <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3685 <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3686 <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3687 <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3688 <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
3689 </dl></dd>
3690 <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3691 <dd><dl>
3692 <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3693 <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
3694 <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3695 <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
3696 </dl></dd>
3697 <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3698 <dd><dl>
3699 <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3700 <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3701 <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3702 <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
3703 <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3704 <dd><dl>
3705 <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3706 <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3707 </dl></dd>
3708 <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3709 <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3710 <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3711 <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3712 <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3713 <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3714 <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3715 <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3716 <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3717 <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3718 <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3719 <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3720 </dl></dd>
3721 <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3722 <dd><dl>
3723 <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3724 <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3725 <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3726 <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3727 </dl></dd>
3728 <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3729 <dd><dl>
3730 <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3731 <dd><dl>
3732 <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
3733 <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
3734 <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3735 <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3736 <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3737 <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3738 <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3739 <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3740 <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3741 <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3742 <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3743 <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3744 </dl></dd>
3745 <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3746 <dd><dl>
3747 <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3748 <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
3749 </dl></dd>
3750 <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3751 <dd><dl>
3752 <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3753 <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3754 <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3755 </dl></dd>
3756 <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3757 <dd><dl>
3758 <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3759 <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3760 <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3761 <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3762 </dl></dd>
3763 <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3764 <dd><dl>
3765 <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3766 <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
3767 <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
3768 <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3769 </dl></dd>
3770 <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3771 <dd><dl>
3772 <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3773 <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3774 <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3775 <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3776 <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3777 <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3778 <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3779 <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
3780 <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
3781 <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
3782 <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3783 <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3784 <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3785 <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3786 <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3787 <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3788 <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3789 <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
3790     emulation</a></span></dt>
3791 <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3792 <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
3793 </dl></dd>
3794 <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
3795 </dl></dd>
3796 <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3797 <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
3798 <dd><dl>
3799 <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3800 <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3801 <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3802 <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3803 <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
3804 <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3805 <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
3806 </dl></dd>
3807 <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3808 <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3809 <dd><dl>
3810 <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3811 <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3812 <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3813 <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
3814 </dl></dd>
3815 </dl>
3816 </div>
3817 </div>
3818 <div class="chapter" title="Chapter 10. Creating a new pkgsrc package from scratch">
3819 <div class="titlepage"><div><div><h2 class="title">
3820 <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
3821 <div class="toc">
3822 <p><b>Table of Contents</b></p>
3823 <dl>
3824 <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
3825 <dd><dl>
3826 <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3827 <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
3828 <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
3829 </dl></dd>
3830 <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3831 <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
3832 </dl>
3833 </div>
3834 <p>When you find a package that is not yet in pkgsrc, you
3835 most likely have a URL from where you can download the source
3836 code. Starting with this URL, creating a package involves only a
3837 few steps.</p>
3838 <div class="procedure"><ol class="procedure" type="1">
3839 <li class="step" title="Step 1"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
3840 <li class="step" title="Step 2"><p>Then, choose one of the top-level directories as the
3841 category in which you want to place your package. You can also create a
3842 directory of your own (maybe called <code class="filename">local</code>). In that
3843 category directory, create another directory for your package and change
3844 into it.</p></li>
3845 <li class="step" title="Step 3"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
3846 you for a URL. Enter the URL of the distribution file (in most cases a
3847 <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3848 of your package are created automatically. The distribution file is
3849 extracted automatically to fill in some details in the
3850 <code class="filename">Makefile</code> that would otherwise have to be done
3851 manually.</p></li>
3852 <li class="step" title="Step 4">
3853 <p>Examine the extracted files to determine the dependencies of
3854 your package. Ideally, this is mentioned in some
3855 <code class="filename">README</code> file, but things may differ. For each of
3856 these dependencies, look where it exists in pkgsrc, and if there is a
3857 file called <code class="filename">buildlink3.mk</code> in that directory, add a
3858 line to your package <code class="filename">Makefile</code> which includes that
3859 file just before the last line. If the
3860 <code class="filename">buildlink3.mk</code> file does not exist, add a
3861 <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3862 version of the dependency and where it can be found in pkgsrc. This line
3863 should be placed in the third paragraph. If the dependency is only
3864 needed for building the package, but not when using it, use
3865 <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3866 Your package may then look like this:</p>
3867 <pre class="programlisting">
3868 [...]
3869
3870 BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
3871 DEPENDS+=       screen-[0-9]*:../../misc/screen
3872 DEPENDS+=       screen&gt;=4.0:../../misc/screen
3873
3874 [...]
3875
3876 .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3877 .include "../../devel/glib2/buildlink3.mk"
3878 .include "../../mk/bsd.pkg.mk"
3879 </pre>
3880 </li>
3881 <li class="step" title="Step 5"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
3882 to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
3883 know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3884 --explain</strong></span> or <span class="command"><strong>pkglint
3885 -e</strong></span>, which outputs additional
3886 explanations.</p></li>
3887 <li class="step" title="Step 6"><p>In many cases the package is not yet ready to build. You can
3888 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
3889 over there, you can hopefully continue here.</p></li>
3890 <li class="step" title="Step 7"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
3891 directory from the extracted files. Besides these files, a lot of cache
3892 files and other system information has been saved in the working
3893 directory, which may become wrong after you edited the
3894 <code class="filename">Makefile</code>.</p></li>
3895 <li class="step" title="Step 8"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
3896 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>
3897 <li class="step" title="Step 9"><p>When the package builds fine, the next step is to install
3898 the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
3899 everything works.</p></li>
3900 <li class="step" title="Step 10"><p>Up to now, the file <code class="filename">PLIST</code>, which
3901 contains a list of the files that are installed by the package, is
3902 nearly empty. Run <span class="command"><strong>bmake print-PLIST
3903 &gt;PLIST</strong></span> to generate a probably correct list. Check
3904 the file using your preferred text editor to see if the list of
3905 files looks plausible.</p></li>
3906 <li class="step" title="Step 11"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
3907 <code class="filename">PLIST</code> contains garbage or not.</p></li>
3908 <li class="step" title="Step 12"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
3909 has been registered in the database of installed files, but with an
3910 empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3911 and <span class="command"><strong>bmake install</strong></span> again. Now the package is
3912 registered with the list of files from
3913 <code class="filename">PLIST</code>.</p></li>
3914 <li class="step" title="Step 13"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
3915 package from the set of installed files.</p></li>
3916 </ol></div>
3917 <div class="sect1" title="10.1. Common types of packages">
3918 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3919 <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
3920 <div class="sect2" title="10.1.1. Perl modules">
3921 <div class="titlepage"><div><div><h3 class="title">
3922 <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
3923 <p>Simple Perl modules are handled automatically by
3924 <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
3925 </div>
3926 <div class="sect2" title="10.1.2. KDE applications">
3927 <div class="titlepage"><div><div><h3 class="title">
3928 <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
3929 <p>KDE applications should always include
3930 <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3931 settings that are typical of KDE packages.</p>
3932 </div>
3933 <div class="sect2" title="10.1.3. Python modules and programs">
3934 <div class="titlepage"><div><div><h3 class="title">
3935 <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3936 <p>Python modules and programs packages are easily created using a
3937 set of predefined variables.</p>
3938 <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
3939 easy-setup (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
3940 If the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, set the
3941 <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> so
3942 pkgsrc will make use of this framework.
3943 <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
3944 if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
3945 <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3946 to the name of the script.</p>
3947 <p>
3948 If the default Python versions are not supported by the software, set the
3949 <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
3950 the software is known to work with, from the most recent to the older
3951 one, e.g.
3952 </p>
3953 <pre class="programlisting">
3954 PYTHON_VERSIONS_ACCEPTED=       25 24
3955 </pre>
3956 <p>
3957 If the packaged software is a Python module, include
3958 <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;</span>.
3959 In this case, the package directory should be called
3960 <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
3961 <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
3962 </p>
3963 <pre class="programlisting">
3964 DISTNAME=   foopymodule-1.2.10
3965 PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
3966 </pre>
3967 <p>If it is an application, also include
3968 <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>
3969 before <span class="quote">&#8220;<span class="quote">extension.mk</span>&#8221;</span>.</p>
3970 <p>If the packaged software, either it is an application or a module, is
3971 egg-aware, you only need to include
3972 <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.</p>
3973 <p>In order to correctly set the path to the Python interpreter, use the
3974 <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
3975 that must be corrected. For example :
3976 </p>
3977 <pre class="programlisting">
3978 REPLACE_PYTHON=   ${WRKSRC}/*.py
3979 </pre>
3980 </div>
3981 </div>
3982 <div class="sect1" title="10.2. Examples">
3983 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3984 <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
3985 <div class="sect2" title="10.2.1. How the www/nvu package came into pkgsrc">
3986 <div class="titlepage"><div><div><h3 class="title">
3987 <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
3988 <div class="sect3" title="10.2.1.1. The initial package">
3989 <div class="titlepage"><div><div><h4 class="title">
3990 <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
3991 <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
3992 that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
3993 pkgsrc. As the description says it has to do with the web, the obvious
3994 choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
3995 <pre class="programlisting">
3996 <code class="prompt">$</code> mkdir www/nvu
3997 <code class="prompt">$</code> cd www/nvu
3998 </pre>
3999 <p>The web site says that the sources are available as a tar file, so
4000 I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
4001 <pre class="programlisting">
4002 <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4003 </pre>
4004 <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4005 below the <code class="varname">DISTNAME</code> line, as the package name should
4006 not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
4007 <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4008 <code class="varname">COMMENT</code> fields. Then the package
4009 <code class="filename">Makefile</code> looked like that:</p>
4010 <pre class="programlisting">
4011 # $NetBSD$
4012 #
4013
4014 DISTNAME=       nvu-1.0-sources
4015 PKGNAME=        nvu-1.0
4016 CATEGORIES=     www
4017 MASTER_SITES=   http://cvs.nvu.com/download/
4018 EXTRACT_SUFX=   .tar.bz2
4019
4020 MAINTAINER=     rillig@NetBSD.org
4021 HOMEPAGE=       http://cvs.nvu.com/
4022 COMMENT=        Web Authoring System
4023
4024 # url2pkg-marker (please do not remove this line.)
4025 .include "../../mk/bsd.pkg.mk"
4026 </pre>
4027 <p>Then, I quit the editor and watched pkgsrc downloading a large
4028 source archive:</p>
4029 <pre class="programlisting">
4030 url2pkg&gt; Running "make makesum" ...
4031 =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
4032 =&gt; Fetching nvu-1.0-sources.tar.bz2
4033 Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4034 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
4035 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4036 url2pkg&gt; Running "make extract" ...
4037 =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
4038 =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4039 =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4040 work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
4041 ===&gt; Installing dependencies for nvu-1.0
4042 ===&gt; Overriding tools for nvu-1.0
4043 ===&gt; Extracting for nvu-1.0
4044 url2pkg&gt; Adjusting the Makefile.
4045
4046 Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4047
4048 Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4049 </pre>
4050 </div>
4051 <div class="sect3" title="10.2.1.2. Fixing all kinds of problems to make the package work">
4052 <div class="titlepage"><div><div><h4 class="title">
4053 <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
4054 <p>Now that the package has been extracted, let's see what's inside
4055 it. The package has a <code class="filename">README.txt</code>, but that only
4056 says something about mozilla, so it's probably useless for seeing what
4057 dependencies this package has. But since there is a GNU configure script
4058 in the package, let's hope that it will complain about everything it
4059 needs.</p>
4060 <pre class="programlisting">
4061 <code class="prompt">$</code> bmake
4062 =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
4063 =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4064 =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4065 ===&gt; Patching for nvu-1.0
4066 ===&gt; Creating toolchain wrappers for nvu-1.0
4067 ===&gt; Configuring for nvu-1.0
4068 [...]
4069 configure: error: Perl 5.004 or higher is required.
4070 [...]
4071 WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4072 [...]
4073 </pre>
4074 <p>That worked quite well. So I opened the package Makefile in my
4075 editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4076 just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
4077 package have changed now, and since a perl wrapper is automatically
4078 installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
4079 from scratch.</p>
4080 <pre class="programlisting">
4081 <code class="prompt">$</code> bmake clean
4082 ===&gt; Cleaning for nvu-1.0
4083 <code class="prompt">$</code> bmake
4084 [...]
4085 *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4086 GNU Make.  You will not be able to build Mozilla without GNU Make.
4087 [...]
4088 </pre>
4089 <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
4090 <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4091 <pre class="programlisting">
4092 [...]
4093 checking for GTK - version &gt;= 1.2.0... no
4094 *** Could not run GTK test program, checking why...
4095 [...]
4096 </pre>
4097 <p>Now to the other dependencies. The first question is: Where is the
4098 GTK package hidden in pkgsrc?</p>
4099 <pre class="programlisting">
4100 <code class="prompt">$</code> echo ../../*/gtk*
4101 [many packages ...]
4102 <code class="prompt">$</code> echo ../../*/gtk
4103 ../../x11/gtk
4104 <code class="prompt">$</code> echo ../../*/gtk2
4105 ../../x11/gtk2
4106 <code class="prompt">$</code> echo ../../*/gtk2/bui*
4107 ../../x11/gtk2/buildlink3.mk
4108 </pre>
4109 <p>The first try was definitely too broad. The second one had exactly
4110 one result, which is very good. But there is one pitfall with GNOME
4111 packages. Before GNOME 2 had been released, there were already many
4112 GNOME 1 packages in pkgsrc. To be able to continue to use these
4113 packages, the GNOME 2 packages were imported as separate packages, and
4114 their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
4115 whether this was the case here, and indeed it was.</p>
4116 <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4117 file, adding the dependency is very easy. I just inserted an
4118 <code class="literal">.include</code> line before the last line of the package
4119 <code class="filename">Makefile</code>, so that it now looks like this:</p>
4120 <pre class="programlisting">
4121 [...]
4122 .include "../../x11/gtk2/buildlink3.mk"
4123 .include "../../mk/bsd.pkg.mk
4124 </pre>
4125 <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
4126 was:</p>
4127 <pre class="programlisting">
4128 [...]
4129 checking for gtk-config... /home/roland/pkg/bin/gtk-config
4130 checking for GTK - version &gt;= 1.2.0... no
4131 *** Could not run GTK test program, checking why...
4132 *** The test program failed to compile or link. See the file config.log for the
4133 *** exact error that occured. This usually means GTK was incorrectly installed
4134 *** or that you have moved GTK since it was installed. In the latter case, you
4135 *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4136 configure: error: Test for GTK failed.
4137 [...]
4138 </pre>
4139 <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
4140 prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
4141 told me that this package really wanted to have the GNOME 1 version of
4142 GTK. If the package had looked for GTK2, it would have looked for
4143 <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
4144 So I changed the <code class="literal">x11/gtk2</code> to
4145 <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4146 and tried again.</p>
4147 <pre class="programlisting">
4148 [...]
4149 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
4150 In file included from xpidl.c:42:
4151 xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4152 In file included from xpidl.c:42:
4153 xpidl.h:132: error: parse error before "IDL_ns"
4154 [...]
4155 </pre>
4156 <p>The package still does not find all of its dependencies. Now the
4157 question is: Which package provides the
4158 <code class="filename">libIDL/IDL.h</code> header file?</p>
4159 <pre class="programlisting">
4160 <code class="prompt">$</code> echo ../../*/*idl*
4161 ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4162 <code class="prompt">$</code> echo ../../*/*IDL*
4163 ../../net/libIDL
4164 </pre>
4165 <p>Let's take the one from the second try. So I included the
4166 <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4167 again. But the error didn't change. After digging through some of the
4168 code, I concluded that the build process of the package was broken and
4169 couldn't have ever worked, but since the Mozilla source tree is quite
4170 large, I didn't want to fix it. So I added the following to the package
4171 <code class="filename">Makefile</code> and tried again:</p>
4172 <pre class="programlisting">
4173 CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4174 BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
4175 </pre>
4176 <p>The latter line is needed because the package expects the library
4177 <code class="filename">libIDL.so</code>, but only
4178 <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4179 wrapper to rewrite that on the fly.</p>
4180 <p>The next problem was related to a recent change of the FreeType
4181 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>
4182 which patch files were relevant for this issue and copied them to the
4183 <code class="filename">patches</code> directory. Then I retried, fixed the
4184 patches so that they applied cleanly and retried again. This time,
4185 everything worked.</p>
4186 </div>
4187 <div class="sect3" title="10.2.1.3. Installing the package">
4188 <div class="titlepage"><div><div><h4 class="title">
4189 <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
4190 <pre class="programlisting">
4191 <code class="prompt">$</code> bmake CHECK_FILES=no install
4192 [...]
4193 <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
4194 <code class="prompt">$</code> bmake deinstall
4195 <code class="prompt">$</code> bmake install
4196 </pre>
4197 </div>
4198 </div>
4199 </div>
4200 </div>
4201 <div class="chapter" title="Chapter 11. Package components - files, directories and contents">
4202 <div class="titlepage"><div><div><h2 class="title">
4203 <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
4204 <div class="toc">
4205 <p><b>Table of Contents</b></p>
4206 <dl>
4207 <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4208 <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
4209 <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4210 <dd><dl>
4211 <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4212 <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4213 <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4214 <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4215 <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4216 </dl></dd>
4217 <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4218 <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4219 <dd><dl>
4220 <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4221 <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4222 <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
4223 </dl></dd>
4224 <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4225 <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
4226 </dl>
4227 </div>
4228 <p>Whenever you're preparing a package, there are a number of
4229 files involved which are described in the following
4230 sections.</p>
4231 <div class="sect1" title="11.1. Makefile">
4232 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4233 <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
4234 </h2></div></div></div>
4235 <p>Building, installation and creation of a binary package are all
4236   controlled by the package's <code class="filename">Makefile</code>.
4237   The <code class="filename">Makefile</code> describes various things about
4238   a package, for example from where to get it, how to configure,
4239   build, and install it.</p>
4240 <p>A package <code class="filename">Makefile</code> contains several
4241   sections that describe the package.</p>
4242 <p>In the first section there are the following variables, which
4243   should appear exactly in the order given here.  The order and
4244   grouping of the variables is mostly historical and has no further
4245   meaning.</p>
4246 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4247 <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
4248     distribution file to be downloaded from the package's
4249     website.</p></li>
4250 <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
4251     package, as used by pkgsrc. You only need to provide it if
4252     <code class="varname">DISTNAME</code> (which is the default) is not a good
4253     name for the package in pkgsrc.  Usually it is the pkgsrc
4254     directory name together with the version number. It must match the
4255     regular expression
4256     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4257     starts with a letter or digit, and contains only letters, digits,
4258     dashes, underscores, dots and plus signs.</p></li>
4259 <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
4260     the package file to create if the <code class="varname">PKGNAME</code>
4261     isn't unique on a SVR4 system. The default is
4262     <code class="varname">PKGNAME</code>, which may be shortened when you use
4263     <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
4264     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4265     does not produce an unique package name on a SVR4 system.
4266     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4267     characters.</p></li>
4268 <li class="listitem">
4269 <p><code class="varname">CATEGORIES</code> is a list of categories
4270     which the package fits in. You can choose any of the top-level
4271     directories of pkgsrc for it.</p>
4272 <p>Currently the following values are available for
4273     <code class="varname">CATEGORIES</code>. If more than
4274     one is used, they need to be separated by spaces:</p>
4275 <pre class="programlisting">
4276 archivers     cross         geography     meta-pkgs     security
4277 audio         databases     graphics      misc          shells
4278 benchmarks    devel         ham           multimedia    sysutils
4279 biology       editors       inputmethod   net           textproc
4280 cad           emulators     lang          news          time
4281 chat          finance       mail          parallel      wm
4282 comms         fonts         math          pkgtools      www
4283 converters    games         mbone         print         x11
4284 </pre>
4285 </li>
4286 <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
4287     <code class="varname">DYNAMIC_MASTER_SITES</code>,
4288     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4289     and <code class="varname">DISTFILES</code> are discussed in detail in
4290     <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
4291 </ul></div>
4292 <p>The second section contains information about separately
4293   downloaded patches, if any.
4294   </p>
4295 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4296 <li class="listitem"><p><code class="varname">PATCHFILES:</code>
4297     Name(s) of additional files that contain distribution patches.
4298     There is no default. pkgsrc will look for them at
4299     <code class="varname">PATCH_SITES</code>.
4300     They will automatically be uncompressed before patching if
4301     the names end with <code class="filename">.gz</code> or
4302     <code class="filename">.Z</code>.</p></li>
4303 <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
4304     Primary location(s) for distribution patch files (see
4305     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4306 </ul></div>
4307 <p>The third section contains the following variables.
4308   </p>
4309 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4310 <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
4311     address of the person who feels responsible for this package,
4312     and who is most likely to look at problems or questions regarding
4313     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>.
4314     Other developers may contact the <code class="varname">MAINTAINER</code>
4315     before making changes to the package, but are not required to
4316     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4317     to yourself. If you really can't maintain the package for future
4318     updates, set it to
4319     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
4320 <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
4321     of <code class="varname">MAINTAINER</code> when you do not want other
4322     developers to update or change the package without contacting
4323     you first. A package Makefile should contain one of
4324     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4325     not both.  </p></li>
4326 <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
4327     find more information about the package.</p></li>
4328 <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
4329     description of the package (should not include the package
4330     name).</p></li>
4331 </ul></div>
4332 <p>Other variables that affect the build:
4333   </p>
4334 <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
4335 <p><code class="varname">WRKSRC</code>: The directory where the
4336       interesting distribution files of the package are found. The
4337       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4338       works for most packages.</p>
4339 <p>If a package doesn't create a subdirectory for itself
4340       (most GNU software does, for instance), but extracts itself in
4341       the current directory, you should set
4342       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4343 <p>If a package doesn't create a subdirectory with the
4344       name of <code class="varname">DISTNAME</code> but some different name,
4345       set <code class="varname">WRKSRC</code> to point to the proper name in
4346       <code class="filename">${WRKDIR}</code>, for example
4347       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4348       <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>
4349 <p>The name of the working directory created by pkgsrc is
4350       taken from the <code class="varname">WRKDIR_BASENAME</code>
4351       variable. By default, its value is
4352       <code class="filename">work</code>. If you want to use the same
4353       pkgsrc tree for building different kinds of binary packages,
4354       you can change the variable according to your needs. Two
4355       other variables handle common cases of setting
4356       <code class="varname">WRKDIR_BASENAME</code> individually. If
4357       <code class="varname">OBJHOSTNAME</code> is defined in
4358       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
4359       the host's name is attached to the directory name. If
4360       <code class="varname">OBJMACHINE</code> is defined, the platform name
4361       is attached, which might look like
4362       <code class="filename">work.i386</code> or
4363       <code class="filename">work.sparc</code>.</p>
4364 </li></ul></div>
4365 <p>Please pay attention to the following gotchas:</p>
4366 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4367 <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
4368       installed in compressed form by the package.  For packages using
4369       BSD-style makefiles which honor MANZ, there is
4370       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
4371 <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4372       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
4373       below).</p></li>
4374 <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
4375 </ul></div>
4376 </div>
4377 <div class="sect1" title="11.2. distinfo">
4378 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4379 <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
4380 </h2></div></div></div>
4381 <p>The <code class="filename">distinfo</code> file contains the message
4382   digest, or checksum, of each distfile needed for the package. This
4383   ensures that the distfiles retrieved from the Internet have not been
4384   corrupted during transfer or altered by a malign force to introduce
4385   a security hole. Due to recent rumor about weaknesses of digest
4386   algorithms, all distfiles are protected using both SHA1 and RMD160
4387   message digests, as well as the file size.</p>
4388 <p>The <code class="filename">distinfo</code> file also contains the
4389   checksums for all the patches found in the
4390   <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>
4391 <p>To regenerate the <code class="filename">distinfo</code> file, use the
4392   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
4393   command.</p>
4394 <p>Some packages have different sets of distfiles depending on
4395   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
4396   <code class="filename">distinfo</code> file and care should be taken when
4397   upgrading such a package to ensure distfile information is not
4398   lost.</p>
4399 </div>
4400 <div class="sect1" title="11.3. patches/*">
4401 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4402 <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
4403 <p>Many packages still don't work out-of-the box on the various
4404   platforms that are supported by pkgsrc. Therefore, a number of custom
4405   patch files are needed to make the package work. These patch files are
4406   found in the <code class="filename">patches/</code> directory.</p>
4407 <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4408   applied to the files in <code class="varname">WRKSRC</code> directory after
4409   extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4410   order</a>.</p>
4411 <div class="sect2" title="11.3.1. Structure of a single patch file">
4412 <div class="titlepage"><div><div><h3 class="title">
4413 <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
4414 <p>The <code class="filename">patch-*</code> files should be in
4415   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
4416   problems. (To force patches to apply with fuzz you can set
4417   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4418   should contain only changes for a single file, and no file should be
4419   patched by more than one patch file. This helps to keep future
4420   modifications simple.</p>
4421 <p>Each patch file is structured as follows: In the first line,
4422   there is the RCS Id of the patch itself. The second line should be
4423   empty for aesthetic reasons. After that, there should be a comment for
4424   each change that the patch does. There are a number of standard
4425   cases:</p>
4426 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4427 <li class="listitem"><p>Patches for commonly known vulnerabilities should
4428   mention the vulnerability ID (CAN, CVE).</p></li>
4429 <li class="listitem"><p>Patches that change source code should mention the
4430   platform and other environment (for example, the compiler) that the
4431   patch is needed for.</p></li>
4432 </ul></div>
4433 <p>In all, the patch should be commented so that any
4434   developer who knows the code of the application can make some use of
4435   the patch. Special care should be taken for the upstream developers,
4436   since we generally want that they accept our patches, so we have less
4437   work in the future.</p>
4438 </div>
4439 <div class="sect2" title="11.3.2. Creating patch files">
4440 <div class="titlepage"><div><div><h3 class="title">
4441 <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
4442 <p>One important thing to mention is to pay attention that no RCS
4443   IDs get stored in the patch files, as these will cause problems when
4444   later checked into the NetBSD CVS tree. Use the
4445   <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
4446   problems.</p>
4447 <p>For even more automation, we recommend using
4448   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
4449   whole set of patches. You just have to backup files before you
4450   edit them to <code class="filename">filename.orig</code>, e.g. with
4451   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4452   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
4453   you upgrade a package this way, you can easily compare the new
4454   set of patches with the previously existing one with
4455   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4456   are replaced by new files, so carefully check if you want to take all
4457   the changes.</p>
4458 <p>When you have finished a package, remember to generate
4459   the checksums for the patch files by using the <span class="command"><strong>make
4460   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="11.2. distinfo">Section 11.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
4461 <p>When adding a patch that corrects a problem in the
4462   distfile (rather than e.g. enforcing pkgsrc's view of where
4463   man pages should go), send the patch as a bug report to the
4464   maintainer.  This benefits non-pkgsrc users of the package,
4465   and usually makes it possible to remove the patch in future
4466   version.</p>
4467 <p>The file names of the patch files are usually of the form
4468   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4469   Many packages still use the previous convention
4470   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4471   but new patches should be of the form containing the filename.
4472   <span class="command"><strong>mkpatches</strong></span> included in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
4473   automatically.</p>
4474 </div>
4475 <div class="sect2" title="11.3.3. Sources where the patch files come from">
4476 <div class="titlepage"><div><div><h3 class="title">
4477 <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
4478 <p>If you want to share patches between multiple packages
4479   in pkgsrc, e.g. because they use the same distfiles, set
4480   <code class="varname">PATCHDIR</code> to the path where the patch files
4481   can be found, e.g.:</p>
4482 <pre class="programlisting">
4483 PATCHDIR= ${.CURDIR}/../xemacs/patches
4484 </pre>
4485 <p>Patch files that are distributed by the author or other
4486     maintainers can be listed in
4487     <code class="varname">PATCHFILES</code>.</p>
4488 <p>If it is desired to store any patches that should not be
4489     committed into pkgsrc, they can be kept outside the pkgsrc
4490     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4491     directory tree there is expected to have the same
4492     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
4493     patches are expected to be stored inside these dirs (also
4494     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4495     example, if you want to keep a private patch for
4496     <code class="filename">pkgsrc/graphics/png</code>, keep it in
4497     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4498     files in the named directory are expected to be patch files,
4499     and <span class="emphasis"><em>they are applied after pkgsrc patches are
4500     applied</em></span>.</p>
4501 </div>
4502 <div class="sect2" title="11.3.4. Patching guidelines">
4503 <div class="titlepage"><div><div><h3 class="title">
4504 <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
4505 <p>When fixing a portability issue in the code do not use
4506       preprocessor magic to check for the current operating system nor
4507       platform.  Doing so hurts portability to other platforms because
4508       the OS-specific details are not abstracted appropriately.</p>
4509 <p>The general rule to follow is: instead of checking for the
4510       operating system the application is being built on, check for the
4511       specific <span class="emphasis"><em>features</em></span> you need.  For example,
4512       instead of assuming that kqueue is available under NetBSD and
4513       using the <code class="varname">__NetBSD__</code> macro to conditionalize
4514       kqueue support, add a check that detects kqueue itself &mdash;
4515       yes, this generally involves patching the
4516       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
4517       that prevents some OSes from adopting interfaces from other OSes
4518       (e.g. Linux implementing kqueue), something that the above checks
4519       cannot take into account.</p>
4520 <p>Of course, checking for features generally involves more
4521       work on the developer's side, but the resulting changes are
4522       cleaner and there are chances they will work on many other
4523       platforms.  Not to mention that there are higher chances of being
4524       later integrated into the mainstream sources.  Remember:
4525       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4526 <p>Some typical examples:</p>
4527 <div class="table">
4528 <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
4529 <div class="table-contents"><table summary="Patching examples" border="1">
4530 <colgroup>
4531 <col>
4532 <col>
4533 <col>
4534 </colgroup>
4535 <thead><tr>
4536 <th>Where</th>
4537 <th>Incorrect</th>
4538 <th>Correct</th>
4539 </tr></thead>
4540 <tbody>
4541 <tr>
4542 <td>configure script</td>
4543 <td>
4544 <pre class="programlisting">
4545 case ${target_os} in
4546 netbsd*) have_kvm=yes ;;
4547 *)       have_kvm=no  ;;
4548 esac
4549 </pre>
4550               </td>
4551 <td>
4552 <pre class="programlisting">
4553 AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4554 </pre>
4555               </td>
4556 </tr>
4557 <tr>
4558 <td>C source file</td>
4559 <td>
4560 <pre class="programlisting">
4561 #if defined(__NetBSD__)
4562 #  include &lt;sys/event.h&gt;
4563 #endif
4564 </pre>
4565               </td>
4566 <td>
4567 <pre class="programlisting">
4568 #if defined(HAVE_SYS_EVENT_H)
4569 #  include &lt;sys/event.h&gt;
4570 #endif
4571 </pre>
4572               </td>
4573 </tr>
4574 <tr>
4575 <td>C source file</td>
4576 <td>
4577 <pre class="programlisting">
4578 int
4579 monitor_file(...)
4580 {
4581 #if defined(__NetBSD__)
4582         int fd = kqueue();
4583         ...
4584 #else
4585         ...
4586 #endif
4587 }
4588 </pre>
4589               </td>
4590 <td>
4591 <pre class="programlisting">
4592 int
4593 monitor_file(...)
4594 {
4595 #if defined(HAVE_KQUEUE)
4596         int fd = kqueue();
4597         ...
4598 #else
4599         ...
4600 #endif
4601 }
4602 </pre>
4603               </td>
4604 </tr>
4605 </tbody>
4606 </table></div>
4607 </div>
4608 <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
4609       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
4610       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4611       2</a>).  It summarizes multiple details on how to make
4612       software easier to package; all the suggestions in it were
4613       collected from our experience in pkgsrc work, so they are possibly
4614       helpful when creating patches too.</p>
4615 </div>
4616 <div class="sect2" title="11.3.5. Feedback to the author">
4617 <div class="titlepage"><div><div><h3 class="title">
4618 <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
4619 <p>Always, always, <span class="strong"><strong>always</strong></span>
4620       feed back any <span class="emphasis"><em>portability fixes</em></span> or
4621       improvements you do to a package to the mainstream developers.
4622       This is the only way to get their attention on portability issues
4623       and to ensure that future versions can be built out-of-the box on
4624       NetBSD.  Furthermore, any user that gets newer distfiles will get
4625       the fixes straight from the packaged code.</p>
4626 <p>This generally involves cleaning up the patches
4627       (because sometimes the patches that are
4628       added to pkgsrc are quick hacks), filling bug reports in the
4629       appropriate trackers for the projects and working with the
4630       mainstream authors to accept your changes.  It is
4631       <span class="emphasis"><em>extremely important</em></span> that you do it so that
4632       the packages in pkgsrc are kept simple and thus further changes
4633       can be done without much hassle.</p>
4634 <p>When you have done this, please add a URL to the upstream
4635       bug report to the patch comment.</p>
4636 <p>Support the idea of free software!</p>
4637 </div>
4638 </div>
4639 <div class="sect1" title="11.4. Other mandatory files">
4640 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4641 <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
4642 <div class="variablelist"><dl>
4643 <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4644 <dd><p>A multi-line description of the piece of software.  This should include
4645           any credits where they are due.  Please bear in mind that others do not
4646           share your sense of humour (or spelling idiosyncrasies), and that others
4647           will read everything that you write here.</p></dd>
4648 <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4649 <dd><p>This file governs the files that are installed on your
4650           system: all the binaries, manual pages, etc. There are other
4651           directives which may be entered in this file, to control the
4652           creation and deletion of directories, and the location of
4653           inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
4654           information.</p></dd>
4655 </dl></div>
4656 </div>
4657 <div class="sect1" title="11.5. Optional files">
4658 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4659 <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
4660 <div class="sect2" title="11.5.1. Files affecting the binary package">
4661 <div class="titlepage"><div><div><h3 class="title">
4662 <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
4663 <div class="variablelist"><dl>
4664 <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
4665 <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>.
4666             First time after package extraction and before files are
4667             moved in place, the second time after the files to install
4668             are moved in place. This can be used to do any custom
4669             procedures not possible with @exec commands in
4670             <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
4671             <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>
4672 <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4673 <dd><p>This script is executed before and after any files are removed.  It is
4674             this script's responsibility to clean up any additional messy details
4675             around the package's installation, since all pkg_delete knows is how to
4676             delete the files created in the original distribution.
4677             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>
4678             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>
4679 <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4680 <dd>
4681 <p>This file is displayed after installation of the package.
4682             Useful for things like legal notices on almost-free
4683             software and hints for updating config files after
4684             installing modules for apache, PHP etc.
4685             Please note that you can modify variables in it easily by using
4686             <code class="varname">MESSAGE_SUBST</code> in the package's
4687             <code class="filename">Makefile</code>:</p>
4688 <pre class="programlisting">
4689 MESSAGE_SUBST+=  SOMEVAR="somevalue"
4690 </pre>
4691 <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
4692             <code class="filename">MESSAGE</code>.  By default, substitution is
4693             performed for <code class="varname">PKGNAME</code>,
4694             <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4695             <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4696             <code class="varname">X11BASE</code>,
4697             <code class="varname">PKG_SYSCONFDIR</code>,
4698             <code class="varname">ROOT_GROUP</code>, and
4699             <code class="varname">ROOT_USER</code>.</p>
4700 <p>You can display a different or additional files by
4701             setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
4702             default is <code class="filename">MESSAGE</code>, if the file
4703             exists.</p>
4704 </dd>
4705 <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4706 <dd><p>FIXME: There is no documentation on the
4707         alternatives framework.</p></dd>
4708 </dl></div>
4709 </div>
4710 <div class="sect2" title="11.5.2. Files affecting the build process">
4711 <div class="titlepage"><div><div><h3 class="title">
4712 <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
4713 <div class="variablelist"><dl>
4714 <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4715 <dd><p>This file contains arbitrary things that could
4716         also go into a <code class="filename">Makefile</code>, but its purpose is
4717         to be used by more than one package. This file should only be
4718         used when the packages that will use the file are known in
4719         advance. For other purposes it is often better to write a
4720         <code class="filename">*.mk</code> file and give it a good name that
4721         describes what it does.</p></dd>
4722 <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4723 <dd><p>This file contains the dependency information
4724         for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
4725 <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4726 <dd><p>This file contains workarounds for compiler bugs
4727         and similar things. It is included automatically by the pkgsrc
4728         infrastructure, so you don't need an extra
4729         <code class="literal">.include</code> line for
4730         it.</p></dd>
4731 <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4732 <dd><p>This file contains the code for the
4733         package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4734         selected by the user. If a package has only one or two options,
4735         it is equally acceptable to put the code directly into the
4736         <code class="filename">Makefile</code>.</p></dd>
4737 </dl></div>
4738 </div>
4739 <div class="sect2" title="11.5.3. Files affecting nothing at all">
4740 <div class="titlepage"><div><div><h3 class="title">
4741 <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
4742 <div class="variablelist"><dl>
4743 <dt><span class="term"><code class="filename">README*</code></span></dt>
4744 <dd><p>These files do not take place in the creation of
4745         a package and thus are purely informative to the package
4746         developer.</p></dd>
4747 <dt><span class="term"><code class="filename">TODO</code></span></dt>
4748 <dd><p>This file contains things that need to be done
4749         to make the package even
4750         better.</p></dd>
4751 </dl></div>
4752 </div>
4753 </div>
4754 <div class="sect1" title="11.6. work*">
4755 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4756 <a name="work-dir"></a>11.6. <code class="filename">work*</code>
4757 </h2></div></div></div>
4758 <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4759     unpacked into the directory denoted by
4760     <code class="varname">WRKDIR</code>. It can be removed by running
4761     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4762     directory is also used to keep various timestamp files.
4763     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4764     The default is <code class="filename">${.CURDIR}/work</code>
4765     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4766     if <code class="varname">OBJMACHINE</code> is set.</p>
4767 </div>
4768 <div class="sect1" title="11.7. files/*">
4769 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4770 <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
4771 </h2></div></div></div>
4772 <p>If you have any files that you wish to be placed in the package prior
4773     to configuration or building, you could place these files here and use
4774     a <span class="command"><strong>${CP}</strong></span> command in the
4775     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
4776     this. Alternatively, you could simply diff the file against
4777     <code class="filename">/dev/null</code> and use the patch mechanism to manage
4778     the creation of this file.</p>
4779 <p>If you want to share files in this way with other
4780     packages, set the <code class="varname">FILESDIR</code> variable to point
4781     to the other package's <code class="filename">files</code> directory,
4782     e.g.:</p>
4783 <pre class="programlisting">
4784 FILESDIR=${.CURDIR}/../xemacs/files
4785 </pre>
4786 </div>
4787 </div>
4788 <div class="chapter" title="Chapter 12. Programming in Makefiles">
4789 <div class="titlepage"><div><div><h2 class="title">
4790 <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
4791 <div class="toc">
4792 <p><b>Table of Contents</b></p>
4793 <dl>
4794 <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
4795 <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
4796 <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4797 <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4798 <dd><dl>
4799 <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4800 <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4801 <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4802 <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4803 <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
4804 </dl></dd>
4805 </dl>
4806 </div>
4807 <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4808   each of which forms a well-defined part of the pkgsrc system. Using
4809   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
4810   like pkgsrc requires some discipline to keep the code correct and
4811   understandable.</p>
4812 <p>The basic ingredients for <code class="filename">Makefile</code>
4813   programming are variables (which are actually macros) and shell
4814   commands. Among these shell commands may even be more complex ones
4815   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
4816   as intended it is necessary to quote all variables correctly when they
4817   are used.</p>
4818 <p>This chapter describes some patterns, that appear quite often in
4819   <code class="filename">Makefile</code>s, including the pitfalls that come along
4820   with them.</p>
4821 <div class="sect1" title="12.1. Caveats">
4822 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4823 <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
4824 <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
4825 <p>When you are creating a file as a
4826     target of a rule, always write the data to a temporary file first
4827     and finally rename that file. Otherwise there might occur an error
4828     in the middle of generating the file, and when the user runs
4829     <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
4830     regenerated properly. Example:</p>
4831 <pre class="programlisting">
4832 wrong:
4833         @echo "line 1" &gt; ${.TARGET}
4834         @echo "line 2" &gt;&gt; ${.TARGET}
4835         @false
4836
4837 correct:
4838         @echo "line 1" &gt; ${.TARGET}.tmp
4839         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
4840         @false
4841         @mv ${.TARGET}.tmp ${.TARGET}
4842 </pre>
4843 <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
4844     <code class="filename">wrong</code> will exist, although there was an error
4845     message in the first run. On the other hand, running <span class="command"><strong>make
4846     correct</strong></span> gives an error message twice, as expected.</p>
4847 <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
4848     <code class="literal">${.TARGET}</code> in case of error, but this only
4849     happens when it is interrupted, for example by pressing
4850     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
4851     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>
4852 </li></ul></div>
4853 </div>
4854 <div class="sect1" title="12.2. Makefile variables">
4855 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4856 <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
4857 <p><code class="filename">Makefile</code> variables contain strings that
4858     can be processed using the five operators ``='', ``+='', ``?='',
4859     ``:='', 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
4860     page.</p>
4861 <p>When a variable's value is parsed from a
4862     <code class="filename">Makefile</code>, the hash character ``#'' and the
4863     backslash character ``\'' are handled specially. If a backslash is
4864     followed by a newline, any whitespace immediately in front of the
4865     backslash, the backslash, the newline, and any whitespace
4866     immediately behind the newline are replaced with a single space. A
4867     backslash character and an immediately following hash character are
4868     replaced with a single hash character. Otherwise, the backslash is
4869     passed as is. In a variable assignment, any hash character that is
4870     not preceded by a backslash starts a comment that continues upto the
4871     end of the logical line.</p>
4872 <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4873     the only way to create a variable consisting of a single backslash
4874     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4875 <p>So far for defining variables. The other thing you can do with
4876     variables is evaluating them. A variable is evaluated when it is
4877     part of the right side of the ``:='' or the ``!='' operator, or
4878     directly before executing a shell command which the variable is part
4879     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
4880     is, variables are not evaluated until there's no other way. The
4881     ``modifiers'' mentioned in the man page also evaluate the
4882     variable.</p>
4883 <p>Some of the modifiers split the string into words and then
4884     operate on the words, others operate on the string as a whole. When
4885     a string is split into words, it is split as you would expect
4886     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>
4887 <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
4888     loop does not follow the shell quoting rules but splits at sequences
4889     of whitespace.</p>
4890 <p>There are several types of variables that should be handled
4891     differently. Strings and two types of lists.</p>
4892 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4893 <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4894       characters. Nevertheless, you should restrict yourself to only
4895       using printable characters. Examples are
4896       <code class="varname">PREFIX</code> and
4897       <code class="varname">COMMENT</code>.</p></li>
4898 <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4899       are never exported to any shell command. Their elements are
4900       separated by whitespace. Therefore, the elements themselves cannot
4901       have embedded whitespace. Any other characters are allowed.
4902       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
4903       Examples are <code class="varname">DEPENDS</code> and
4904       <code class="varname">BUILD_DEPENDS</code>.</p></li>
4905 <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
4906       may be exported to a shell command. Their elements can contain any
4907       characters, including whitespace. That's why they cannot be used
4908       in <span class="command"><strong>.for</strong></span> loops. Examples are
4909       <code class="varname">DISTFILES</code> and
4910       <code class="varname">MASTER_SITES</code>.</p></li>
4911 </ul></div>
4912 <div class="sect2" title="12.2.1. Naming conventions">
4913 <div class="titlepage"><div><div><h3 class="title">
4914 <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
4915 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4916 <li class="listitem"><p>All variable names starting with an underscore
4917         are reserved for use by the pkgsrc infrastructure. They shall
4918         not be used by package
4919         <code class="filename">Makefile</code>s.</p></li>
4920 <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
4921         lowercase variable names for the iteration
4922         variables.</p></li>
4923 <li class="listitem"><p>All list variables should have a ``plural''
4924         name, e.g. <code class="varname">PKG_OPTIONS</code> or
4925         <code class="varname">DISTFILES</code>.</p></li>
4926 </ul></div>
4927 </div>
4928 </div>
4929 <div class="sect1" title="12.3. Code snippets">
4930 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4931 <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
4932 <p>This section presents you with some code snippets you should
4933     use in your own code. If you don't find anything appropriate here,
4934     you should test your code and add it here.</p>
4935 <div class="sect2" title="12.3.1. Adding things to a list">
4936 <div class="titlepage"><div><div><h3 class="title">
4937 <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
4938 <pre class="programlisting">
4939 STRING=                 foo * bar `date`
4940 INT_LIST=               # empty
4941 ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
4942 EXT_LIST=               # empty
4943 ANOTHER_EXT_LIST=       a=b c=d
4944
4945 INT_LIST+=              ${STRING}               # 1
4946 INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
4947 EXT_LIST+=              ${STRING:Q}             # 3
4948 EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
4949 </pre>
4950 <p>When you add a string to an external list (example 3), it
4951       must be quoted. In all other cases, you must not add a quoting
4952       level. You must not merge internal and external lists, unless you
4953       are sure that all entries are correctly interpreted in both
4954       lists.</p>
4955 </div>
4956 <div class="sect2" title="12.3.2. Converting an internal list into an external list">
4957 <div class="titlepage"><div><div><h3 class="title">
4958 <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
4959 <pre class="programlisting">
4960 EXT_LIST=       # empty
4961 .for i in ${INT_LIST}
4962 EXT_LIST+=      ${i:Q}""
4963 .endfor
4964 </pre>
4965 <p>This code converts the internal list
4966       <code class="varname">INT_LIST</code> into the external list
4967       <code class="varname">EXT_LIST</code>. As the elements of an internal list
4968       are unquoted they must be quoted here. The reason for appending
4969       <code class="varname">""</code> is explained below.</p>
4970 </div>
4971 <div class="sect2" title="12.3.3. Passing variables to a shell command">
4972 <div class="titlepage"><div><div><h3 class="title">
4973 <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
4974 <p>Sometimes you may want to print an arbitrary string. There
4975         are many ways to get it wrong and only few that can handle every
4976         nastiness.</p>
4977 <pre class="programlisting">
4978 STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
4979 EXT_LIST=       string=${STRING:Q} x=second\ item
4980
4981 all:
4982         echo ${STRING}                  # 1
4983         echo "${STRING}"                # 2
4984         echo "${STRING:Q}"              # 3
4985         echo ${STRING:Q}                # 4
4986         echo x${STRING:Q} | sed 1s,.,,  # 5
4987         printf "%s\\n" ${STRING:Q}""    # 6
4988         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
4989 </pre>
4990 <p>Example 1 leads to a syntax error in the shell, as the
4991       characters are just copied.</p>
4992 <p>Example 2 leads to a syntax error too, and if you leave out
4993       the last " character from <code class="varname">${STRING}</code>,
4994       <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
4995       variable would be evaluated, too.</p>
4996 <p>Example 3 outputs each space character preceded by a
4997       backslash (or not), depending on the implementation of the
4998       <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>
4999 <p>Example 4 handles correctly every string that does not start
5000       with a dash. In that case, the result depends on the
5001       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
5002       guarantee that your input does not start with a dash, this form is
5003       appropriate.</p>
5004 <p>Example 5 handles even the case of a leading dash
5005       correctly.</p>
5006 <p>Example 6 also works with every string and is the
5007       light-weight solution, since it does not involve a pipe, which has
5008       its own problems.</p>
5009 <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5010       because the quoting has already been done when adding elements to
5011       the list.</p>
5012 <p>As internal lists shall not be passed to the shell, there is
5013       no example for it.</p>
5014 </div>
5015 <div class="sect2" title="12.3.4. Quoting guideline">
5016 <div class="titlepage"><div><div><h3 class="title">
5017 <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
5018 <p>There are many possible sources of wrongly quoted variables.
5019       This section lists some of the commonly known ones.</p>
5020 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5021 <li class="listitem">
5022 <p>Whenever you use the value of a list, think
5023         about what happens to leading or trailing whitespace. If the
5024         list is a well-formed shell expression, you can apply the
5025         <code class="varname">:M*</code> modifier to strip leading and trailing
5026         whitespace from each word. The <code class="varname">:M</code> operator
5027         first splits its argument according to the rules of the shell,
5028         and then creates a new list consisting of all words that match
5029         the shell glob expression <code class="varname">*</code>, that is: all.
5030         One class of situations where this is needed is when adding a
5031         variable like <code class="varname">CPPFLAGS</code> to
5032         <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5033         invokes other configure scripts, it strips the leading and
5034         trailing whitespace from the variable and then passes it to the
5035         other configure scripts. But these configure scripts expect the
5036         (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5037         the parent <code class="varname">CPPFLAGS</code>. That's why we better
5038         pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5039         here is how we do it:</p>
5040 <pre class="programlisting">
5041 CPPFLAGS=               # empty
5042 CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
5043 CPPFLAGS+=              ${MY_CPPFLAGS}
5044
5045 CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
5046
5047 all:
5048         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
5049         echo x${CONFIGURE_ARGS}x        # properly trimmed
5050 </pre>
5051 </li>
5052 <li class="listitem"><p>The example above contains one bug: The
5053         <code class="varname">${PREFIX}</code> is a properly quoted shell
5054         expression, but there is the C compiler after it, which also
5055         expects a properly quoted string (this time in C syntax). The
5056         version above is therefore only correct if
5057         <code class="varname">${PREFIX}</code> does not have embedded backslashes
5058         or double quotes. If you want to allow these, you have to add
5059         another layer of quoting to each variable that is used as a C
5060         string literal. You cannot use the <code class="varname">:Q</code>
5061         operator for it, as this operator only works for the
5062         shell.</p></li>
5063 <li class="listitem">
5064 <p>Whenever a variable can be empty, the
5065         <code class="varname">:Q</code> operator can have surprising results. Here
5066         are two completely different cases which can be solved with the
5067         same trick.</p>
5068 <pre class="programlisting">
5069 EMPTY=                  # empty
5070 empty_test:
5071         for i in a ${EMPTY:Q} c; do \
5072             echo "$$i"; \
5073         done
5074
5075 for_test:
5076 .for i in a:\ a:\test.txt
5077         echo ${i:Q}
5078         echo "foo"
5079 .endfor
5080 </pre>
5081 <p>The first example will only print two of the three lines
5082         we might have expected. This is because
5083         <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5084         the shell cannot see. The workaround is to write
5085         <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5086         as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5087         -f ${FNAME:Q}</code> (both of these are wrong).</p>
5088 <p>The second example will only print three lines instead of
5089         four. The first line looks like <code class="varname">a:\ echo foo</code>.
5090         This is because the backslash of the value
5091         <code class="varname">a:\</code> is interpreted as a line-continuation by
5092         <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
5093         <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
5094         <code class="varname">${i:Q}""</code>.</p>
5095 </li>
5096 </ul></div>
5097 </div>
5098 <div class="sect2" title="12.3.5. Workaround for a bug in BSD Make">
5099 <div class="titlepage"><div><div><h3 class="title">
5100 <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
5101 <p>The pkgsrc bmake program does not handle the following
5102       assignment correctly. In case <code class="varname">_othervar_</code>
5103       contains a ``-'' character, one of the closing braces is included
5104       in <code class="varname">${VAR}</code> after this code executes.</p>
5105 <pre class="programlisting">
5106 VAR:=   ${VAR:N${_othervar_:C/-//}}
5107 </pre>
5108 <p>For a more complex code snippet and a workaround, see the
5109       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
5110       <code class="varname">bug1</code>.</p>
5111 </div>
5112 </div>
5113 </div>
5114 <div class="chapter" title="Chapter 13. PLIST issues">
5115 <div class="titlepage"><div><div><h2 class="title">
5116 <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
5117 <div class="toc">
5118 <p><b>Table of Contents</b></p>
5119 <dl>
5120 <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
5121 <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5122 <dt><span class="sect1"><a href="#print-PLIST">13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
5123 <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5124 <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
5125 <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5126 <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5127 <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
5128 </dl>
5129 </div>
5130 <p>The <code class="filename">PLIST</code> file contains a package's
5131   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
5132   the package (relative to the <code class="filename">${PREFIX}</code>
5133   directory it's been installed in) plus some additional statements
5134   - 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.
5135   This chapter addresses some issues that need attention when
5136   dealing with the <code class="filename">PLIST</code> file (or files, see
5137   below!).</p>
5138 <div class="sect1" title="13.1. RCS ID">
5139 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5140 <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
5141 <p>Be sure to add a RCS ID line as the first thing in any
5142     <code class="filename">PLIST</code> file you write:</p>
5143 <pre class="programlisting">
5144 @comment $NetBSD$
5145     </pre>
5146 </div>
5147 <div class="sect1" title="13.2. Semi-automatic PLIST generation">
5148 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5149 <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
5150 <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
5151     to output a PLIST that matches any new files since the package
5152     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
5153     more information on this target.</p>
5154 </div>
5155 <div class="sect1" title="13.3. Tweaking output of make print-PLIST">
5156 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5157 <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
5158 </h2></div></div></div>
5159 <p>If you have used any of the *-dirs packages, as explained in
5160     <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
5161     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
5162     <code class="varname">@comment</code>s instead of real
5163     <code class="varname">@dirrm</code> lines.  You can also do this for
5164     specific directories and files, so that the results of that
5165     command are very close to reality. This helps <span class="emphasis"><em>a
5166     lot</em></span> during the update of packages.</p>
5167 <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5168     of AWK patterns and actions that are used to filter the output of
5169     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5170     scripting you like to it, but be careful with quoting.</p>
5171 <p>For example, to get all files inside the
5172     <code class="filename">libdata/foo</code> directory removed from the
5173     resulting PLIST:</p>
5174 <pre class="programlisting">
5175 PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
5176     </pre>
5177 <p>And to get all the <code class="varname">@dirrm</code> lines referring
5178     to a specific (shared) directory converted to
5179     <code class="varname">@comment</code>s:</p>
5180 <pre class="programlisting">
5181 PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5182     </pre>
5183 </div>
5184 <div class="sect1" title="13.4. Variable substitution in PLIST">
5185 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5186 <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
5187 <p>A number of variables are substituted automatically in
5188     PLISTs when a package is installed on a system. This includes the
5189     following variables:</p>
5190 <div class="variablelist"><dl>
5191 <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5192 <dd>
5193 <p>Some packages like emacs and perl embed information
5194           about which architecture they were built on into the
5195           pathnames where they install their files. To handle this
5196           case, PLIST will be preprocessed before actually used, and
5197           the symbol
5198           <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
5199           replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
5200           same is done if the string
5201           <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5202           PLIST somewhere - use this on packages that have GNU
5203           autoconf-created configure scripts.</p>
5204 <div class="note" title="Legacy note" style="margin-left: 0.5in; margin-right: 0.5in;">
5205 <h3 class="title">Legacy note</h3>
5206 <p>There used to be a symbol
5207             <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
5208             was replaced by the output of <span class="command"><strong>uname
5209             -m</strong></span>, but that's no longer supported and has
5210             been removed.</p>
5211 </div>
5212 </dd>
5213 <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5214 <dd>
5215 <p>Some packages want to embed the OS name and version
5216           into some paths.  To do this, use these variables in the
5217           <code class="filename">PLIST</code>:
5218           </p>
5219 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5220 <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</span></p></li>
5221 <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">&#8220;<span class="quote">solaris</span>&#8221;</span>)</p></li>
5222 <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</span></p></li>
5223 </ul></div>
5224 </dd>
5225 </dl></div>
5226 <p>For a complete list of values which are replaced by
5227     default, please look in <code class="filename">bsd.pkg.mk</code> (and
5228     search for <code class="varname">PLIST_SUBST</code>).</p>
5229 <p>If you want to change other variables not listed above, you
5230     can add variables and their expansions to this variable in the
5231     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>
5232 <pre class="programlisting">
5233 PLIST_SUBST+=   SOMEVAR="somevalue"
5234     </pre>
5235 <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
5236     in the <code class="filename">PLIST</code> with
5237     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
5238 <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
5239     the common case of conditionally including some
5240     <code class="filename">PLIST</code> entries. It can be done by adding
5241     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
5242     setting the corresponding <code class="varname">PLIST.foo</code> variable
5243     to <code class="literal">yes</code> if the entry should be included.
5244     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
5245     in the <code class="filename">PLIST</code> with either
5246     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
5247     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
5248     For example, in <code class="filename">Makefile</code>:</p>
5249 <pre class="programlisting">
5250 PLIST_VARS+=    foo
5251 .if <em class="replaceable"><code>condition</code></em>
5252 PLIST.foo=      yes
5253 .else
5254     </pre>
5255 <p>And then in <code class="filename">PLIST</code>:</p>
5256 <pre class="programlisting">
5257 @comment $NetBSD$
5258 bin/bar
5259 man/man1/bar.1
5260 ${PLIST.foo}bin/foo
5261 ${PLIST.foo}man/man1/foo.1
5262 ${PLIST.foo}share/bar/foo.data
5263 ${PLIST.foo}@dirrm share/bar
5264     </pre>
5265 </div>
5266 <div class="sect1" title="13.5. Man page compression">
5267 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5268 <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
5269 <p>Man pages should be installed in compressed form if
5270     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5271     and uncompressed otherwise. To handle this in the
5272     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
5273     appended/removed automatically for man pages according to
5274     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5275     or not, see above for details. This modification of the
5276     <code class="filename">PLIST</code> file is done on a copy of it, not
5277     <code class="filename">PLIST</code> itself.</p>
5278 </div>
5279 <div class="sect1" title="13.6. Changing PLIST source with PLIST_SRC">
5280 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5281 <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
5282 </h2></div></div></div>
5283 <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5284     in generating the binary package, set the variable
5285     <code class="varname">PLIST_SRC</code> to the names of that file(s).
5286     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
5287     important. The default for <code class="varname">PLIST_SRC</code> is
5288     <code class="filename">${PKGDIR}/PLIST</code>.</p>
5289 </div>
5290 <div class="sect1" title="13.7. Platform-specific and differing PLISTs">
5291 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5292 <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
5293 <p>Some packages decide to install a different set of files based on
5294     the operating system being used. These differences can be
5295     automatically handled by using the following files:</p>
5296 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5297 <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5298 <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5299 <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5300 <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5301 <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
5302 </ul></div>
5303 </div>
5304 <div class="sect1" title="13.8. Sharing directories between packages">
5305 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5306 <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
5307 <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
5308     multiple (and unrelated) packages install files.  These
5309     directories were problematic because you had to add special
5310     tricks in the PLIST to conditionally remove them, or have some
5311     centralized package handle them.</p>
5312 <p>In pkgsrc, it is now easy: Each package should create
5313     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5314     will remove any directories left empty after uninstalling a
5315     package.</p>
5316 <p>If a package needs an empty directory to work, create
5317     the directory during installation as usual, and also add an
5318     entry to the PLIST:
5319     </p>
5320 <pre class="programlisting">
5321 @pkgdir path/to/empty/directory
5322     </pre>
5323 <p>
5324     </p>
5325 </div>
5326 </div>
5327 <div class="chapter" title="Chapter 14. Buildlink methodology">
5328 <div class="titlepage"><div><div><h2 class="title">
5329 <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
5330 <div class="toc">
5331 <p><b>Table of Contents</b></p>
5332 <dl>
5333 <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
5334 <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
5335 <dd><dl>
5336 <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5337 <dt><span class="sect2"><a href="#updating-buildlink-depends">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</a></span></dt>
5338 </dl></dd>
5339 <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
5340 <dd><dl>
5341 <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
5342 <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
5343 </dl></dd>
5344 </dl>
5345 </div>
5346 <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5347   are seen by a package's configure and build processes.  This is implemented
5348   in a two step process:</p>
5349 <div class="orderedlist"><ol class="orderedlist" type="1">
5350 <li class="listitem"><p>Symlink headers and libraries for dependencies into
5351       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5352       of <code class="varname">WRKDIR</code>.</p></li>
5353 <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
5354       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5355       <code class="option">-L${LOCALBASE}/lib</code> into references to
5356       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5357       native compiler on some operating systems look like GCC, so that
5358       packages that expect GCC won't require modifications to build with
5359       those native compilers.</p></li>
5360 </ol></div>
5361 <p>This normalizes the environment in which a package is built so that the
5362   package may be built consistently despite what other software may be
5363   installed. Please note that the normal system header and library paths,
5364   e.g. <code class="filename">/usr/include</code>,
5365   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5366   designed to insulate the package build from non-system-supplied
5367   software.</p>
5368 <div class="sect1" title="14.1. Converting packages to use buildlink3">
5369 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5370 <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
5371 <p>The process of converting packages to use the buildlink3
5372     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
5373     The things to keep in mind are:</p>
5374 <div class="orderedlist"><ol class="orderedlist" type="1">
5375 <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
5376         instead of the actual toolchain.  Some packages are tricky,
5377         and the only way to know for sure is the check
5378         <code class="filename">${WRKDIR}/.work.log</code> to see if the
5379         wrappers are being invoked.</p></li>
5380 <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
5381         the package Makefile, e.g. Java VMs, standalone shells,
5382         etc., because the code to symlink files into
5383         <code class="filename">${BUILDLINK_DIR}</code> looks for files
5384         relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
5385         </p></li>
5386 <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
5387         <code class="filename">buildlink3.mk</code> files that you list in a
5388         package's Makefile are added as dependencies for that package.
5389         </p></li>
5390 </ol></div>
5391 <p>If a dependency on a particular package is required for its libraries and
5392     headers, then we replace:</p>
5393 <pre class="programlisting">
5394 DEPENDS+=       foo&gt;=1.1.0:../../category/foo
5395 </pre>
5396 <p>with</p>
5397 <pre class="programlisting">
5398 .include "../../category/foo/buildlink3.mk"
5399 </pre>
5400 <p>The buildlink3.mk files usually define the required dependencies.
5401     If you need a newer version of the dependency when using buildlink3.mk
5402     files, then you can define it in your Makefile; for example:</p>
5403 <pre class="programlisting">
5404 BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
5405 .include "../../category/foo/buildlink3.mk"
5406 </pre>
5407 <p>There are several <code class="filename">buildlink3.mk</code>
5408     files in <code class="filename">pkgsrc/mk</code>
5409     that handle special package issues:</p>
5410 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5411 <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
5412         the native or a pkgsrc Berkeley DB implementation based on
5413         the values of <code class="varname">BDB_ACCEPTED</code> and
5414         <code class="varname">BDB_DEFAULT</code>.</p></li>
5415 <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
5416         comes with neither Curses nor NCurses, this will take care
5417         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>
5418 <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
5419         of <code class="varname">KRB5_ACCEPTED</code> to choose between
5420         adding a dependency on Heimdal or MIT-krb5 for packages that
5421         require a Kerberos 5 implementation.</p></li>
5422 <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
5423         system-provided Motif installation or adds a dependency on
5424         <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
5425         <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
5426         <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, or <span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
5427         which Motif version will be used.</p></li>
5428 <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
5429         variables that may be used by packages that use the
5430         Open Sound System (OSS) API.</p></li>
5431 <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
5432         either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
5433         the file for more information.</p></li>
5434 <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
5435         <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5436         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>
5437 <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
5438         <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5439         library.</p></li>
5440 </ul></div>
5441 <p>The comments in those <code class="filename">buildlink3.mk</code>
5442     files provide a more complete
5443     description of how to use them properly.</p>
5444 </div>
5445 <div class="sect1" title="14.2. Writing buildlink3.mk files">
5446 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5447 <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
5448 <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
5449     included by Makefiles to indicate the need to compile and link
5450     against header files and libraries provided by the package.  A
5451     <code class="filename">buildlink3.mk</code> file should always provide
5452     enough information to add the correct type of dependency
5453     relationship and include any other
5454     <code class="filename">buildlink3.mk</code> files that it needs to find
5455     headers and libraries that it needs in turn.</p>
5456 <p>To generate an initial <code class="filename">buildlink3.mk</code>
5457     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>
5458     package is highly recommended.  For most packages, the following
5459     command will generate a good starting point for
5460     <code class="filename">buildlink3.mk</code> files:</p>
5461 <pre class="screen">
5462 <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5463 <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
5464     </pre>
5465 <div class="sect2" title="14.2.1. Anatomy of a buildlink3.mk file">
5466 <div class="titlepage"><div><div><h3 class="title">
5467 <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
5468 <p>The following real-life example
5469       <code class="filename">buildlink3.mk</code> is taken
5470       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5471 <pre class="programlisting">
5472 # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
5473
5474 BUILDLINK_TREE+=        tiff
5475
5476 .if !defined(TIFF_BUILDLINK3_MK)
5477 TIFF_BUILDLINK3_MK:=
5478
5479 BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
5480 BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
5481 BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
5482
5483 .include "../../devel/zlib/buildlink3.mk"
5484 .include "../../graphics/jpeg/buildlink3.mk"
5485 .endif # TIFF_BUILDLINK3_MK
5486
5487 BUILDLINK_TREE+=        -tiff
5488 </pre>
5489 <p>The header and footer manipulate
5490       <code class="varname">BUILDLINK_TREE</code>, which is common across all
5491       <code class="filename">buildlink3.mk</code> files and is used to track
5492       the dependency tree.</p>
5493 <p>The main section is protected from multiple inclusion
5494       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5495       added.  Several important variables are set in the section:</p>
5496 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5497 <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5498           is the actual dependency recorded in the installed
5499           package; this should always be set using
5500           <span class="command"><strong>+=</strong></span> to ensure that
5501           we're appending to any pre-existing list of values.  This
5502           variable should be set to the first version of the
5503           package that had an API change.
5504           </p></li>
5505 <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5506           is the location of the <em class="replaceable"><code>pkg</code></em>
5507           pkgsrc directory.</p></li>
5508 <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5509           (not shown above) controls whether we use
5510           <code class="varname">BUILD_DEPENDS</code> or
5511           <code class="varname">DEPENDS</code> to add the dependency on
5512           <em class="replaceable"><code>pkg</code></em>.  The build dependency is
5513           selected by setting
5514           <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5515           to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
5516           used.</p></li>
5517 <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
5518             and
5519             <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5520             (not shown above) are lists of subdirectories of
5521             <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5522             to add to the header and library search paths.  These
5523             default to <span class="quote">&#8220;<span class="quote">include</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">lib</span>&#8221;</span>
5524           respectively.</p></li>
5525 <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
5526             (not shown above) is the list of preprocessor flags to add
5527             to <code class="varname">CPPFLAGS</code>, which are passed on to the
5528             configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
5529             should be avoided and instead be handled using
5530             <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5531           above.</p></li>
5532 </ul></div>
5533 <p>The following variables are all optionally defined within
5534       this second section (protected against multiple inclusion) and
5535       control which package files are symlinked into
5536       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5537       transformed during the symlinking:</p>
5538 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5539 <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
5540             (not shown above) is a shell glob pattern relative to
5541             <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5542             to be symlinked into
5543             <code class="filename">${BUILDLINK_DIR}</code>,
5544           e.g. <code class="filename">include/*.h</code>.</p></li>
5545 <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5546             (not shown above) is a shell pipeline that
5547             outputs to stdout a list of files relative to
5548             <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5549             The resulting files are to be symlinked
5550             into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
5551             this takes the <code class="filename">+CONTENTS</code> of a
5552             <em class="replaceable"><code>pkg</code></em> and filters it through
5553             <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5554 <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5555             (not shown above) is a filter command that filters
5556             <code class="filename">+CONTENTS</code> input into a list of files
5557             relative to
5558             <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5559             on stdout.  By default for overwrite packages,
5560             <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5561             outputs the contents of the <code class="filename">include</code>
5562             and <code class="filename">lib</code> directories in the package
5563             <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5564             it outputs any libtool archives in
5565             <code class="filename">lib</code> directories.</p></li>
5566 <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
5567             (not shown above) is a list of sed arguments used to
5568             transform the name of the source filename into a
5569             destination filename, e.g. <span class="command"><strong>-e
5570             "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5571 </ul></div>
5572 <p>This section can additionally include any
5573       <code class="filename">buildlink3.mk</code> needed for
5574       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5575       Including these <code class="filename">buildlink3.mk</code> files
5576       means that the headers and libraries for these
5577       dependencies are also symlinked into
5578       <code class="filename">${BUILDLINK_DIR}</code>
5579       whenever the <em class="replaceable"><code>pkg</code></em>
5580       <code class="filename">buildlink3.mk</code>
5581       file is included. Dependencies are only added for directly
5582       include <code class="filename">buildlink3.mk</code> files.</p>
5583 </div>
5584 <div class="sect2" title="14.2.2. Updating BUILDLINK_API_DEPENDS.pkg in buildlink3.mk files">
5585 <div class="titlepage"><div><div><h3 class="title">
5586 <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>
5587 <p>The situation that requires increasing the dependency listed in
5588         <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5589         after a package update is when the API or interface to the
5590       header files change.</p>
5591 <p>In this case,
5592       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5593       should be adjusted to require at least the new package
5594       version.  In some cases, the packages that depend on this new
5595       version may need their <code class="varname">PKGREVISION</code>s
5596       increased and, if they have <code class="filename">buildlink3.mk</code>
5597       files, their
5598       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5599       adjusted, too.  This is needed so pkgsrc will require the
5600       correct package dependency and not settle for an older one
5601       when building the source.</p>
5602 <p><code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5603         should be increased when the binary interface or sonames
5604         (major number of the library version) of any installed
5605         shared libraries change.  This is needed so that binary
5606         packages made using it will require the correct package
5607         dependency and not settle for an older one which will not
5608       contain the necessary shared libraries.</p>
5609 <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
5610         more information about dependencies on other packages,
5611         including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
5612       <code class="varname">ABI_DEPENDS</code> definitions.</p>
5613 <p>Please take careful consideration before adjusting
5614       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5615       or
5616       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5617       as we don't want to cause unneeded package deletions and
5618       rebuilds.  In many cases, new versions of packages work just
5619       fine with older dependencies.</p>
5620 <p>Also it is not needed to set
5621         <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5622         when it is identical to
5623       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5624 </div>
5625 </div>
5626 <div class="sect1" title="14.3. Writing builtin.mk files">
5627 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5628 <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
5629 <p>Some packages in pkgsrc install headers and libraries that
5630       coincide with headers and libraries present in the base system.
5631       Aside from a <code class="filename">buildlink3.mk</code> file, these
5632       packages should also include a <code class="filename">builtin.mk</code>
5633       file that includes the necessary checks to decide whether using
5634       the built-in software or the pkgsrc software is
5635     appropriate.</p>
5636 <p>The only requirements of a builtin.mk file for
5637     <em class="replaceable"><code>pkg</code></em> are:</p>
5638 <div class="orderedlist"><ol class="orderedlist" type="1">
5639 <li class="listitem"><p>It should set
5640         <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5641         to either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>
5642         after it is included.</p></li>
5643 <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
5644         <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5645         which is already set before the
5646         <code class="filename">builtin.mk</code> file is included.</p></li>
5647 <li class="listitem"><p>It should be written to allow multiple inclusion.  This
5648         is <span class="emphasis"><em>very</em></span> important and takes careful
5649         attention to <code class="filename">Makefile</code> coding.</p></li>
5650 </ol></div>
5651 <div class="sect2" title="14.3.1. Anatomy of a builtin.mk file">
5652 <div class="titlepage"><div><div><h3 class="title">
5653 <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
5654 <p>The following is the recommended template for builtin.mk
5655       files:</p>
5656 <pre class="programlisting">
5657 .if !defined(IS_BUILTIN.foo)
5658 #
5659 # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5660 # genuinely exists in the system or not.
5661 #
5662 IS_BUILTIN.foo?=        no
5663
5664 # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5665 # version can be determined.
5666 #
5667 .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5668 BUILTIN_PKG.foo?=       foo-1.0
5669 .  endif
5670 .endif  # IS_BUILTIN.foo
5671
5672 .if !defined(USE_BUILTIN.foo)
5673 USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
5674 .  if defined(BUILTIN_PKG.foo)
5675 .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5676 .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5677 USE_BUILTIN.foo!=                                                       \
5678         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
5679         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
5680 .      endif
5681 .    endfor
5682 .  endif
5683 .endif  # USE_BUILTIN.foo
5684
5685 CHECK_BUILTIN.foo?=     no
5686 .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5687 #
5688 # Here we place code that depends on whether USE_BUILTIN.foo is set to
5689 # "yes" or "no".
5690 #
5691 .endif  # CHECK_BUILTIN.foo
5692 </pre>
5693 <p>The first section sets
5694       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5695       depending on if <em class="replaceable"><code>pkg</code></em> really exists
5696       in the base system.  This should not be a base system software
5697       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5698       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
5699       included as part of the base system.  This variable is only
5700       used internally within the <code class="filename">builtin.mk</code>
5701       file.</p>
5702 <p>The second section sets
5703       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5704       to the version of <em class="replaceable"><code>pkg</code></em> in the base
5705       system if it exists (if
5706       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5707       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
5708       within the <code class="filename">builtin.mk</code> file.</p>
5709 <p>The third section sets
5710       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5711       and is <span class="emphasis"><em>required</em></span> in all
5712       <code class="filename">builtin.mk</code> files.  The code in this
5713       section must make the determination whether the built-in
5714       software is adequate to satisfy the dependencies listed in
5715       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5716       This is typically done by comparing
5717       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5718       against each of the dependencies in
5719       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5720       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5721       <span class="emphasis"><em>must</em></span> be set to the correct value by the
5722       end of the <code class="filename">builtin.mk</code> file.  Note that
5723       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5724       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
5725       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5726       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
5727       that the built-in version of the software is similar enough to
5728       be used as a replacement.</p>
5729 <p>The last section is guarded by
5730       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5731       and includes code that uses the value of
5732       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5733       set in the previous section.  This typically includes, e.g.,
5734       adding additional dependency restrictions and listing additional
5735       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5736       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5737 </div>
5738 <div class="sect2" title="14.3.2. Global preferences for native or pkgsrc software">
5739 <div class="titlepage"><div><div><h3 class="title">
5740 <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
5741 <p>When building packages, it's possible to choose whether to set
5742         a global preference for using either the built-in (native)
5743         version or the pkgsrc version of software to satisfy a
5744         dependency.  This is controlled by setting
5745         <code class="varname">PREFER_PKGSRC</code> and
5746         <code class="varname">PREFER_NATIVE</code>.  These variables take values
5747         of either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>, or a list of
5748         packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5749         use the pkgsrc versions of software, while
5750         <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5751         built-in versions.  Preferences are determined by the most
5752         specific instance of the package in either
5753         <code class="varname">PREFER_PKGSRC</code> or
5754         <code class="varname">PREFER_NATIVE</code>.  If a package is specified
5755         in neither or in both variables, then
5756         <code class="varname">PREFER_PKGSRC</code> has precedence over
5757         <code class="varname">PREFER_NATIVE</code>.  For example, to require
5758         using pkgsrc versions of software for all but the most basic
5759       bits on a NetBSD system, you can set:</p>
5760 <pre class="programlisting">
5761 PREFER_PKGSRC=  yes
5762 PREFER_NATIVE=  getopt skey tcp_wrappers
5763 </pre>
5764 <p>A package <span class="emphasis"><em>must</em></span> have a
5765       <code class="filename">builtin.mk</code>
5766       file to be listed in <code class="varname">PREFER_NATIVE</code>,
5767       otherwise it is simply ignored in that list.</p>
5768 </div>
5769 </div>
5770 </div>
5771 <div class="chapter" title="Chapter 15. The pkginstall framework">
5772 <div class="titlepage"><div><div><h2 class="title">
5773 <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
5774 <div class="toc">
5775 <p><b>Table of Contents</b></p>
5776 <dl>
5777 <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
5778 <dd><dl>
5779 <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5780 <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
5781 </dl></dd>
5782 <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
5783 <dd><dl>
5784 <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5785 <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5786 <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5787 <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5788 </dl></dd>
5789 <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5790 <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>
5791 <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5792 <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5793 <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5794 <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5795 <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>
5796 </dl>
5797 </div>
5798 <p>This chapter describes the framework known as
5799 <code class="literal">pkginstall</code>, whose key features are:</p>
5800 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5801 <li class="listitem"><p>Generic installation and manipulation of directories and files
5802     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5803 <li class="listitem"><p>Automatic handling of configuration files during installation,
5804     provided that packages are correctly designed.</p></li>
5805 <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5806 <li class="listitem"><p>Registration of system users and groups.</p></li>
5807 <li class="listitem"><p>Registration of system shells.</p></li>
5808 <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
5809 </ul></div>
5810 <p>The following sections inspect each of the above points in detail.</p>
5811 <p>You may be thinking that many of the things described here could be
5812 easily done with simple code in the package's post-installation target
5813 (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
5814 as the code in them is only executed when building from source.  Machines
5815 using binary packages could not benefit from it at all (as the code itself
5816 could be unavailable).  Therefore, the only way to achieve any of the items
5817 described above is by means of the installation scripts, which are
5818 automatically generated by pkginstall.</p>
5819 <div class="sect1" title="15.1. Files and directories outside the installation prefix">
5820 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5821 <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
5822 <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5823 of files and directories that belong to a package.  The names used in it
5824 are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5825 which means that it cannot register files outside this directory (absolute
5826 path names are not allowed).  Despite this restriction, some packages need
5827 to install files outside this location; e.g., under
5828 <code class="filename">${VARBASE}</code> or
5829 <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
5830 is to create such files during installation time by using
5831 installation scripts.</p>
5832 <p>The generic installation scripts are shell scripts that can
5833 contain arbitrary code.  The list of scripts to execute is taken from
5834 the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5835 <code class="filename">INSTALL</code>.  A similar variable exists for package
5836 removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5837 <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
5838 commands, so they have the potential to create and manage files
5839 anywhere in the file system.</p>
5840 <p>Using these general installation files is not recommended, but
5841 may be needed in some special cases.  One reason for avoiding them is
5842 that the user has to trust the packager that there is no unwanted or
5843 simply erroneous code included in the installation script. Also,
5844 previously there were many similar scripts for the same functionality,
5845 and fixing a common error involved finding and changing all of
5846 them.</p>
5847 <p>The pkginstall framework offers another, standardized way.  It
5848 provides generic scripts to abstract the manipulation of such files
5849 and directories based on variables set in the package's
5850 <code class="filename">Makefile</code>.  The rest of this section describes
5851 these variables.</p>
5852 <div class="sect2" title="15.1.1. Directory manipulation">
5853 <div class="titlepage"><div><div><h3 class="title">
5854 <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
5855 <p>The following variables can be set to request the creation of
5856 directories anywhere in the file system:</p>
5857 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5858 <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5859     contain a list of directories that should be created and should attempt
5860     to be destroyed by the installation scripts.  The difference between
5861     the two is that the latter prompts the administrator to remove any
5862     directories that may be left after deinstallation (because they were
5863     not empty), while the former does not.</p></li>
5864 <li class="listitem">
5865 <p><code class="varname">MAKE_DIRS_PERMS</code> and
5866     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5867     which directories should be created and should attempt to be destroyed
5868     by the installation scripts.  Each tuple holds the following values,
5869     separated by spaces: the directory name, its owner, its group and its
5870     numerical mode.  For example:</p>
5871 <pre class="programlisting">
5872 MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
5873 </pre>
5874 <p>The difference between the two is exactly the same as their
5875     non-<code class="varname">PERMS</code> counterparts.</p>
5876 </li>
5877 </ul></div>
5878 </div>
5879 <div class="sect2" title="15.1.2. File manipulation">
5880 <div class="titlepage"><div><div><h3 class="title">
5881 <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
5882 <p>Creating non-empty files outside the installation prefix is tricky
5883 because the <code class="filename">PLIST</code> forces all files to be inside it.
5884 To overcome this problem, the only solution is to extract the file in the
5885 known place (i.e., inside the installation prefix) and copy it to the
5886 appropriate location during installation (done by the installation scripts
5887 generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
5888 file</em></span> in the following paragraphs, which describe the variables
5889 that can be used to automatically and consistently handle files outside the
5890 installation prefix:</p>
5891 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5892 <li class="listitem">
5893 <p><code class="varname">CONF_FILES</code> and
5894     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5895     During installation time, the master file is copied to the target one
5896     if and only if the latter does not exist.  Upon deinstallation, the
5897     target file is removed provided that it was not modified by the
5898     installation.</p>
5899 <p>The difference between the two is that the latter prompts the
5900     administrator to remove any files that may be left after
5901     deinstallation (because they were not empty), while the former does
5902     not.</p>
5903 </li>
5904 <li class="listitem">
5905 <p><code class="varname">CONF_FILES_PERMS</code> and
5906     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5907     files as well as their target locations.  For each of them, it also
5908     specifies their owner, their group and their numeric permissions, in
5909     this order.  For example:</p>
5910 <pre class="programlisting">
5911 SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
5912 </pre>
5913 <p>The difference between the two is exactly the same as their
5914     non-<code class="varname">PERMS</code> counterparts.</p>
5915 </li>
5916 </ul></div>
5917 </div>
5918 </div>
5919 <div class="sect1" title="15.2. Configuration files">
5920 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5921 <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
5922 <p>Configuration files are special in the sense that they are installed
5923 in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5924 need special treatment during installation (most of which is automated by
5925 pkginstall).  The main concept you must bear in mind is that files marked
5926 as configuration files are automatically copied to the right place (somewhere
5927 inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5928 and only if</em></span> they didn't exist before.  Similarly, they will not
5929 be removed if they have local modifications.  This ensures that
5930 administrators never lose any custom changes they may have made.</p>
5931 <div class="sect2" title="15.2.1. How PKG_SYSCONFDIR is set">
5932 <div class="titlepage"><div><div><h3 class="title">
5933 <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
5934 <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5935 specifies where configuration files shall be installed.  Its contents are
5936 set based upon the following variables:</p>
5937 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5938 <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
5939     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5940     be overridden by the user to point to his preferred location (e.g.,
5941     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5942     Packages must not use it directly.</p></li>
5943 <li class="listitem">
5944 <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5945     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5946     for the package being built shall be installed.  The definition of this
5947     variable only makes sense in the package's
5948     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5949 <p>As an example, consider the Apache package,
5950     <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
5951     configuration files under the
5952     <code class="filename">httpd/</code> subdirectory of
5953     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
5954     Makefile.</p>
5955 </li>
5956 <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5957     variable that holds this package's configuration directory (if
5958     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
5959     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5960     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5961 <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5962     directory where the configuration files for the package identified by
5963     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5964 </ul></div>
5965 <p>Based on the above variables, pkginstall determines the value of
5966 <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5967 variable that can be used within a package to refer to its configuration
5968 directory.  The algorithm used to set its value is basically the
5969 following:</p>
5970 <div class="orderedlist"><ol class="orderedlist" type="1">
5971 <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5972     its value is used.</p></li>
5973 <li class="listitem"><p>If the previous variable is not defined but
5974     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5975     <code class="filename">Makefile</code>, the resulting value is
5976     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
5977 <li class="listitem"><p>Otherwise, it is set to
5978     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5979 </ol></div>
5980 <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
5981 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
5982 subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5983 be created with OWN_DIRS or MAKE_DIRS.</p>
5984 </div>
5985 <div class="sect2" title="15.2.2. Telling the software where configuration files are">
5986 <div class="titlepage"><div><div><h3 class="title">
5987 <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
5988 <p>Given that pkgsrc (and users!) expect configuration files to be in a
5989 known place, you need to teach each package where it shall install its
5990 files.  In some cases you will have to patch the package Makefiles to
5991 achieve it.  If you are lucky, though, it may be as easy as passing an
5992 extra flag to the configuration script; this is the case of GNU Autoconf-
5993 generated files:</p>
5994 <pre class="programlisting">
5995 CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
5996 </pre>
5997 <p>Note that this specifies where the package has to <span class="emphasis"><em>look
5998 for</em></span> its configuration files, not where they will be originally
5999 installed (although the difference is never explicit,
6000 unfortunately).</p>
6001 </div>
6002 <div class="sect2" title="15.2.3. Patching installations">
6003 <div class="titlepage"><div><div><h3 class="title">
6004 <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
6005 <p>As said before, pkginstall automatically handles configuration files.
6006 This means that <span class="strong"><strong>the packages themselves must not
6007 touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
6008 directly</strong></span>.  Bad news is that many software installation scripts
6009 will, out of the box, mess with the contents of that directory.  So what is
6010 the correct procedure to fix this issue?</p>
6011 <p>You must teach the package (usually by manually patching it) to
6012 install any configuration files under the examples hierarchy,
6013 <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
6014 <code class="filename">PLIST</code> registers them and the administrator always
6015 has the original copies available.</p>
6016 <p>Once the required configuration files are in place (i.e., under the
6017 examples hierarchy), the pkginstall framework can use them as master copies
6018 during the package installation to update what is in
6019 <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
6020 <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
6021 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
6022 about their syntax and their purpose.  Here is an example, taken from the
6023 <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>
6024 <pre class="programlisting">
6025 EGDIR=        ${PREFIX}/share/doc/mutt/samples
6026 CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
6027 </pre>
6028 <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6029 package and has no meaning outside it.</p>
6030 </div>
6031 <div class="sect2" title="15.2.4. Disabling handling of configuration files">
6032 <div class="titlepage"><div><div><h3 class="title">
6033 <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
6034 <p>The automatic copying of config files can be toggled by setting the
6035 environment variable <code class="varname">PKG_CONFIG</code> prior to package
6036 installation.</p>
6037 </div>
6038 </div>
6039 <div class="sect1" title="15.3. System startup scripts">
6040 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6041 <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
6042 <p>System startup scripts are special files because they must be
6043 installed in a place known by the underlying OS, usually outside the
6044 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
6045 can be used.  However, pkginstall provides a special mechanism to handle
6046 these files.</p>
6047 <p>In order to provide system startup scripts, the package has
6048 to:</p>
6049 <div class="orderedlist"><ol class="orderedlist" type="1">
6050 <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
6051     the <code class="literal">.sh</code> suffix appended.  Considering the
6052     <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
6053     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
6054 <li class="listitem">
6055 <p>Tell pkginstall to handle it, appending the name of the script,
6056     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6057     Continuing the previous example:</p>
6058 <pre class="programlisting">
6059 RCD_SCRIPTS+=   cupsd
6060 </pre>
6061 </li>
6062 </ol></div>
6063 <p>Once this is done, pkginstall will do the following steps for each
6064 script in an automated fashion:</p>
6065 <div class="orderedlist"><ol class="orderedlist" type="1">
6066 <li class="listitem"><p>Process the file found in the files directory applying all the
6067     substitutions described in the <code class="filename">FILES_SUBST</code>
6068     variable.</p></li>
6069 <li class="listitem"><p>Copy the script from the files directory to the examples
6070     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
6071     that this master file must be explicitly registered in the
6072     <code class="filename">PLIST</code>.</p></li>
6073 <li class="listitem"><p>Add code to the installation scripts to copy the startup script
6074     from the examples hierarchy into the system-wide startup scripts
6075     directory.</p></li>
6076 </ol></div>
6077 <div class="sect2" title="15.3.1. Disabling handling of system startup scripts">
6078 <div class="titlepage"><div><div><h3 class="title">
6079 <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
6080 <p>The automatic copying of config files can be toggled by setting the
6081 environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6082 installation.  Note that the scripts will be always copied inside the
6083 examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
6084 matter what the value of this variable is.</p>
6085 </div>
6086 </div>
6087 <div class="sect1" title="15.4. System users and groups">
6088 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6089 <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
6090 <p>If a package needs to create special users and/or groups during
6091 installation, it can do so by using the pkginstall framework.</p>
6092 <p>Users can be created by adding entries to the
6093 <code class="varname">PKG_USERS</code> variable.  Each entry has the following
6094 syntax:</p>
6095 <pre class="programlisting">
6096 user:group
6097 </pre>
6098 <p>Further specification of user details may be done by setting
6099 per-user variables.
6100 <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6101 numeric UID for the user.
6102 <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6103 user's description or comment.
6104 <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6105 user's home directory, and defaults to
6106 <code class="filename">/nonexistent</code> if not specified.
6107 <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6108 user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
6109 not specified.</p>
6110 <p>Similarly, groups can be created by adding entries to the
6111 <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6112 <pre class="programlisting">
6113 group
6114 </pre>
6115 <p>The numeric GID of the group may be set by defining
6116 <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6117 <p>If a package needs to create the users and groups at an earlier
6118 stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6119 either <code class="literal">configure</code> or <code class="literal">build</code> to
6120 indicate the phase before which the users and groups are created.  In
6121 this case, the numeric UIDs and GIDs of the created users and groups
6122 are automatically hardcoded into the final installation scripts.</p>
6123 </div>
6124 <div class="sect1" title="15.5. System shells">
6125 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6126 <a name="shells"></a>15.5. System shells</h2></div></div></div>
6127 <p>Packages that install system shells should register them in the shell
6128 database, <code class="filename">/etc/shells</code>, to make things easier to the
6129 administrator.  This must be done from the installation scripts to keep
6130 binary packages working on any system.  pkginstall provides an easy way to
6131 accomplish this task.</p>
6132 <p>When a package provides a shell interpreter, it has to set the
6133 <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
6134 add some hooks to the installation scripts to handle it.  Consider the
6135 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>
6136 <pre class="programlisting">
6137 PKG_SHELL=      ${PREFIX}/bin/zsh
6138 </pre>
6139 <div class="sect2" title="15.5.1. Disabling shell registration">
6140 <div class="titlepage"><div><div><h3 class="title">
6141 <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
6142 <p>The automatic registration of shell interpreters can be disabled by
6143 the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
6144 environment variable to <code class="literal">NO</code>.</p>
6145 </div>
6146 </div>
6147 <div class="sect1" title="15.6. Fonts">
6148 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6149 <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
6150 <p>Packages that install X11 fonts should update the database files
6151 that index the fonts within each fonts directory.  This can easily be
6152 accomplished within the pkginstall framework.</p>
6153 <p>When a package installs X11 fonts, it must list the directories in
6154 which fonts are installed in the
6155 <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6156 where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
6157 <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.  This will add hooks to the
6158 installation scripts to run the appropriate commands to update the fonts
6159 database files within each of those directories.  For convenience, if the
6160 directory path is relative, it is taken to be relative to the package's
6161 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>
6162 <pre class="programlisting">
6163 FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
6164 </pre>
6165 <div class="sect2" title="15.6.1. Disabling automatic update of the fonts databases">
6166 <div class="titlepage"><div><div><h3 class="title">
6167 <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
6168 <p>The automatic update of fonts databases can be disabled by
6169 the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
6170 environment variable to <code class="literal">NO</code>.</p>
6171 </div>
6172 </div>
6173 </div>
6174 <div class="chapter" title="Chapter 16. Options handling">
6175 <div class="titlepage"><div><div><h2 class="title">
6176 <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
6177 <div class="toc">
6178 <p><b>Table of Contents</b></p>
6179 <dl>
6180 <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
6181 <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
6182 <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
6183 <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
6184 </dl>
6185 </div>
6186 <p>Many packages have the ability to be built to support different
6187 sets of features.  <code class="filename">bsd.options.mk</code> is a framework
6188 in pkgsrc that provides generic handling of those options that
6189 determine different ways in which the packages can be built.  It's
6190 possible for the user to specify exactly which sets of options will be
6191 built into a package or to allow a set of global default options
6192 apply.</p>
6193 <p>There are two broad classes of behaviors that one might want to
6194 control via options.  One is whether some particular feature is
6195 enabled in a program that will be built anyway, often by including or
6196 not including a dependency on some other package.  The other is
6197 whether or not an additional program will be built as part of the
6198 package.  Generally, it is better to make a split package for such
6199 additional programs instead of using options, because it enables
6200 binary packages to be built which can then be added separately.  For
6201 example, the foo package might have minimal dependencies (those
6202 packages without which foo doesn't make sense), and then the foo-gfoo
6203 package might include the GTK frontend program gfoo.  This is better
6204 than including a gtk option to foo that adds gfoo, because either that
6205 option is default, in which case binary users can't get foo without
6206 gfoo, or not default, in which case they can't get gfoo.  With split
6207 packages, they can install foo without having GTK, and later decide to
6208 install gfoo (pulling in GTK at that time).  This is an advantage to
6209 source users too, avoiding the need for rebuilds.</p>
6210 <p>Plugins with widely varying dependencies should usually be split
6211 instead of options.</p>
6212 <p>It is often more work to maintain split packages, especially if
6213 the upstream package does not support this.  The decision of split
6214 vs. option should be made based on the likelihood that users will want
6215 or object to the various pieces, the size of the dependencies that are
6216 included, and the amount of work.</p>
6217 <p>A further consideration is licensing.  Non-free parts, or parts
6218 that depend on non-free dependencies (especially plugins) should
6219 almost always be split if feasible.</p>
6220 <div class="sect1" title="16.1. Global default options">
6221 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6222 <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
6223 <p>Global default options are listed in
6224 <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6225 that should be built into every package if that option is supported.
6226 This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
6227 </div>
6228 <div class="sect1" title="16.2. Converting packages to use bsd.options.mk">
6229 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6230 <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
6231 </h2></div></div></div>
6232 <p>The following example shows how
6233 <code class="filename">bsd.options.mk</code> should be used
6234 by the hypothetical ``wibble'' package, either in the package
6235 <code class="filename">Makefile</code>, or in a file,
6236 e.g. <code class="filename">options.mk</code>, that is included by the
6237 main package <code class="filename">Makefile</code>.</p>
6238 <pre class="programlisting">
6239 PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
6240 PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
6241 PKG_OPTIONS_OPTIONAL_GROUPS=    database
6242 PKG_OPTIONS_GROUP.database=     mysql pgsql
6243 PKG_SUGGESTED_OPTIONS=          wibble-foo
6244 PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
6245 PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
6246
6247 .include "../../mk/bsd.prefs.mk"
6248
6249 # this package was previously named wibble2
6250 .if defined(PKG_OPTIONS.wibble2)
6251 PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
6252 PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6253         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6254 .endif
6255
6256 .include "../../mk/bsd.options.mk"
6257
6258 # Package-specific option-handling
6259
6260 ###
6261 ### FOO support
6262 ###
6263 .if !empty(PKG_OPTIONS:Mwibble-foo)
6264 CONFIGURE_ARGS+=    --enable-foo
6265 .endif
6266
6267 ###
6268 ### LDAP support
6269 ###
6270 .if !empty(PKG_OPTIONS:Mldap)
6271 .  include "../../databases/openldap-client/buildlink3.mk"
6272 CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6273 .endif
6274
6275 ###
6276 ### database support
6277 ###
6278 .if !empty(PKG_OPTIONS:Mmysql)
6279 .  include "../../mk/mysql.buildlink3.mk"
6280 .endif
6281 .if !empty(PKG_OPTIONS:Mpgsql)
6282 .  include "../../mk/pgsql.buildlink3.mk"
6283 .endif
6284 </pre>
6285 <p>The first section contains the information about which build
6286 options are supported by the package, and any default options settings
6287 if needed.</p>
6288 <div class="orderedlist"><ol class="orderedlist" type="1">
6289 <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6290 <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
6291 options.  It should be set to
6292 PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6293 PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6294 at the point where the options are processed.</p></li>
6295 <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6296 build options supported by the package.</p></li>
6297 <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6298 list of names of groups of mutually exclusive options.  The options in
6299 each group are listed in
6300 <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6301 The most specific setting of any option from the group takes
6302 precedence over all other options in the group.  Options from the
6303 groups will be automatically added to
6304 <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6305 <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6306 <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6307 packages will fail if no option from the group is
6308 selected.</p></li>
6309 <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6310 of names of sets of options.  At least one option from each set must
6311 be selected.  The options in each set are listed in
6312 <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6313 Options from the sets will be automatically added to
6314 <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
6315 fail if no option from the set is selected.</p></li>
6316 <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6317 build options which are enabled by default.</p></li>
6318 <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6319 of
6320 <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;</span>
6321 pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
6322 their option counterparts.  Pairs should be added with
6323 <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
6324 warning will be issued if the user uses a legacy
6325 variable.</p></li>
6326 <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6327 of
6328 <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;</span>
6329 pairs that map options that have been renamed to their new
6330 counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
6331 the listing of global legacy options.  A warning will be issued if
6332 the user uses a legacy option.</p></li>
6333 <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6334 options implied by deprecated variables used.  This can be used for
6335 cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6336 <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6337 <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6338 <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6339 a list of warnings about deprecated variables or options used, and
6340 what to use instead.</p></li>
6341 </ol></div>
6342 <p>A package should never modify
6343 <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6344 <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
6345 To suggest a default set of options, use
6346 <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6347 <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6348 including <code class="filename">bsd.options.mk</code>.  If none of
6349 <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6350 <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6351 <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6352 happen with platform-specific options if none of them is supported on
6353 the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6354 empty list and the package is otherwise treated as not using the
6355 options framework.</p>
6356 <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6357 variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6358 build options, properly filtered to remove unsupported and duplicate
6359 options.</p>
6360 <p>The remaining sections contain the logic that is specific to
6361 each option.  The correct way to check for an option is to check
6362 whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6363 <pre class="programlisting">
6364 .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6365 </pre>
6366 </div>
6367 <div class="sect1" title="16.3. Option Names">
6368 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6369 <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
6370 <p>Options that enable similar features in different packages (like
6371 optional support for a library) should use a common name in all
6372 packages that support it (like the name of the library).  If another
6373 package already has an option with the same meaning, use the same
6374 name.</p>
6375 <p>Options that enable features specific to one package, where it's
6376 unlikely that another (unrelated) package has the same (or a similar)
6377 optional feature, should use a name prefixed with
6378 <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6379 <p>If a group of related packages share an optional feature
6380 specific to that group, prefix it with the name of the
6381 <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
6382 (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6383 <p>For new options, add a line to
6384 <code class="filename">mk/defaults/options.description</code>.  Lines have two
6385 fields, separated by tab.  The first field is the option name, the
6386 second its description.  The description should be a whole sentence
6387 (starting with an uppercase letter and ending with a period) that
6388 describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
6389 support.</span>&#8221;</span> The file is sorted by option names.</p>
6390 </div>
6391 <div class="sect1" title="16.4. Determining the options of dependencies">
6392 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6393 <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6394 <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6395 different dependencies based on the options with which the package was
6396 built. For querying these options, the file
6397 <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6398 typical example looks like this:</p>
6399 <pre class="programlisting">
6400 pkgbase := libpurple
6401 .include "../../mk/pkg-build-options.mk"
6402
6403 .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6404 ...
6405 .endif
6406 </pre>
6407 <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6408 the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6409 options of the libpurple package, which can then be queried like
6410 <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6411 file. See the file <code class="filename">pkg-build-options.mk</code> for more
6412 details.</p>
6413 </div>
6414 </div>
6415 <div class="chapter" title="Chapter 17. The build process">
6416 <div class="titlepage"><div><div><h2 class="title">
6417 <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
6418 <div class="toc">
6419 <p><b>Table of Contents</b></p>
6420 <dl>
6421 <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6422 <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6423 <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6424 <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
6425 <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6426 <dd><dl>
6427 <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6428 <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6429 </dl></dd>
6430 <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6431 <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6432 <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6433 <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6434 <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6435 <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6436 <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6437 <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6438 <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6439 <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6440 <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6441 <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
6442 </dl>
6443 </div>
6444 <div class="sect1" title="17.1. Introduction">
6445 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6446 <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
6447 <p>This chapter gives a detailed description on how a package is
6448     built. Building a package is separated into different
6449     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6450     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6451     described in the following sections. Each phase is split into
6452     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6453     containing phase, prefixed by one of <code class="varname">pre-</code>,
6454     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6455     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6456     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6457 <p>Never override the regular targets (like
6458     <code class="varname">fetch</code>), if you have to, override the
6459     <code class="varname">do-*</code> ones instead.</p>
6460 <p>The basic steps for building a program are always the same.  First
6461     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6462     the local system and then extracted. After any pkgsrc-specific patches
6463     to compile properly are applied, the software can be configured, then
6464     built (usually by compiling), and finally the generated binaries, etc.
6465     can be put into place on the system.</p>
6466 <p>To get more details about what is happening at each step,
6467     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6468     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6469     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6470 </div>
6471 <div class="sect1" title="17.2. Program location">
6472 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6473 <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
6474 <p>Before outlining the process performed by the NetBSD package system in
6475     the next section, here's a brief discussion on where programs are
6476     installed, and which variables influence this.</p>
6477 <p>The automatic variable <code class="varname">PREFIX</code> indicates
6478     where all files of the final program shall be installed. It is
6479     usually set to <code class="varname">LOCALBASE</code>
6480     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6481     for pkgs in the <code class="filename">cross</code> category.  The value of
6482     <code class="varname">PREFIX</code> needs to be put
6483     into the various places in the program's source where paths to
6484     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>
6485 <p>When choosing which of these variables to use,
6486     follow the following rules:</p>
6487 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
6488 <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
6489         where the current pkg will be installed.  When referring to a
6490         pkg's own installation path, use
6491         <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
6492 <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6493         are installed.  If you need to construct a -I or -L argument
6494         to the compiler to find includes and libraries installed by
6495         another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
6496         <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6497         installed all packages in <code class="filename">/usr/local</code>. As
6498         pkgsrc leaves <code class="filename">/usr/local</code> for the system
6499         administrator, this variable is a misnomer.</p></li>
6500 <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
6501         distribution (from xsrc, etc.) is installed. When looking for
6502         <span class="emphasis"><em>standard</em></span> X11 includes (not those
6503         installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
6504 <li class="listitem">
6505 <p>X11-based packages are special in that they may be
6506         installed in either <code class="varname">X11BASE</code> or
6507         <code class="varname">LOCALBASE</code>.</p>
6508 <p>Usually, X11 packages should be installed under
6509         <code class="varname">LOCALBASE</code> whenever possible.  Note that you
6510         will need to include
6511         <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6512         request the presence of X11 and to get the right compilation
6513         flags.</p>
6514 <p>Even though, there are some packages that cannot be installed
6515         under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6516         files. These packages are special and they must be placed under
6517         <code class="varname">X11BASE</code>. To accomplish this, set either
6518         <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6519         your package.</p>
6520 <p>Some notes: If you need
6521         to find includes or libraries installed by a pkg that has
6522         <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6523         its pkg <code class="filename">Makefile</code>, you need to look in
6524         <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6525         <code class="filename">${LOCALBASE}</code>. To force installation of
6526         all X11 packages in <code class="varname">LOCALBASE</code>, the
6527         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6528         is enabled by default.</p>
6529 </li>
6530 <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
6531         the installed location of an X11
6532         package. <code class="varname">X11PREFIX</code> will be set to
6533         <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6534         to <code class="varname">LOCALBASE</code> if xpkgwedge is
6535         installed.</p></li>
6536 <li class="listitem">
6537 <p>If xpkgwedge is installed, it is possible to have some
6538         packages installed in <code class="varname">X11BASE</code> and some in
6539         <code class="varname">LOCALBASE</code>.  To determine the prefix of an
6540         installed package, the <code class="varname">EVAL_PREFIX</code>
6541         definition can be used. It takes pairs in the format
6542         <span class="quote">&#8220;<span class="quote">DIRNAME=&lt;package&gt;</span>&#8221;</span>, and the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
6543         variable <code class="varname">DIRNAME</code> will be set to the prefix
6544         of the installed package &lt;package&gt;, or
6545         <span class="quote">&#8220;<span class="quote">${X11PREFIX}</span>&#8221;</span> if the package is not
6546         installed.</p>
6547 <p>This is best illustrated by example.</p>
6548 <p>The following lines are taken from
6549         <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6550 <pre class="programlisting">
6551 EVAL_PREFIX+=           GTKDIR=gtk+
6552 CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
6553 CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
6554 CONFIGURE_ARGS+=        --enable-multibyte
6555 </pre>
6556 <p>Specific defaults can be defined for the packages
6557         evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6558         definition of the form:</p>
6559 <pre class="programlisting">
6560 GTKDIR_DEFAULT= ${LOCALBASE}
6561 </pre>
6562 <p>where <code class="varname">GTKDIR</code> corresponds
6563         to the first definition in
6564         the <code class="varname">EVAL_PREFIX</code> pair.</p>
6565 </li>
6566 <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
6567         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
6568         manual pages go into <code class="filename">${PREFIX}/man</code>, not
6569         <code class="filename">${PREFIX}/share/man</code>.</p></li>
6570 </ul></div>
6571 </div>
6572 <div class="sect1" title="17.3. Directories used during the build process">
6573 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6574 <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
6575 <p>When building a package, various directories are used to store
6576     source files, temporary files, pkgsrc-internal files, and so on. These
6577     directories are explained here.</p>
6578 <p>Some of the directory variables contain relative pathnames. There
6579     are two common base directories for these relative directories:
6580     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6581     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6582     inside the package itself.</p>
6583 <div class="variablelist"><dl>
6584 <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6585 <dd><p>This is an absolute pathname that points to the pkgsrc
6586       root directory. Generally, you don't need
6587       it.</p></dd>
6588 <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6589 <dd><p>This is an absolute pathname that points to the
6590       current package.</p></dd>
6591 <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6592 <dd><p>This is a pathname relative to
6593       <code class="varname">PKGSRCDIR</code> that points to the current
6594       package.</p></dd>
6595 <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6596 <dd><p>This is an absolute pathname pointing to the directory
6597       where all work takes place. The distfiles are extracted to this
6598       directory. It also contains temporary directories and log files used by
6599       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6600       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6601 <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6602 <dd><p>This is an absolute pathname pointing to the directory
6603       where the distfiles are extracted. It is usually a direct subdirectory
6604       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6605       that isn't hidden. This variable may be changed by a package
6606       <code class="filename">Makefile</code>.</p></dd>
6607 </dl></div>
6608 <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6609     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
6610     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
6611     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6612     If users would like to have their pkgsrc trees behave in a
6613     read-only manner, then the value of
6614     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6615     <span class="emphasis"><em>no</em></span>.</p>
6616 </div>
6617 <div class="sect1" title="17.4. Running a phase">
6618 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6619 <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
6620 <p>You can run a particular phase by typing <span class="command"><strong>make
6621     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6622     phase. This will automatically run all phases that are required for this
6623     phase. The default phase is <code class="varname">build</code>, that is, when you
6624     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
6625     the package will be built, but not installed.</p>
6626 </div>
6627 <div class="sect1" title="17.5. The fetch phase">
6628 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6629 <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
6630 <p>The first step in building a package is to fetch the
6631     distribution files (distfiles) from the sites that are providing
6632     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6633     phase.</p>
6634 <div class="sect2" title="17.5.1. What to fetch and where to get it from">
6635 <div class="titlepage"><div><div><h3 class="title">
6636 <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
6637 <p>In simple cases, <code class="varname">MASTER_SITES</code>
6638       defines all URLs from where the distfile, whose name is
6639       derived from the <code class="varname">DISTNAME</code> variable, is
6640       fetched. The more complicated cases are described
6641       below.</p>
6642 <p>The variable <code class="varname">DISTFILES</code> specifies
6643       the list of distfiles that have to be fetched. Its value
6644       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6645       so that most packages don't need to define it at all.
6646       <code class="varname">EXTRACT_SUFX</code> is
6647       <code class="literal">.tar.gz</code> by default, but can be changed
6648       freely. Note that if your package requires additional
6649       distfiles to the default one, you cannot just append the
6650       additional filenames using the <code class="literal">+=</code>
6651       operator, but you have write for example:</p>
6652 <pre class="programlisting">
6653 DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6654 </pre>
6655 <p>Each distfile is fetched from a list of sites, usually
6656       <code class="varname">MASTER_SITES</code>. If the package has multiple
6657       <code class="varname">DISTFILES</code> or multiple
6658       <code class="varname">PATCHFILES</code> from different sites, you can
6659       set
6660       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6661       to the list of URLs where the file
6662       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6663       (including the suffix) can be found.</p>
6664 <pre class="programlisting">
6665 DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
6666 DISTFILES+=     foo-file.tar.gz
6667 SITES.foo-file.tar.gz= \
6668 http://www.somewhere.com/somehow/ \
6669 http://www.somewhereelse.com/mirror/somehow/
6670 </pre>
6671 <p>When actually fetching the distfiles, each item from
6672       <code class="varname">MASTER_SITES</code> or
6673       <code class="varname">SITES.*</code> gets the name of each distfile
6674       appended to it, without an intermediate slash. Therefore,
6675       all site values have to end with a slash or other separator
6676       character. This allows for example to set
6677       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6678       that gets the name of the distfile as a parameter. In this
6679       case, the definition would look like:</p>
6680 <pre class="programlisting">
6681 MASTER_SITES=   http://www.example.com/download.cgi?file=
6682 </pre>
6683 <p> The exception to this rule are URLs starting with a dash.
6684       In that case the URL is taken as is, fetched and the result stored
6685       under the name of the distfile.</p>
6686 <p>There are some predefined values for
6687       <code class="varname">MASTER_SITES</code>, which can be used in
6688       packages.  The names of the variables should speak for
6689       themselves.</p>
6690 <pre class="programlisting">
6691 ${MASTER_SITE_APACHE}
6692 ${MASTER_SITE_BACKUP}
6693 ${MASTER_SITE_CYGWIN}
6694 ${MASTER_SITE_DEBIAN}
6695 ${MASTER_SITE_FREEBSD}
6696 ${MASTER_SITE_FREEBSD_LOCAL}
6697 ${MASTER_SITE_GENTOO}
6698 ${MASTER_SITE_GNOME}
6699 ${MASTER_SITE_GNU}
6700 ${MASTER_SITE_GNUSTEP}
6701 ${MASTER_SITE_IFARCHIVE}
6702 ${MASTER_SITE_KDE}
6703 ${MASTER_SITE_MOZILLA}
6704 ${MASTER_SITE_MYSQL}
6705 ${MASTER_SITE_OPENOFFICE}
6706 ${MASTER_SITE_PERL_CPAN}
6707 ${MASTER_SITE_PGSQL}
6708 ${MASTER_SITE_R_CRAN}
6709 ${MASTER_SITE_SOURCEFORGE}
6710 ${MASTER_SITE_SOURCEFORGE_JP}
6711 ${MASTER_SITE_SUNSITE}
6712 ${MASTER_SITE_SUSE}
6713 ${MASTER_SITE_TEX_CTAN}
6714 ${MASTER_SITE_XCONTRIB}
6715 ${MASTER_SITE_XEMACS}
6716 </pre>
6717 <p>Some explanations for the less self-explaining ones:
6718       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
6719       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
6720       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>
6721 <p>If you choose one of these predefined sites, you may
6722       want to specify a subdirectory of that site. Since these
6723       macros may expand to more than one actual site, you
6724       <span class="emphasis"><em>must</em></span> use the following construct to
6725       specify a subdirectory:</p>
6726 <pre class="programlisting">
6727 MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
6728 MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
6729 </pre>
6730 <p>Note the trailing slash after the subdirectory
6731       name.</p>
6732 </div>
6733 <div class="sect2" title="17.5.2. How are the files fetched?">
6734 <div class="titlepage"><div><div><h3 class="title">
6735 <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
6736 <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6737       all the distfiles exist in a local directory
6738       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6739       user). If the files do not exist, they are fetched using
6740       commands of the form</p>
6741 <pre class="programlisting">
6742 ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6743 </pre>
6744 <p>where <code class="literal">${site}</code> varies through
6745       several possibilities in turn: first,
6746       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6747       sites specified in either <code class="varname">SITES.file</code> if
6748       defined, else <code class="varname">MASTER_SITES</code> or
6749       <code class="varname">PATCH_SITES</code>, as applies, then finally the
6750       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6751       all except the first and the last can be optionally sorted
6752       by the user, via setting either
6753       <code class="varname">MASTER_SORT_RANDOM</code>, and
6754       <code class="varname">MASTER_SORT_AWK</code> or
6755       <code class="varname">MASTER_SORT_REGEX</code>.</p>
6756 <p> The specific command and arguments used depend on the
6757       <code class="varname">FETCH_USING</code> parameter. The example above is
6758       for <code class="literal">FETCH_USING=custom</code>.</p>
6759 <p>The distfiles mirror run by the NetBSD Foundation uses the
6760       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6761       distfiles, if they are freely distributable.  Packages setting
6762       <code class="varname">NO_SRC_ON_FTP</code> (usually to
6763       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
6764       mirrored.</p>
6765 </div>
6766 </div>
6767 <div class="sect1" title="17.6. The checksum phase">
6768 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6769 <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
6770 <p>After the distfile(s) are fetched, their checksum is
6771     generated and compared with the checksums stored in the
6772     distinfo file. If the checksums don't match, the build is
6773     aborted. This is to ensure the same distfile is used for
6774     building, and that the distfile wasn't changed, e.g. by some
6775     malign force, deliberately changed distfiles on the master
6776     distribution site or network lossage.</p>
6777 </div>
6778 <div class="sect1" title="17.7. The extract phase">
6779 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6780 <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
6781 <p>When the distfiles are present on the local system, they
6782     need to be extracted, as they usually come in the form of some
6783     compressed archive format.</p>
6784 <p>By default, all <code class="varname">DISTFILES</code> are
6785     extracted. If you only need some of them, you can set the
6786     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6787     files.</p>
6788 <p>Extracting the files is usually done by a little
6789     program, <code class="filename">mk/extract/extract</code>, which
6790     already knows how to extract various archive formats, so most
6791     likely you will not need to change anything here. But if you
6792     need, the following variables may help you:</p>
6793 <div class="variablelist"><dl>
6794 <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6795 <dd><p>Use these variables to override the default
6796       options for an extract command, which are defined in
6797       <code class="filename">mk/extract/extract</code>.</p></dd>
6798 <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6799 <dd><p>This variable can be set to
6800       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6801       (which is the default value), <code class="literal">pax</code>, or an
6802       absolute pathname pointing to the command with which tar
6803       archives should be extracted.  It is preferred to choose bsdtar over gtar
6804       if NetBSD's pax-as-tar is not good enough.</p></dd>
6805 </dl></div>
6806 <p>If the <code class="filename">extract</code> program doesn't
6807     serve your needs, you can also override the
6808     <code class="varname">EXTRACT_CMD</code> variable, which holds the
6809     command used for extracting the files. This command is
6810     executed in the <code class="filename">${WRKSRC}</code>
6811     directory. During execution of this command, the shell
6812     variable <code class="varname">extract_file</code> holds the absolute
6813     pathname of the file that is going to be extracted.</p>
6814 <p>And if that still does not suffice, you can override the
6815     <code class="varname">do-extract</code> target in the package
6816     Makefile.</p>
6817 </div>
6818 <div class="sect1" title="17.8. The patch phase">
6819 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6820 <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
6821 <p>After extraction, all the patches named by the
6822     <code class="varname">PATCHFILES</code>, those present in the patches
6823     subdirectory of the package as well as in
6824     $LOCALPATCHES/$PKGPATH (e.g.
6825     <code class="filename">/usr/local/patches/graphics/png</code>) are
6826     applied.  Patchfiles ending in <code class="filename">.Z</code> or
6827     <code class="filename">.gz</code> are uncompressed before they are
6828     applied, files ending in <code class="filename">.orig</code> or
6829     <code class="filename">.rej</code> are ignored. Any special options to
6830     <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
6831     <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>
6832 <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
6833     it fail if the patches apply with some lines of fuzz. Please
6834     fix (regen) the patches so that they apply cleanly. The
6835     rationale behind this is that patches that don't apply cleanly
6836     may end up being applied in the wrong place, and cause severe
6837     harm there.</p>
6838 </div>
6839 <div class="sect1" title="17.9. The tools phase">
6840 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6841 <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6842 <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>.
6843     </p>
6844 </div>
6845 <div class="sect1" title="17.10. The wrapper phase">
6846 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6847 <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
6848 <p>This phase creates wrapper programs for the compilers and
6849     linkers. The following variables can be used to tweak the
6850     wrappers.</p>
6851 <div class="variablelist"><dl>
6852 <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6853 <dd><p>The command used to print progress
6854       messages. Does nothing by default. Set to
6855       <code class="literal">${ECHO}</code> to see the progress
6856       messages.</p></dd>
6857 <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6858 <dd><p>This variable can be set to
6859       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6860       depending on whether you want additional information in the
6861       wrapper log file.</p></dd>
6862 <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6863 <dd><p>This variable can be set to
6864       <code class="literal">yes</code> or <code class="literal">no</code>, depending
6865       on whether the wrapper should use its cache, which will
6866       improve the speed. The default value is
6867       <code class="literal">yes</code>, but is forced to
6868       <code class="literal">no</code> if the platform does not support
6869       it.</p></dd>
6870 <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6871 <dd><p>A list of reordering commands. A reordering
6872       command has the form
6873       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6874       It ensures that that
6875       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6876       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6877       </p></dd>
6878 <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6879 <dd><p>A list of transformation commands. [TODO:
6880       investigate further]</p></dd>
6881 </dl></div>
6882 </div>
6883 <div class="sect1" title="17.11. The configure phase">
6884 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6885 <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
6886 <p>Most pieces of software need information on the header
6887     files, system calls, and library routines which are available
6888     on the platform they run on. The process of determining this
6889     information is known as configuration, and is usually
6890     automated. In most cases, a script is supplied with the
6891     distfiles, and its invocation results in generation of header
6892     files, Makefiles, etc.</p>
6893 <p>If the package contains a configure script, this can be
6894     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6895     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
6896     script, you should set <code class="varname">GNU_CONFIGURE</code> to
6897     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
6898     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6899 <pre class="programlisting">
6900 .for d in ${CONFIGURE_DIRS}
6901         cd ${WRKSRC} \
6902         &amp;&amp; cd ${d} \
6903         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6904 .endfor
6905 </pre>
6906 <p><code class="varname">CONFIGURE_DIRS</code> (default:
6907     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
6908     <code class="varname">WRKSRC</code>. In each of these directories, the
6909     configure script is run with the environment
6910     <code class="varname">CONFIGURE_ENV</code> and arguments
6911     <code class="varname">CONFIGURE_ARGS</code>. The variables
6912     <code class="varname">CONFIGURE_ENV</code>,
6913     <code class="varname">CONFIGURE_SCRIPT</code> (default:
6914     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
6915     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6916     package.</p>
6917 <p>If the program uses an <code class="filename">Imakefile</code>
6918     for configuration, the appropriate steps can be invoked by
6919     setting <code class="varname">USE_IMAKE</code> to
6920     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. (If you only want the package installed in
6921     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6922     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
6923     xmkmf's environment by adding them to the
6924     <code class="varname">SCRIPTS_ENV</code> variable.</p>
6925 <p>If the program uses <code class="filename">cmake</code>
6926     for configuration, the appropriate steps can be invoked by
6927     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
6928     You can add variables to cmake's environment by adding them to the
6929     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6930     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6931     The top directory argument is given by the
6932     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
6933     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
6934 <p>If there is no configure step at all, set
6935     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
6936 </div>
6937 <div class="sect1" title="17.12. The build phase">
6938 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6939 <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
6940 <p>For building a package, a rough equivalent of the
6941     following code is executed.</p>
6942 <pre class="programlisting">
6943 .for d in ${BUILD_DIRS}
6944         cd ${WRKSRC} \
6945         &amp;&amp; cd ${d} \
6946         &amp;&amp; env ${MAKE_ENV} \
6947             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6948                 -f ${MAKE_FILE} \
6949                 ${BUILD_TARGET}
6950 .endfor
6951 </pre>
6952 <p><code class="varname">BUILD_DIRS</code> (default:
6953     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
6954     <code class="varname">WRKSRC</code>. In each of these directories,
6955     <code class="varname">MAKE_PROGRAM</code> is run with the environment
6956     <code class="varname">MAKE_ENV</code> and arguments
6957     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6958     <code class="varname">MAKE_ENV</code>,
6959     <code class="varname">BUILD_MAKE_FLAGS</code>,
6960     <code class="varname">MAKE_FILE</code> and
6961     <code class="varname">BUILD_TARGET</code> may all be changed by the
6962     package.</p>
6963 <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
6964     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
6965     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
6966     default value of <code class="varname">MAKE_FILE</code> is
6967     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
6968     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
6969 <p>If there is no build step at all, set
6970     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
6971 </div>
6972 <div class="sect1" title="17.13. The test phase">
6973 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6974 <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
6975 <p>[TODO]</p>
6976 </div>
6977 <div class="sect1" title="17.14. The install phase">
6978 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6979 <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
6980 <p>Once the build stage has completed, the final step is to
6981     install the software in public directories, so users can
6982     access the programs and files.</p>
6983 <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
6984     equivalent of the following code is executed. Additionally,
6985     before and after this code, much magic is performed to do
6986     consistency checks, registering the package, and so on.</p>
6987 <pre class="programlisting">
6988 .for d in ${INSTALL_DIRS}
6989         cd ${WRKSRC} \
6990         &amp;&amp; cd ${d} \
6991         &amp;&amp; env ${MAKE_ENV} \
6992             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
6993                 -f ${MAKE_FILE} \
6994                 ${INSTALL_TARGET}
6995 .endfor
6996 </pre>
6997 <p>The variable's meanings are analogous to the ones in the
6998     <span class="emphasis"><em>build</em></span> phase.
6999     <code class="varname">INSTALL_DIRS</code> defaults to
7000     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
7001     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
7002     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
7003     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7004     defined.</p>
7005 <p>In the <span class="emphasis"><em>install</em></span> phase, the following
7006     variables are useful. They are all variations of the
7007     <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
7008     permissions preset. <code class="varname">INSTALL</code> is the plain
7009     install command. The specialized variants, together with their
7010     intended use, are:</p>
7011 <div class="variablelist"><dl>
7012 <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
7013 <dd><p>directories that contain
7014       binaries</p></dd>
7015 <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
7016 <dd><p>directories that contain
7017       scripts</p></dd>
7018 <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
7019 <dd><p>directories that contain shared and static
7020       libraries</p></dd>
7021 <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
7022 <dd><p>directories that contain data
7023       files</p></dd>
7024 <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
7025 <dd><p>directories that contain man
7026       pages</p></dd>
7027 <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
7028 <dd><p>binaries that can be stripped from debugging
7029       symbols</p></dd>
7030 <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
7031 <dd><p>binaries that cannot be
7032       stripped</p></dd>
7033 <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
7034 <dd><p>game
7035       binaries</p></dd>
7036 <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
7037 <dd><p>shared and static
7038       libraries</p></dd>
7039 <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7040 <dd><p>data files</p></dd>
7041 <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
7042 <dd><p>data files for
7043       games</p></dd>
7044 <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7045 <dd><p>man pages</p></dd>
7046 </dl></div>
7047 <p>Some other variables are:</p>
7048 <div class="variablelist"><dl>
7049 <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7050 <dd><p>A list of directories relative to
7051       <code class="varname">PREFIX</code> that are created by pkgsrc at the
7052       beginning of the <span class="emphasis"><em>install</em></span> phase.
7053       The package is supposed to create all needed directories itself
7054       before installing files to it and list all other directories here.
7055       </p></dd>
7056 </dl></div>
7057 <p>In the rare cases that a package shouldn't install anything,
7058     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
7059     mostly relevant for packages in the <code class="filename">regress</code>
7060     category.</p>
7061 </div>
7062 <div class="sect1" title="17.15. The package phase">
7063 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7064 <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
7065 <p>Once the install stage has completed, a binary package of
7066     the installed files can be built.  These binary packages can be
7067     used for quick installation without previous compilation, e.g. by
7068     the <span class="command"><strong>make bin-install</strong></span> or by using
7069     <span class="command"><strong>pkg_add</strong></span>.</p>
7070 <p>By default, the binary packages are created in
7071     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7072     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7073     one for each category in the <code class="varname">CATEGORIES</code>
7074     variable.  <code class="varname">PACKAGES</code> defaults to
7075     <code class="filename">pkgsrc/packages</code>.</p>
7076 </div>
7077 <div class="sect1" title="17.16. Cleaning up">
7078 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7079 <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
7080 <p>Once you're finished with a package, you can clean the work
7081     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
7082     to clean the work directories of all dependencies too, use
7083     <span class="command"><strong>make clean-depends</strong></span>.</p>
7084 </div>
7085 <div class="sect1" title="17.17. Other helpful targets">
7086 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7087 <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
7088 <div class="variablelist"><dl>
7089 <dt><span class="term">pre/post-*</span></dt>
7090 <dd><p>For any of the main targets described in the
7091           previous section, two auxiliary targets exist with
7092           <span class="quote">&#8220;<span class="quote">pre-</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">post-</span>&#8221;</span> used as a
7093           prefix for the main target's name.  These targets are
7094           invoked before and after the main target is called,
7095           allowing extra configuration or installation steps be
7096           performed from a package's Makefile, for example, which
7097           a program's configure script or install target
7098           omitted.</p></dd>
7099 <dt><span class="term">do-*</span></dt>
7100 <dd><p>Should one of the main targets do the wrong thing,
7101           and should there be no variable to fix this, you can
7102           redefine it with the do-* target.  (Note that redefining
7103           the target itself instead of the do-* target is a bad
7104           idea, as the pre-* and post-* targets won't be called
7105           anymore, etc.) You will not usually need to do
7106           this.</p></dd>
7107 <dt><span class="term">reinstall</span></dt>
7108 <dd>
7109 <p>If you did a <span class="command"><strong>make install</strong></span> and
7110           you noticed some file was not installed properly, you
7111           can repeat the installation with this target, which will
7112           ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
7113 <p>This is the default value of
7114           <code class="varname">DEPENDS_TARGET</code> except in the case of
7115           <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
7116           package</strong></span>, where the defaults are
7117           <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
7118           respectively.</p>
7119 </dd>
7120 <dt><span class="term">deinstall</span></dt>
7121 <dd>
7122 <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
7123           current directory, effectively de-installing the
7124           package. The following variables can be used to tune the
7125           behaviour:</p>
7126 <div class="variablelist"><dl>
7127 <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7128 <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>
7129 <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
7130 <dd><p>Remove all packages that require (depend on)
7131                 the given package.  This can be used to remove any
7132                 packages that may have been pulled in by a given
7133                 package, e.g. if <span class="command"><strong>make deinstall
7134                 DEINSTALLDEPENDS=1</strong></span> is done in
7135                 <code class="filename">pkgsrc/x11/kde</code>, this is
7136                 likely to remove whole KDE. Works by adding
7137                 <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
7138                 command line.</p></dd>
7139 </dl></div>
7140 </dd>
7141 <dt><span class="term">bin-install</span></dt>
7142 <dd><p>Install a binary package from local disk and via FTP
7143           from a list of sites (see the
7144           <code class="varname">BINPKG_SITES</code> variable), and do a
7145           <span class="command"><strong>make package</strong></span> if no binary package is
7146           available anywhere.  The arguments given to
7147           <span class="command"><strong>pkg_add</strong></span> can be set via
7148           <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7149           operation, etc.</p></dd>
7150 <dt><span class="term">update</span></dt>
7151 <dd>
7152 <p>This target causes the current package to be
7153           updated to the latest version.  The package and all
7154           depending packages first get de-installed, then current
7155           versions of the corresponding packages get compiled and
7156           installed.  This is similar to manually noting which
7157           packages are currently installed, then performing a
7158           series of <span class="command"><strong>make deinstall</strong></span> and
7159           <span class="command"><strong>make install</strong></span> (or whatever
7160           <code class="varname">UPDATE_TARGET</code> is set to) for these
7161           packages.</p>
7162 <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
7163           resume package updating in case a previous <span class="command"><strong>make
7164           update</strong></span> was interrupted for some reason.
7165           However, in this case, make sure you don't call
7166           <span class="command"><strong>make clean</strong></span> or otherwise remove the
7167           list of dependent packages in <code class="varname">WRKDIR</code>.
7168           Otherwise, you lose the ability to automatically update
7169           the current package along with the dependent packages
7170           you have installed.</p>
7171 <p>Resuming an interrupted <span class="command"><strong>make
7172           update</strong></span> will only work as long as the package
7173           tree remains unchanged.  If the source code for one of
7174           the packages to be updated has been changed, resuming
7175           <span class="command"><strong>make update</strong></span> will most certainly
7176           fail!</p>
7177 <p>The following variables can be used either on the
7178           command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7179           alter the behaviour of <span class="command"><strong>make
7180           update</strong></span>:</p>
7181 <div class="variablelist"><dl>
7182 <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7183 <dd><p>Install target to recursively use for the
7184                 updated package and the dependent packages.
7185                 Defaults to <code class="varname">DEPENDS_TARGET</code> if
7186                 set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
7187                 <span class="command"><strong>make update</strong></span>.  Other good
7188                 targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
7189                 <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
7190                 <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
7191                 endless loop!</p></dd>
7192 <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7193 <dd><p>Don't clean up after updating.  Useful if
7194                 you want to leave the work sources of the updated
7195                 packages around for inspection or other purposes.
7196                 Be sure you eventually clean up the source tree
7197                 (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
7198                 or you may run into troubles with old source code
7199                 still lying around on your next
7200                 <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
7201                 update</strong></span>.</p></dd>
7202 <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7203 <dd><p>Deinstall each package before installing
7204                 (making <code class="varname">DEPENDS_TARGET</code>). This
7205                 may be necessary if the
7206                 <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
7207                 called after interrupting a running <span class="command"><strong>make
7208                 update</strong></span>.</p></dd>
7209 <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7210 <dd><p>Allows you to disable recursion and hardcode
7211                 the target for packages.  The default is
7212                 <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
7213                 facilitating a recursive update of prerequisite
7214                 packages.  Only set
7215                 <code class="varname">DEPENDS_TARGET</code> if you want to
7216                 disable recursive updates. Use
7217                 <code class="varname">UPDATE_TARGET</code> instead to just
7218                 set a specific target for each package to be
7219                 installed during <span class="command"><strong>make update</strong></span>
7220                 (see above).</p></dd>
7221 </dl></div>
7222 </dd>
7223 <dt><span class="term">clean-update</span></dt>
7224 <dd>
7225 <p>Clean the source tree for all packages that would
7226           get updated if <span class="command"><strong>make update</strong></span> was called
7227           from the current directory.  This target should not be
7228           used if the current package (or any of its depending
7229           packages) have already been de-installed (e.g., after
7230           calling <span class="command"><strong>make update</strong></span>) or you may lose
7231           some packages you intended to update. As a rule of
7232           thumb: only use this target <span class="emphasis"><em>before</em></span>
7233           the first time you run <span class="command"><strong>make update</strong></span>
7234           and only if you have a dirty package tree (e.g., if you
7235           used <code class="varname">NOCLEAN</code>).</p>
7236 <p>If you are unsure about whether your tree is
7237           clean, you can either perform a <span class="command"><strong>make
7238           clean</strong></span> at the top of the tree, or use the
7239           following sequence of commands from the directory of the
7240           package you want to update (<span class="emphasis"><em>before</em></span>
7241           running <span class="command"><strong>make update</strong></span> for the first
7242           time, otherwise you lose all the packages you wanted to
7243           update!):</p>
7244 <pre class="screen">
7245 <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7246 <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7247 <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7248           </pre>
7249 <p>The following variables can be used either on the
7250           command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7251           <span class="command"><strong>make clean-update</strong></span>:</p>
7252 <div class="variablelist"><dl>
7253 <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
7254 <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
7255                 reconstruct the list of directories to update for
7256                 this package.  Only use this if <span class="command"><strong>make
7257                 update</strong></span> successfully installed all
7258                 packages you wanted to update.  Normally, this is
7259                 done automatically on <span class="command"><strong>make
7260                 update</strong></span>, but may have been suppressed by
7261                 the <code class="varname">NOCLEAN</code> variable (see
7262                 above).</p></dd>
7263 </dl></div>
7264 </dd>
7265 <dt><span class="term">replace</span></dt>
7266 <dd>
7267 <p>Update the installation of the current package.  This
7268           differs from update in that it does not replace dependent
7269           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
7270           target to work.</p>
7271 <p><span class="emphasis"><em>Be careful when using this
7272           target!</em></span> There are no guarantees that dependent
7273           packages will still work, in particular they will most
7274           certainly break if you <span class="command"><strong>make replace</strong></span> a
7275           library package whose shared library major version changed
7276           between your installed version and the new one.  For this
7277           reason, this target is not officially supported and only
7278           recommended for advanced users.</p>
7279 </dd>
7280 <dt><span class="term">info</span></dt>
7281 <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
7282           package. You can use this to check which version of a
7283           package is installed.</p></dd>
7284 <dt><span class="term">index</span></dt>
7285 <dd>
7286 <p>This is a top-level command, i.e. it should be used in
7287           the <code class="filename">pkgsrc</code> directory.  It creates a
7288           database of all packages in the local pkgsrc tree, including
7289           dependencies, comment, maintainer, and some other useful
7290           information.  Individual entries are created by running
7291           <span class="command"><strong>make describe</strong></span> in the packages'
7292           directories.  This index file is saved as
7293           <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
7294           verbose format by running <span class="command"><strong>make
7295           print-index</strong></span>.  You can search in it with
7296           <span class="command"><strong>make search
7297           key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
7298           extract a list of all packages that depend on a particular
7299           one by running <span class="command"><strong>make show-deps
7300           PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7301 <p>Running this command takes a very long time, some
7302           hours even on fast machines!</p>
7303 </dd>
7304 <dt><span class="term">readme</span></dt>
7305 <dd>
7306 <p>This target generates a
7307           <code class="filename">README.html</code> file, which can be
7308           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
7309           contain references to any packages which are in the
7310           <code class="varname">PACKAGES</code> directory on the local
7311           host. The generated files can be made to refer to URLs
7312           based on <code class="varname">FTP_PKG_URL_HOST</code> and
7313           <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7314           wanted to generate <code class="filename">README.html</code>
7315           files which pointed to binary packages on the local
7316           machine, in the directory
7317           <code class="filename">/usr/packages</code>, set
7318           <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7319           <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7320           <code class="varname">${PACKAGES}</code> directory and its
7321           subdirectories will be searched for all the binary
7322           packages.</p>
7323 <p>The target can be run at the toplevel or in category
7324           directories, in which case it descends recursively.</p>
7325 </dd>
7326 <dt><span class="term">readme-all</span></dt>
7327 <dd><p>This is a top-level command, run it in
7328           <code class="filename">pkgsrc</code>.  Use this target to create a
7329           file <code class="filename">README-all.html</code> which contains a
7330           list of all packages currently available in the NetBSD
7331           Packages Collection, together with the category they belong
7332           to and a short description. This file is compiled from the
7333           <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7334           to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
7335           readme</strong></span>.</p></dd>
7336 <dt><span class="term">cdrom-readme</span></dt>
7337 <dd><p>This is very much the same as the
7338           <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
7339           used when generating a pkgsrc tree to be written to a
7340           CD-ROM.  This target also produces
7341           <code class="filename">README.html</code> files, and can be made
7342           to refer to URLs based on
7343           <code class="varname">CDROM_PKG_URL_HOST</code> and
7344           <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7345 <dt><span class="term">show-distfiles</span></dt>
7346 <dd><p>This target shows which distfiles and patchfiles
7347           are needed to build the package
7348           (<code class="varname">ALLFILES</code>, which contains all
7349           <code class="varname">DISTFILES</code> and
7350           <code class="varname">PATCHFILES</code>, but not
7351           <code class="filename">patches/*</code>).</p></dd>
7352 <dt><span class="term">show-downlevel</span></dt>
7353 <dd><p>This target shows nothing if the package is not
7354           installed. If a version of this package is installed,
7355           but is not the version provided in this version of
7356           pkgsrc, then a warning message is displayed. This target
7357           can be used to show which of your installed packages are
7358           downlevel, and so the old versions can be deleted, and
7359           the current ones added.</p></dd>
7360 <dt><span class="term">show-pkgsrc-dir</span></dt>
7361 <dd><p>This target shows the directory in the pkgsrc
7362           hierarchy from which the package can be built and
7363           installed. This may not be the same directory as the one
7364           from which the package was installed. This target is
7365           intended to be used by people who may wish to upgrade
7366           many packages on a single host, and can be invoked from
7367           the top-level pkgsrc Makefile by using the
7368           <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
7369 <dt><span class="term">show-installed-depends</span></dt>
7370 <dd><p>This target shows which installed packages match
7371           the current package's <code class="varname">DEPENDS</code>. Useful
7372           if out of date dependencies are causing build
7373           problems.</p></dd>
7374 <dt><span class="term">check-shlibs</span></dt>
7375 <dd><p>After a package is installed, check all its
7376           binaries and (on ELF platforms) shared libraries to see
7377           if they find the shared libs they need.  Run by default
7378           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>
7379 <dt><span class="term">print-PLIST</span></dt>
7380 <dd>
7381 <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
7382           upgraded pkg, this prints out an attempt to generate a
7383           new <code class="filename">PLIST</code> from a <span class="command"><strong>find
7384           -newer work/.extract_done</strong></span>.  An attempt is made
7385           to care for shared libs etc., but it is
7386           <span class="emphasis"><em>strongly</em></span> recommended to review the
7387           result before putting it into
7388           <code class="filename">PLIST</code>. On upgrades, it's useful to
7389           diff the output of this command against an already
7390           existing <code class="filename">PLIST</code> file.</p>
7391 <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
7392           other methods that don't update file access times, be
7393           sure to add these files manually to your
7394           <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
7395           -newer</span>&#8221;</span> command used by this target won't catch
7396           them!</p>
7397 <p>See <a class="xref" href="#print-PLIST" title="13.3. Tweaking output of make print-PLIST">Section 13.3, &#8220;Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>&#8221;</a> for more
7398           information on this target.</p>
7399 </dd>
7400 <dt><span class="term">bulk-package</span></dt>
7401 <dd>
7402 <p>Used to do bulk builds. If an appropriate binary
7403           package already exists, no action is taken. If not, this
7404           target will compile, install and package it (and its
7405           depends, if <code class="varname">PKG_DEPENDS</code> is set
7406           properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
7407           After creating the binary package, the sources, the
7408           just-installed package and its required packages are
7409           removed, preserving free disk space.</p>
7410 <p><span class="emphasis"><em>Beware that this target may deinstall
7411           all packages installed on a system!</em></span></p>
7412 </dd>
7413 <dt><span class="term">bulk-install</span></dt>
7414 <dd>
7415 <p>Used during bulk-installs to install required
7416           packages. If an up-to-date binary package is available,
7417           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,
7418           <span class="command"><strong>make bulk-package</strong></span> will be executed,
7419           but the installed binary won't be removed.</p>
7420 <p>A binary package is considered
7421           <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
7422           <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>
7423 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
7424 <li class="listitem"><p>None of the package's files
7425               (<code class="filename">Makefile</code>, ...) were modified
7426               since it was built.</p></li>
7427 <li class="listitem"><p>None of the package's required (binary)
7428               packages were modified since it was built.</p></li>
7429 </ul></div>
7430 <p><span class="emphasis"><em>Beware that this target may deinstall
7431           all packages installed on a system!</em></span></p>
7432 </dd>
7433 </dl></div>
7434 </div>
7435 </div>
7436 <div class="chapter" title="Chapter 18. Tools needed for building or running">
7437 <div class="titlepage"><div><div><h2 class="title">
7438 <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
7439 <div class="toc">
7440 <p><b>Table of Contents</b></p>
7441 <dl>
7442 <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7443 <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7444 <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7445 <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
7446 </dl>
7447 </div>
7448 <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7449 by pkgsrc and also for individual packages to define what commands
7450 are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7451 or for later run-time of an installed packaged (such as
7452 <code class="varname">DEPENDS</code>).
7453 If the native system provides an adequate tool, then in many cases, a pkgsrc
7454 package will not be used.</p>
7455 <p>When building a package, the replacement tools are
7456 made available in a directory (as symlinks or wrapper scripts)
7457 that is early in the executable search path. Just like the buildlink
7458 system, this helps with consistent builds.</p>
7459 <p>A tool may be needed to help build a specific package. For example,
7460 perl, GNU make (gmake) or yacc may be needed.</p>
7461 <p>Also a tool may be needed, for example, because the native system's supplied
7462 tool may be inefficient for building a package with pkgsrc.
7463 For example, a package may need GNU awk, bison (instead of
7464 yacc) or a better sed.</p>
7465 <p>The tools used by a package can be listed by running
7466 <span class="command"><strong>make show-tools</strong></span>.</p>
7467 <div class="sect1" title="18.1. Tools for pkgsrc builds">
7468 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7469 <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
7470 <p>The default set of tools used by pkgsrc is defined in
7471 <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
7472 such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7473 <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
7474 These can be seen by running:
7475 <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7476 <p>If a package needs a specific program to build
7477 then the <code class="varname">USE_TOOLS</code> variable can be used
7478 to define the tools needed.</p>
7479 </div>
7480 <div class="sect1" title="18.2. Tools needed by packages">
7481 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7482 <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
7483 <p>In the following examples, the :pkgsrc means to use the pkgsrc version
7484 and not the native version for a build dependency.
7485 And the :run means that it is used for a
7486 run-time dependencies also (and becomes a DEPENDS).
7487 The default is a build dependency which can be set with
7488 :build. (So in this example, it is the same as gmake:build
7489 and pkg-config:build.)</p>
7490 <pre class="programlisting">
7491 USE_TOOLS+=     mktemp:pkgsrc
7492 USE_TOOLS+=     gmake perl:run pkg-config
7493 </pre>
7494 <p>When using the tools framework, a
7495 <code class="varname">TOOLS_PATH.foo</code> variable is defined
7496 which contains the full path to the appropriate tool. For example,
7497 <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
7498 on Linux systems.</p>
7499 <p>If you always need a pkgsrc version of the
7500 tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7501 </p>
7502 </div>
7503 <div class="sect1" title="18.3. Tools provided by platforms">
7504 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7505 <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
7506 <p>When improving or porting pkgsrc to a new platform, have a look
7507 at (or create) the corresponding platform specific make file fragment under
7508 <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7509 the name of the common tools. For example:</p>
7510 <pre class="programlisting">
7511 .if exists(/usr/bin/bzcat)
7512 TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
7513 .elif exists(/usr/bin/bzip2)
7514 TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
7515 .endif
7516
7517 TOOLS_PLATFORM.true?=           true                    # shell builtin
7518 </pre>
7519 </div>
7520 <div class="sect1" title="18.4. Questions regarding the tools">
7521 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7522 <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
7523 <div class="qandaset" title="Frequently Asked Questions">
7524 <a name="id1168229346836"></a><dl>
7525 <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
7526 </dt>
7527 <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
7528         tools?</a>
7529 </dt>
7530 <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
7531         package is using while being built? I want to know whether it
7532         uses sed or not.</a>
7533 </dt>
7534 </dl>
7535 <table border="0" width="100%" summary="Q and A Set">
7536 <col align="left" width="1%">
7537 <col>
7538 <tbody>
7539 <tr class="question" title="18.4.1.">
7540 <td align="left" valign="top">
7541 <a name="tools.new"></a><a name="id1168229346839"></a><p><b>18.4.1.</b></p>
7542 </td>
7543 <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7544 </tr>
7545 <tr class="answer">
7546 <td align="left" valign="top"></td>
7547 <td align="left" valign="top"><p>TODO</p></td>
7548 </tr>
7549 <tr class="question" title="18.4.2.">
7550 <td align="left" valign="top">
7551 <a name="tools.listall"></a><a name="id1168229346848"></a><p><b>18.4.2.</b></p>
7552 </td>
7553 <td align="left" valign="top"><p>How do I get a list of all available
7554         tools?</p></td>
7555 </tr>
7556 <tr class="answer">
7557 <td align="left" valign="top"></td>
7558 <td align="left" valign="top"><p>TODO</p></td>
7559 </tr>
7560 <tr class="question" title="18.4.3.">
7561 <td align="left" valign="top">
7562 <a name="tools.used"></a><a name="id1168229346857"></a><p><b>18.4.3.</b></p>
7563 </td>
7564 <td align="left" valign="top"><p>How can I get a list of all the tools that a
7565         package is using while being built? I want to know whether it
7566         uses sed or not.</p></td>
7567 </tr>
7568 <tr class="answer">
7569 <td align="left" valign="top"></td>
7570 <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7571         to do it.)</p></td>
7572 </tr>
7573 </tbody>
7574 </table>
7575 </div>
7576 </div>
7577 </div>
7578 <div class="chapter" title="Chapter 19. Making your package work">
7579 <div class="titlepage"><div><div><h2 class="title">
7580 <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
7581 <div class="toc">
7582 <p><b>Table of Contents</b></p>
7583 <dl>
7584 <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
7585 <dd><dl>
7586 <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
7587 <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
7588 <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7589 <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7590 <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7591 <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7592 <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7593 <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7594 <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7595 <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7596 <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7597 <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7598 </dl></dd>
7599 <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
7600 <dd><dl>
7601 <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7602 <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>
7603 </dl></dd>
7604 <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
7605 <dd><dl>
7606 <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7607 <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7608 <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7609 </dl></dd>
7610 <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7611 <dd><dl>
7612 <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7613 <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7614 <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7615 <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7616 </dl></dd>
7617 <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
7618 <dd><dl>
7619 <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7620 <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
7621 <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
7622 <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7623 </dl></dd>
7624 <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
7625 <dd><dl>
7626 <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7627 <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7628 <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7629 <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7630 <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7631 <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7632 <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7633 <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
7634 <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
7635 <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
7636 <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7637 <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7638 <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7639 <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7640 <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7641 <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7642 <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7643 <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
7644     emulation</a></span></dt>
7645 <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7646 <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
7647 </dl></dd>
7648 <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
7649 </dl>
7650 </div>
7651 <div class="sect1" title="19.1. General operation">
7652 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7653 <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
7654 <div class="sect2" title="19.1.1. Portability of packages">
7655 <div class="titlepage"><div><div><h3 class="title">
7656 <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
7657 <p>One appealing feature of pkgsrc is that it runs on many
7658     different platforms. As a result, it is important to ensure,
7659     where possible, that packages in pkgsrc are portable. This
7660     chapter mentions some particular details you should pay
7661     attention to while working on pkgsrc.</p>
7662 </div>
7663 <div class="sect2" title="19.1.2. How to pull in user-settable variables from mk.conf">
7664 <div class="titlepage"><div><div><h3 class="title">
7665 <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>
7666 </h3></div></div></div>
7667 <p>The pkgsrc user can configure pkgsrc by overriding several
7668     variables in the file pointed to by <code class="varname">MAKECONF</code>,
7669     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
7670     want to use those variables in the preprocessor directives of
7671     <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
7672     <code class="literal">.for</code>), you need to include the file
7673     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7674     loads the user preferences.</p>
7675 <p>But note that some variables may not be completely defined
7676     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7677     included, as they may contain references to variables that are
7678     not yet defined. In shell commands this is no problem, since
7679     variables are actually macros, which are only expanded when they
7680     are used. But in the preprocessor directives mentioned above and
7681     in dependency lines (of the form <code class="literal">target:
7682     dependencies</code>) the variables are expanded at load
7683     time.</p>
7684 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
7685 <h3 class="title">Note</h3>
7686 <p>Currently there is no exhaustive list of all
7687     variables that tells you whether they can be used at load time
7688     or only at run time, but it is in preparation.</p>
7689 </div>
7690 </div>
7691 <div class="sect2" title="19.1.3. User interaction">
7692 <div class="titlepage"><div><div><h3 class="title">
7693 <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
7694 <p>Occasionally, packages require interaction from the user,
7695     and this can be in a number of ways:</p>
7696 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
7697 <li class="listitem"><p>When fetching the distfiles, some packages require user
7698         interaction such as entering username/password or accepting a
7699         license on a web page.</p></li>
7700 <li class="listitem"><p>When extracting the distfiles, some packages may ask for
7701         passwords.</p></li>
7702 <li class="listitem"><p>help to configure the package before it is built</p></li>
7703 <li class="listitem"><p>help during the build process</p></li>
7704 <li class="listitem"><p>help during the installation of a package</p></li>
7705 </ul></div>
7706 <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7707     provided to notify the pkgsrc mechanism of an interactive stage
7708     which will be needed, and this should be set in the package's
7709     <code class="filename">Makefile</code>, e.g.:</p>
7710 <pre class="programlisting">
7711 INTERACTIVE_STAGE=      build
7712     </pre>
7713 <p>Multiple interactive stages can be specified:</p>
7714 <pre class="programlisting">
7715 INTERACTIVE_STAGE=      configure install
7716     </pre>
7717 <p>The user can then decide to skip this package by setting the
7718     <code class="varname">BATCH</code> variable.</p>
7719 </div>
7720 <div class="sect2" title="19.1.4. Handling licenses">
7721 <div class="titlepage"><div><div><h3 class="title">
7722 <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
7723 <p>Authors of software can choose the licence under which
7724     software can be copied.  This is due to copyright law, and reasons
7725     for license choices are outside the scope of pkgsrc.  The pkgsrc
7726     system recognizes that there are a number of licenses which some
7727     users may find objectionable or difficult or impossible to comply
7728     with.  The Free Software Foundation has declared some licenses
7729     "Free", and the Open Source Initiative has a definition of "Open
7730     Source".  The pkgsrc system, as a policy choice, does not label
7731     packages which have licenses that are Free or Open Source.
7732     However, packages without a license meeting either of those tests
7733     are labeled with a license tag denoting the license.  Note that a
7734     package with no license to copy trivially does not meet either the
7735     Free or Open Source test.</p>
7736 <p>For packages which are not Free or Open Source, pkgsrc will
7737     not build the package unless the user has indicated to pkgsrc that
7738     packages with that particular license may be built.  Note that
7739     this documentation avoids the term "accepted the license".  The
7740     pkgsrc system is merely providing a mechanism to avoid
7741     accidentally building a package with a non-free license;
7742     judgement and responsibility remain with the user.  (Installation
7743     of binary packages are not currently subject to this mechanism;
7744     this is a bug.)</p>
7745 <p>One might want to only install packages with a BSD license,
7746     or the GPL, and not the other.  The free licenses are added to the
7747     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
7748     user can override the default by setting the
7749     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7750     of "+=".  The licenses accepted by default are:
7751     </p>
7752 <pre class="programlisting">
7753     public-domain
7754     gnu-gpl-v2 gnu-lgpl-v2
7755     gnu-gpl-v3 gnu-lgpl-v3
7756     original-bsd modified-bsd
7757     x11
7758     apache-2.0
7759     cddl-1.0
7760     open-font-license
7761     </pre>
7762 <p>
7763     </p>
7764 <p>The license tag mechanism is intended to address
7765     copyright-related issues surrounding building, installing and
7766     using a package, and not to address redistribution issues (see
7767     <code class="varname">RESTRICTED</code> and
7768     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7769     Packages with redistribution restrictions should set these
7770     tags.</p>
7771 <p>Denoting that a package may be copied according to a
7772     particular license is done by placing the license in
7773     <code class="filename">pkgsrc/licenses</code> and setting the
7774     <code class="varname">LICENSE</code> variable to a string identifying the
7775     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>
7776 <pre class="programlisting">
7777 LICENSE=        xv-license
7778     </pre>
7779 <p>When trying to build, the user will get a notice that the
7780     package is covered by a license which has not been placed in the
7781     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7782 <pre class="programlisting">
7783 <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7784 ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
7785 ===&gt;     To view the license, enter "/usr/bin/make show-license".
7786 ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
7787 ===&gt;     ACCEPTABLE_LICENSES+=xv-license
7788 *** Error code 1
7789     </pre>
7790 <p>The license can be viewed with <span class="command"><strong>make
7791     show-license</strong></span>, and if the user so chooses, the line
7792     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7793     convey to pkgsrc that it should not in the future fail because of
7794     that license:</p>
7795 <pre class="programlisting">
7796 ACCEPTABLE_LICENSES+=xv-license
7797     </pre>
7798 <p>When adding a package with a new license, the license text
7799     should be added to <code class="filename">pkgsrc/licenses</code> for
7800     displaying.  A list of known licenses can be seen in this
7801     directory.</p>
7802 <p>When the license changes (in a way other than formatting),
7803     please make sure that the new license has a different name (e.g.,
7804     append the version number if it exists, or the date).  Just
7805     because a user told pkgsrc to build programs under a previous
7806     version of a license does not mean that pkgsrc should build
7807     programs under the new licenses.  The higher-level point is that
7808     pkgsrc does not evaluate licenses for reasonableness; the only
7809     test is a mechanistic test of whether a particular text has been
7810     approved by either of two bodies.</p>
7811 <p>The use of <code class="varname">LICENSE=shareware</code>,
7812     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7813     is deprecated because it does not crisply refer to a particular
7814     license text.  Another problem with such usage is that it does not
7815     enable a user to tell pkgsrc to proceed for a single package
7816     without also telling pkgsrc to proceed for all packages with that
7817     tag.</p>
7818 </div>
7819 <div class="sect2" title="19.1.5. Restricted packages">
7820 <div class="titlepage"><div><div><h3 class="title">
7821 <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
7822 <p>Some licenses restrict how software may be re-distributed.
7823     Because a license tag is required unless the package is Free or
7824     Open Source, all packages with restrictions should have license
7825     tags.  By declaring the restrictions, package tools can
7826     automatically refrain from e.g. placing binary packages on FTP
7827     sites.</p>
7828 <p>There are four restrictions that may be encoded, which are
7829     the cross product of sources (distfiles) and binaries not being
7830     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
7831     language in any license, and because non-Free licenses tend to be
7832     different from each other, pkgsrc adopts a definition of FTP and
7833     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
7834     should not be made available over the Internet at no charge.
7835     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7836     made available on some kind of media, together with other source
7837     and binary packages, and which is sold for a distribution charge.
7838     </p>
7839 <p>In order to encode these restrictions, the package system
7840     defines five make variables that can be set to note these
7841     restrictions:</p>
7842 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
7843 <li class="listitem">
7844 <p><code class="varname">RESTRICTED</code></p>
7845 <p>This variable should be set whenever a restriction
7846         exists (regardless of its kind).  Set this variable to a
7847         string containing the reason for the restriction.  It should
7848         be understood that those wanting to understand the restriction
7849         will have to read the license, and perhaps seek advice of
7850         counsel.</p>
7851 </li>
7852 <li class="listitem">
7853 <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7854 <p>Binaries may not be placed on CD-ROM containing other
7855         binary packages, for which a distribution charge may be made.
7856         In this case, set this variable to
7857         <code class="varname">${RESTRICTED}</code>.</p>
7858 </li>
7859 <li class="listitem">
7860 <p><code class="varname">NO_BIN_ON_FTP</code></p>
7861 <p>Binaries may not made available on the Internet without
7862         charge.  In this case, set this variable to
7863         <code class="varname">${RESTRICTED}</code>.  If this variable is set,
7864         binary packages will not be included on ftp.NetBSD.org.</p>
7865 </li>
7866 <li class="listitem">
7867 <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7868 <p>Distfiles may not be placed on CD-ROM, together with
7869         other distfiles, for which a fee may be charged.  In this
7870         case, set this variable to <code class="varname">${RESTRICTED}</code>.
7871         </p>
7872 </li>
7873 <li class="listitem">
7874 <p><code class="varname">NO_SRC_ON_FTP</code></p>
7875 <p>Distfiles may not made available via FTP at no charge.
7876         In this case, set this variable to
7877         <code class="varname">${RESTRICTED}</code>.  If this variable is set,
7878         the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7879 </li>
7880 </ul></div>
7881 </div>
7882 <div class="sect2" title="19.1.6. Handling dependencies">
7883 <div class="titlepage"><div><div><h3 class="title">
7884 <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
7885 <p>Your package may depend on some other package being present
7886     - and there are various ways of expressing this dependency.
7887     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7888     <code class="varname">DEPENDS</code> definitions, the
7889     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7890     via <code class="filename">buildlink3.mk</code>, which is the preferred way
7891     to handle dependencies, and which uses the variables named above.
7892     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
7893 <p>The basic difference between the two variables is as
7894     follows: The <code class="varname">DEPENDS</code> definition registers
7895     that pre-requisite in the binary package so it will be pulled in
7896     when the binary package is later installed, whilst the
7897     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7898     dependency that is only needed for building the package.</p>
7899 <p>This means that if you only need a package present whilst
7900     you are building, it should be noted as a
7901     <code class="varname">BUILD_DEPENDS</code>.</p>
7902 <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7903     <code class="varname">DEPENDS</code> definition is:</p>
7904 <pre class="programlisting">
7905 &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
7906     </pre>
7907 <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
7908     may include any of the wildcard version numbers recognized by
7909     <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>
7910 <div class="orderedlist"><ol class="orderedlist" type="1">
7911 <li class="listitem">
7912 <p>If your package needs another package's binaries or
7913         libraries to build or run, and if that package has a
7914         <code class="filename">buildlink3.mk</code> file available, use it:</p>
7915 <pre class="programlisting">
7916 .include "../../graphics/jpeg/buildlink3.mk"
7917         </pre>
7918 </li>
7919 <li class="listitem">
7920 <p>If your package needs to use another package to build
7921         itself and there is no <code class="filename">buildlink3.mk</code>
7922         file available, use the <code class="varname">BUILD_DEPENDS</code>
7923         definition:</p>
7924 <pre class="programlisting">
7925 BUILD_DEPENDS+= autoconf-2.13:../../devel/autoconf
7926         </pre>
7927 </li>
7928 <li class="listitem">
7929 <p>If your package needs a library with which to link and
7930         again there is no <code class="filename">buildlink3.mk</code> file
7931         available, this is specified using the
7932         <code class="varname">DEPENDS</code> definition. For example:</p>
7933 <pre class="programlisting">
7934 DEPENDS+=       xpm-3.4j:../../graphics/xpm
7935         </pre>
7936 <p>You can also use wildcards in package dependencies:</p>
7937 <pre class="programlisting">
7938 DEPENDS+=       xpm-[0-9]*:../../graphics/xpm
7939         </pre>
7940 <p>Note that such wildcard dependencies are retained when
7941         creating binary packages.  The dependency is checked when
7942         installing the binary package and any package which matches
7943         the pattern will be used.  Wildcard dependencies should be
7944         used with care.</p>
7945 <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
7946         <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
7947         such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
7948         <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
7949 <p>Wildcards can also be used to specify that a package
7950         will only build against a certain minimum version of a
7951         pre-requisite:</p>
7952 <pre class="programlisting">
7953 DEPENDS+=       tiff&gt;=3.5.4:../../graphics/tiff
7954         </pre>
7955 <p>This means that the package will build against version
7956         3.5.4 of the tiff library or newer.  Such a dependency may
7957         be warranted if, for example, the API of the library has
7958         changed with version 3.5.4 and a package would not compile
7959         against an earlier version of tiff.</p>
7960 <p>Please note that such dependencies should only be
7961         updated if a package requires a newer pre-requisite, but
7962         not to denote recommendations such as
7963         ABI changes that do not prevent a package from building
7964         correctly.  Such recommendations can be expressed using
7965         <code class="varname">ABI_DEPENDS</code>:</p>
7966 <pre class="programlisting">
7967 ABI_DEPENDS+=   tiff&gt;=3.6.1:../../graphics/tiff
7968         </pre>
7969 <p>In addition to the above <code class="varname">DEPENDS</code>
7970         line, this denotes that while a package will build against
7971         tiff&gt;=3.5.4, at least version 3.6.1 is recommended.
7972         <code class="varname">ABI_DEPENDS</code> entries will be turned into
7973         dependencies unless explicitly ignored (in which case a
7974         warning will be printed).</p>
7975 <p>To ignore these ABI dependency recommendations and just
7976         use the required <code class="varname">DEPENDS</code>, set
7977         <code class="varname">USE_ABI_DEPENDS=NO</code>.   This may make
7978         it easier and faster to update packages built using pkgsrc,
7979         since older compatible dependencies can continue to be
7980         used. This is useful for people who watch their rebuilds
7981         very carefully; it is not very good as a general-purpose
7982         hammer.  If you use it, you need to be mindful of possible
7983         ABI changes, including those from the underlying OS.</p>
7984 <p>Packages that are built with recommendations ignored
7985         may not be uploaded to ftp.NetBSD.org by developers and
7986         should not be used across different systems that may have
7987         different versions of binary packages installed.</p>
7988 <p>For security fixes, please update the package
7989         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
7990         information.</p>
7991 </li>
7992 <li class="listitem">
7993 <p>If your package needs some executable to be able to run
7994         correctly and if there's no
7995         <code class="filename">buildlink3.mk</code> file, this is specified
7996         using the <code class="varname">DEPENDS</code> variable. The
7997         <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
7998         be able to execute the latex binary from the teTeX package
7999         when it runs, and that is specified:</p>
8000 <pre class="programlisting">
8001 DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
8002         </pre>
8003 <p>The comment about wildcard dependencies from previous
8004         paragraph applies here, too.</p>
8005 </li>
8006 </ol></div>
8007 <p>If your package needs files from another package to build,
8008     add the relevant distribution files to
8009     <code class="varname">DISTFILES</code>, so they will be extracted
8010     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.
8011     (It relies on the jpeg sources being present in source form
8012     during the build.)</p>
8013 </div>
8014 <div class="sect2" title="19.1.7. Handling conflicts with other packages">
8015 <div class="titlepage"><div><div><h3 class="title">
8016 <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
8017 <p>Your package may conflict with other packages a user might
8018     already have installed on his system, e.g. if your package
8019     installs the same set of files as another package in the pkgsrc
8020     tree.</p>
8021 <p>In this case you can set <code class="varname">CONFLICTS</code> to a
8022     space-separated list of packages (including version string) your
8023     package conflicts with.</p>
8024 <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>
8025     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>
8026     install the same shared library, thus you set in
8027     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8028 <pre class="programlisting">
8029 CONFLICTS=      Xaw-Xpm-[0-9]*
8030     </pre>
8031 <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
8032 <pre class="programlisting">
8033 CONFLICTS=      Xaw3d-[0-9]*
8034     </pre>
8035 <p>Packages will automatically conflict with other packages
8036     with the name prefix and a different version
8037     string. <span class="quote">&#8220;<span class="quote">Xaw3d-1.5</span>&#8221;</span> e.g. will automatically
8038     conflict with the older version <span class="quote">&#8220;<span class="quote">Xaw3d-1.3</span>&#8221;</span>.</p>
8039 </div>
8040 <div class="sect2" title="19.1.8. Packages that cannot or should not be built">
8041 <div class="titlepage"><div><div><h3 class="title">
8042 <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
8043 <p>There are several reasons why a package might be
8044     instructed to not build under certain circumstances.  If the
8045     package builds and runs on most platforms, the exceptions
8046     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
8047     the package builds and runs on a small handful of platforms,
8048     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8049     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8050     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8051     (OS-version-platform) that can use glob-style
8052     wildcards.</p>
8053 <p>Some packages are tightly bound to a specific version of an
8054     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
8055     backwards compatible with other versions of the OS, and should be
8056     uploaded to a version specific directory on the FTP server.  Mark
8057     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8058     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
8059     the package system internals, but may be used in the
8060     future.</p>
8061 <p>If the package should be skipped (for example, because it
8062     provides functionality already provided by the system), set
8063     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
8064     the package should fail because some preconditions are not met,
8065     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
8066     message.</p>
8067 </div>
8068 <div class="sect2" title="19.1.9. Packages which should not be deleted, once installed">
8069 <div class="titlepage"><div><div><h3 class="title">
8070 <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
8071 <p>To ensure that a package may not be deleted, once it has been
8072     installed, the <code class="varname">PKG_PRESERVE</code> definition should
8073     be set in the package Makefile. This will be carried into any
8074     binary package that is made from this pkgsrc entry. A
8075     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
8076     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
8077     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
8078 </div>
8079 <div class="sect2" title="19.1.10. Handling packages with security problems">
8080 <div class="titlepage"><div><div><h3 class="title">
8081 <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
8082 <p>When a vulnerability is found, this should be noted in
8083     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
8084     and after committing that file, use <span class="command"><strong>make upload</strong></span>
8085     in the same directory to update the file on ftp.NetBSD.org.</p>
8086 <p>After fixing the vulnerability by a patch, its
8087     <code class="varname">PKGREVISION</code> should be increased (this
8088     is of course not necessary if the problem is fixed by using
8089     a newer release of the software).</p>
8090 <p>Also, if the fix should be applied to the stable pkgsrc
8091     branch, be sure to submit a pullup request!</p>
8092 <p>Binary packages already on ftp.NetBSD.org will be handled
8093     semi-automatically by a weekly cron job.</p>
8094 </div>
8095 <div class="sect2" title="19.1.11. How to handle incrementing versions when fixing an existing package">
8096 <div class="titlepage"><div><div><h3 class="title">
8097 <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
8098 <p>When making fixes to an existing package it can be useful
8099     to change the version number in <code class="varname">PKGNAME</code>. To
8100     avoid conflicting with future versions by the original author, a
8101     <span class="quote">&#8220;<span class="quote">nb1</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">nb2</span>&#8221;</span>, ... suffix can be used
8102     on package versions by setting <code class="varname">PKGREVISION=1</code>
8103     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
8104     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
8105 <pre class="programlisting">
8106 DISTNAME=       foo-17.42
8107 PKGREVISION=    9
8108     </pre>
8109 <p>will result in a <code class="varname">PKGNAME</code> of
8110     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
8111     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
8112     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8113     <code class="varname">PKGNAME_NOREV</code>.</p>
8114 <p>When a new release of the package is released, the
8115     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8116     minor release of the above package, things should be like:</p>
8117 <pre class="programlisting">
8118 DISTNAME=       foo-17.43
8119     </pre>
8120 <p><code class="varname">PKGREVISION</code> should be incremented for any
8121     non-trivial change in the resulting binary package.  Without a
8122     <code class="varname">PKGREVISION</code> bump, someone with the previous
8123     version installed has no way of knowing that their package is out
8124     of date.  Thus, changes without increasing
8125     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8126     trivial that no reasonable person would want to upgrade", and this
8127     is the rough test for when increasing
8128     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
8129     changes that do not merit increasing
8130     <code class="varname">PKGREVISION</code> are:</p>
8131 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8132 <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
8133       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
8134       or comments in Makefile.</p></li>
8135 <li class="listitem"><p>
8136       Changing build variables if the resulting binary package is the same.</p></li>
8137 <li class="listitem"><p>
8138       Changing <code class="filename">DESCR</code>.</p></li>
8139 <li class="listitem"><p>
8140       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8141 </ul></div>
8142 <p>Examples of changes that do merit an increase to
8143     <code class="varname">PKGREVISION</code> include:</p>
8144 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8145 <li class="listitem"><p>
8146       Security fixes</p></li>
8147 <li class="listitem"><p>
8148       Changes or additions to a patch file</p></li>
8149 <li class="listitem"><p>
8150       Changes to the <code class="filename">PLIST</code></p></li>
8151 <li class="listitem"><p>A dependency is changed or renamed.</p></li>
8152 </ul></div>
8153 <p>PKGREVISION must also be incremented when dependencies have ABI
8154     changes.</p>
8155 </div>
8156 <div class="sect2" title="19.1.12. Substituting variable text in the package files (the SUBST framework)">
8157 <div class="titlepage"><div><div><h3 class="title">
8158 <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
8159 <p>When you want to replace the same text in multiple files
8160     or when the replacement text varies, patches alone cannot help.
8161     This is where the SUBST framework comes in. It provides an
8162     easy-to-use interface for replacing text in files.
8163     Example:</p>
8164 <pre class="programlisting">
8165 SUBST_CLASSES+=                 fix-paths
8166 SUBST_STAGE.fix-paths=          pre-configure
8167 SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
8168 SUBST_FILES.fix-paths=          src/*.c
8169 SUBST_FILES.fix-paths+=         scripts/*.sh
8170 SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
8171 SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
8172     </pre>
8173 <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8174     that are used to identify the different SUBST blocks that are
8175     defined. The SUBST framework is heavily used by pkgsrc, so it is
8176     important to always use the <code class="literal">+=</code> operator with
8177     this variable. Otherwise some substitutions may be
8178     skipped.</p>
8179 <p>The remaining variables of each SUBST block are
8180     parameterized with the identifier from the first line
8181     (<code class="literal">fix-paths</code> in this case.) They can be seen as
8182     parameters to a function call.</p>
8183 <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8184     which the replacement will take place. All combinations of
8185     <code class="literal">pre-</code>, <code class="literal">do-</code> and
8186     <code class="literal">post-</code> together with a phase name are
8187     possible, though only few are actually used. Most commonly used
8188     are <code class="literal">post-patch</code> and
8189     <code class="literal">pre-configure</code>. Of these two,
8190     <code class="literal">pre-configure</code> should be preferred because
8191     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
8192     have the state after applying the patches but before making any
8193     other changes. This is especially useful when you are debugging
8194     a package in order to create new patches for it. Similarly,
8195     <code class="literal">post-build</code> is preferred over
8196     <code class="literal">pre-install</code>, because the install phase should
8197     generally be kept as simple as possible. When you use
8198     <code class="literal">post-build</code>, you have the same files in the
8199     working directory that will be installed later, so you can check
8200     if the substitution has succeeded.</p>
8201 <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8202     that is printed just before the substitution is done.</p>
8203 <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8204     globbing patterns that specifies the files in which the
8205     substitution will take place. The patterns are interpreted
8206     relatively to the <code class="varname">WRKSRC</code> directory.</p>
8207 <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
8208     <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
8209     command should be prefixed with <code class="literal">-e</code>, so that
8210     all SUBST blocks look uniform.</p>
8211 <p>There are some more variables, but they are so seldomly
8212     used that they are only documented in the
8213     <code class="filename">mk/subst.mk</code> file.</p>
8214 </div>
8215 </div>
8216 <div class="sect1" title="19.2. Fixing problems in the fetch phase">
8217 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8218 <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
8219 <div class="sect2" title="19.2.1. Packages whose distfiles aren't available for plain downloading">
8220 <div class="titlepage"><div><div><h3 class="title">
8221 <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
8222 <p>If you need to download from a dynamic URL you can set
8223     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
8224     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8225     with the name of each file to download as an argument, expecting
8226     it to output the URL of the directory from which to download
8227     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
8228     example of this usage.</p>
8229 <p>If the download can't be automated, because the user must
8230     submit personal information to apply for a password, or must pay
8231     for the source, or whatever, you can set
8232     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8233     displayed to the user before aborting the build. Example:</p>
8234 <pre class="programlisting">
8235 FETCH_MESSAGE=  "Please download the files"
8236 FETCH_MESSAGE+= "    "${DISTFILES:Q}
8237 FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8238     </pre>
8239 </div>
8240 <div class="sect2" title="19.2.2. How to handle modified distfiles with the 'old' name">
8241 <div class="titlepage"><div><div><h3 class="title">
8242 <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
8243 <p>Sometimes authors of a software package make some
8244     modifications after the software was released, and they put up a
8245     new distfile without changing the package's version number. If a
8246     package is already in pkgsrc at that time, the checksum will
8247     no longer match. The contents of the new distfile should be
8248     compared against the old one before changing anything, to make
8249     sure the distfile was really updated on purpose, and that
8250     no trojan horse or so crept in.
8251     Please mention that the distfiles were compared and what was found
8252     in your commit message.
8253     Then, the correct way to work around this is to
8254     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8255     usually based on <code class="varname">PKGNAME_NOREV</code>. All
8256     <code class="varname">DISTFILES</code> and
8257     <code class="varname">PATCHFILES</code> for this package will be put in that
8258     subdirectory of the local distfiles directory.
8259     (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.)
8260     In case this
8261     happens more often, <code class="varname">PKGNAME</code> can be used (thus
8262     including the <code class="filename">nbX</code> suffix) or a date stamp
8263     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8264     Do not forget regenerating the <code class="filename">distinfo</code> file
8265     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8266     path in the filenames.
8267     Also increase the PKGREVISION if the installed package is different.
8268     Furthermore, a mail to the package's authors seems appropriate
8269     telling them that changing distfiles after releases without
8270     changing the file names is not good practice.</p>
8271 </div>
8272 </div>
8273 <div class="sect1" title="19.3. Fixing problems in the configure phase">
8274 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8275 <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
8276 <div class="sect2" title="19.3.1. Shared libraries - libtool">
8277 <div class="titlepage"><div><div><h3 class="title">
8278 <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
8279 <p>pkgsrc supports many different machines, with different
8280     object formats like a.out and ELF, and varying abilities to do
8281     shared library and dynamic loading at all. To accompany this,
8282     varying commands and options have to be passed to the
8283     compiler, linker, etc. to get the Right Thing, which can be
8284     pretty annoying especially if you don't have all the machines
8285     at your hand to test things.  The
8286     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
8287     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
8288     both static and dynamic libraries from a set of source files,
8289     thus being platform-independent.</p>
8290 <p>Here's how to use libtool in a package in seven simple
8291     steps:</p>
8292 <div class="orderedlist"><ol class="orderedlist" type="1">
8293 <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
8294         Makefile.</p></li>
8295 <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
8296         ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
8297         add it to the definition of <code class="varname">CC</code>, if only
8298         libraries are being built in a given Makefile. This one command
8299         will build both PIC and non-PIC library objects, so you need not
8300         have separate shared and non-shared library rules.</p></li>
8301 <li class="listitem">
8302 <p>For the linking of the library, remove any
8303         <span class="quote">&#8220;<span class="quote">ar</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">ranlib</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">ld
8304         -Bshareable</span>&#8221;</span> commands, and instead use:</p>
8305 <pre class="programlisting">
8306 ${LIBTOOL} --mode=link \
8307     ${CC} -o ${.TARGET:.a=.la} \
8308         ${OBJS:.o=.lo} \
8309         -rpath ${PREFIX}/lib \
8310         -version-info major:minor
8311         </pre>
8312 <p>Note that the library is changed to have a
8313         <code class="filename">.la</code> extension, and the objects are
8314         changed to have a <code class="filename">.lo</code>
8315         extension. Change <code class="varname">OBJS</code> as
8316         necessary. This automatically creates all of the
8317         <code class="filename">.a</code>,
8318         <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8319         necessary) in the build directory. Be sure to include
8320         <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
8321         minor are zero, as libtool will otherwise strip off the
8322         shared library version.</p>
8323 <p>From the libtool manual:</p>
8324 <pre class="programlisting">
8325 So, libtool library versions are described by three integers:
8326
8327 CURRENT
8328 The most recent interface number that this library implements.
8329
8330 REVISION
8331 The implementation number of the CURRENT interface.
8332
8333 AGE
8334 The difference between the newest and oldest interfaces that
8335 this library implements.  In other words, the library implements
8336 all the interface numbers in the range from number `CURRENT -
8337 AGE' to `CURRENT'.
8338
8339 If two libraries have identical CURRENT and AGE numbers, then the
8340 dynamic linker chooses the library with the greater REVISION number.
8341         </pre>
8342 <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
8343         different results for a.out and ELF (excluding symlinks)
8344         in only one case. An ELF library of the form
8345         <span class="quote">&#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
8346         will have a symlink of
8347         <span class="quote">&#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
8348         on an a.out platform. This is handled
8349         automatically.</p>
8350 <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
8351         directory of the library being built.</p>
8352 <p>In the <code class="filename">PLIST</code>, include only the
8353         <code class="filename">.la</code> file, the other files will be
8354         added automatically.</p>
8355 </li>
8356 <li class="listitem">
8357 <p>When linking shared object (<code class="filename">.so</code>)
8358         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
8359         shared libraries, use <span class="quote">&#8220;<span class="quote">-module
8360         -avoid-version</span>&#8221;</span> to prevent them getting version
8361         tacked on.</p>
8362 <p>The <code class="filename">PLIST</code> file gets the
8363         <code class="filename">foo.so</code> entry.</p>
8364 </li>
8365 <li class="listitem">
8366 <p>When linking programs that depend on these libraries
8367         <span class="emphasis"><em>before</em></span> they are installed, preface
8368         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 <span class="quote">&#8220;<span class="quote">${LIBTOOL}
8369         --mode=link</span>&#8221;</span>, and it will find the correct
8370         libraries (static or shared), but please be aware that
8371         libtool will not allow you to specify a relative path in
8372         -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
8373         expects you to change that argument to be the
8374         <code class="filename">.la</code> file. e.g.</p>
8375 <pre class="programlisting">
8376 ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8377         </pre>
8378 <p>should be changed to:</p>
8379 <pre class="programlisting">
8380 ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8381         </pre>
8382 <p>and it will do the right thing with the libraries.</p>
8383 </li>
8384 <li class="listitem">
8385 <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>
8386         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 <span class="quote">&#8220;<span class="quote">${LIBTOOL}
8387         --mode=install</span>&#8221;</span>, and change the library name to
8388         <code class="filename">.la</code>. e.g.</p>
8389 <pre class="programlisting">
8390 ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
8391         </pre>
8392 <p>This will install the static <code class="filename">.a</code>,
8393         shared library, any needed symlinks, and run
8394         <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>
8395 </li>
8396 <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
8397         the <code class="filename">.la</code>
8398         file (this is a change from previous behaviour).</p></li>
8399 </ol></div>
8400 </div>
8401 <div class="sect2" title="19.3.2. Using libtool on GNU packages that already support libtool">
8402 <div class="titlepage"><div><div><h3 class="title">
8403 <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
8404 <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8405     package Makefile. This will override the package's own libtool
8406     in most cases.  For older libtool using packages,  libtool is
8407     made by ltconfig script during the do-configure step; you can
8408     check the libtool script location by doing <span class="command"><strong>make
8409     configure; find work*/ -name libtool</strong></span>.</p>
8410 <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8411     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
8412     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
8413     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
8414     package's libtool script(s), set it as appropriate.</p>
8415 <p>If you do not need <code class="filename">*.a</code> static
8416     libraries built and installed, then use
8417     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8418 <p>If your package makes use of the platform-independent library
8419     for loading dynamic shared objects, that comes with libtool
8420     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8421 <p>Some packages use libtool incorrectly so that the package
8422     may not work or build in some circumstances. Some of the more
8423     common errors are:</p>
8424 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8425 <li class="listitem">
8426 <p>The inclusion of a shared object (-module) as a dependent library in an
8427         executable or library. This in itself isn't a problem if one of two things
8428         has been done:</p>
8429 <div class="orderedlist"><ol class="orderedlist" type="1">
8430 <li class="listitem"><p>The shared object is named correctly, i.e.
8431             <code class="filename">libfoo.la</code>, not
8432             <code class="filename">foo.la</code></p></li>
8433 <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
8434 </ol></div>
8435 </li>
8436 <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
8437         The function lt_dlinit() should be called and the macro
8438         <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8439         executables.</p></li>
8440 </ul></div>
8441 </div>
8442 <div class="sect2" title="19.3.3. GNU Autoconf/Automake">
8443 <div class="titlepage"><div><div><h3 class="title">
8444 <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
8445 <p>If a package needs GNU autoconf or automake to be executed
8446     to regenerate the configure script and Makefile.in makefile
8447     templates, then they should be executed in a pre-configure
8448     target.</p>
8449 <p>For packages that need only autoconf:</p>
8450 <pre class="programlisting">
8451 AUTOCONF_REQD=  2.50            # if default version is not good enough
8452 USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
8453 ...
8454
8455 pre-configure:
8456         cd ${WRKSRC} &amp;&amp; autoconf
8457
8458 ...
8459     </pre>
8460 <p>and for packages that need automake and autoconf:</p>
8461 <pre class="programlisting">
8462 AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
8463 USE_TOOLS+=     automake        # use "automake14" for automake-1.4
8464 ...
8465
8466 pre-configure:
8467         set -e; cd ${WRKSRC}; \
8468         aclocal; autoheader; automake -a --foreign -i; autoconf
8469
8470 ...
8471     </pre>
8472 <p>Packages which use GNU Automake will almost certainly
8473     require GNU Make.</p>
8474 <p>There are times when the configure process makes
8475     additional changes to the generated files, which then causes
8476     the build process to try to re-execute the automake sequence.
8477     This is prevented by touching various files in the configure
8478     stage. If this causes problems with your package you can set
8479     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8480     Makefile.</p>
8481 </div>
8482 </div>
8483 <div class="sect1" title="19.4. Programming languages">
8484 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8485 <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
8486 <div class="sect2" title="19.4.1. C, C++, and Fortran">
8487 <div class="titlepage"><div><div><h3 class="title">
8488 <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
8489 <p>Compilers for the C, C++, and Fortran languages comes with
8490     the NetBSD base system.  By default, pkgsrc assumes that a package
8491     is written in C and will hide all other compilers (via the wrapper
8492     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
8493 <p>To declare which language's compiler a package needs, set
8494     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8495     currently are <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">c++</span>&#8221;</span>, and
8496     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
8497     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
8498     written in C++, usually need a C compiler for the configure
8499     phase.</p>
8500 </div>
8501 <div class="sect2" title="19.4.2. Java">
8502 <div class="titlepage"><div><div><h3 class="title">
8503 <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
8504 <p>If a program is written in Java, use the Java framework in
8505     pkgsrc.  The package must include
8506     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
8507     provides the following variables:</p>
8508 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8509 <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
8510       dependency on the JDK is added.  If
8511       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
8512       there is only a runtime dependency on the JDK.  The default is
8513       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
8514       JDK.</p></li>
8515 <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
8516       a package needs a Java2 implementation.  The supported values
8517       are <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span>, and
8518       <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span>.  <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> accepts any Java2
8519       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
8520       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
8521       above. This variable is not set by default.</p></li>
8522 <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8523       automatically set to the runtime location of the used Java
8524       implementation dependency. It may be used to set
8525       <code class="varname">JAVA_HOME</code> to a good value if the program
8526       needs this variable to be defined.
8527       </p></li>
8528 </ul></div>
8529 </div>
8530 <div class="sect2" title="19.4.3. Packages containing perl scripts">
8531 <div class="titlepage"><div><div><h3 class="title">
8532 <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
8533 <p>If your package contains interpreted perl scripts, add
8534     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
8535     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8536     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8537     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8538     that you want adjusted.  Every occurrence of
8539     <code class="filename">*/bin/perl</code> will be replaced with the full
8540     path to the perl executable.</p>
8541 <p>If a particular version of perl is needed, set the
8542     <code class="varname">PERL5_REQD</code> variable to the version number.  The
8543     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
8544 <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
8545     about handling perl modules.</p>
8546 </div>
8547 <div class="sect2" title="19.4.4. Other programming languages">
8548 <div class="titlepage"><div><div><h3 class="title">
8549 <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
8550 <p>Currently, there is no special handling for other languages
8551     in pkgsrc.  If a compiler package provides a
8552     <code class="filename">buildlink3.mk</code> file, include that, otherwise
8553     just add a (build) dependency on the appropriate compiler
8554     package.</p>
8555 </div>
8556 </div>
8557 <div class="sect1" title="19.5. Fixing problems in the build phase">
8558 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8559 <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
8560 <p>The most common failures when building a package are that
8561         some platforms do not provide certain header files, functions or
8562         libraries, or they provide the functions in a library that the
8563         original package author didn't know. To work around this, you
8564         can rewrite the source code in most cases so that it does not
8565         use the missing functions or provides a replacement function.</p>
8566 <div class="sect2" title="19.5.1. Compiling C and C++ code conditionally">
8567 <div class="titlepage"><div><div><h3 class="title">
8568 <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
8569 <p>If a package already comes with a GNU configure script, the
8570         preferred way to fix the build failure is to change the
8571         configure script, not the code. In the other cases, you can
8572         utilize the C preprocessor, which defines certain macros
8573         depending on the operating system and hardware architecture it
8574         compiles for. These macros can be queried using for example
8575         <code class="varname">#if defined(__i386)</code>. Almost every operating
8576         system, hardware architecture and compiler has its own macro.
8577         For example, if the macros <code class="varname">__GNUC__</code>,
8578         <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8579         are all defined, you know that you are using NetBSD on an i386
8580         compatible CPU, and your compiler is GCC.</p>
8581 <p>The list of the following macros for hardware and
8582         operating system depends on the compiler that is used. For
8583         example, if you want to conditionally compile code on Solaris,
8584         don't use <code class="varname">__sun__</code>, as the SunPro compiler
8585         does not define it. Use <code class="varname">__sun</code> instead.</p>
8586 <div class="sect3" title="19.5.1.1. C preprocessor macros to identify the operating system">
8587 <div class="titlepage"><div><div><h4 class="title">
8588 <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
8589 <p>To distinguish between 4.4 BSD-derived systems and the
8590         rest of the world, you should use the following code.</p>
8591 <pre class="programlisting">
8592 #include &lt;sys/param.h&gt;
8593 #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
8594 /* BSD-specific code goes here */
8595 #else
8596 /* non-BSD-specific code goes here */
8597 #endif
8598 </pre>
8599 <p>If this distinction is not fine enough, you can also test
8600         for the following macros.</p>
8601 <pre class="programlisting">
8602 FreeBSD     __FreeBSD__
8603 DragonFly   __DragonFly__
8604 Interix     __INTERIX
8605 IRIX        __sgi (TODO: get a definite source for this)
8606 Linux       linux, __linux, __linux__
8607 NetBSD      __NetBSD__
8608 OpenBSD     __OpenBSD__
8609 Solaris     sun, __sun
8610 </pre>
8611 </div>
8612 <div class="sect3" title="19.5.1.2. C preprocessor macros to identify the hardware architecture">
8613 <div class="titlepage"><div><div><h4 class="title">
8614 <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
8615 <pre class="programlisting">
8616 i386        i386, __i386, __i386__
8617 MIPS        __mips
8618 SPARC       sparc, __sparc
8619 </pre>
8620 </div>
8621 <div class="sect3" title="19.5.1.3. C preprocessor macros to identify the compiler">
8622 <div class="titlepage"><div><div><h4 class="title">
8623 <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
8624 <pre class="programlisting">
8625 GCC         __GNUC__ (major version), __GNUC_MINOR__
8626 MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8627 SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
8628 SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
8629 </pre>
8630 </div>
8631 </div>
8632 <div class="sect2" title="19.5.2. How to handle compiler bugs">
8633 <div class="titlepage"><div><div><h3 class="title">
8634 <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
8635 <p>Some source files trigger bugs in the compiler, based on
8636         combinations of compiler version and architecture and almost
8637         always relation to optimisation being enabled.  Common symptoms
8638         are gcc internal errors or never finishing compiling a
8639         file.</p>
8640 <p>Typically, a workaround involves testing the
8641         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8642         optimisation for that combination of file,
8643         <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8644         in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8645         number of examples.</p>
8646 </div>
8647 <div class="sect2" title="19.5.3. Undefined reference to &#8220;...&#8221;">
8648 <div class="titlepage"><div><div><h3 class="title">
8649 <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
8650 </h3></div></div></div>
8651 <p>This error message often means that a package did not
8652         link to a shared library it needs. The following functions are
8653         known to cause this error message over and over.</p>
8654 <div class="informaltable">
8655 <a name="undefined-reference-functions"></a><table border="1">
8656 <colgroup>
8657 <col>
8658 <col>
8659 <col>
8660 </colgroup>
8661 <thead><tr>
8662 <th>Function</th>
8663 <th>Library</th>
8664 <th>Affected platforms</th>
8665 </tr></thead>
8666 <tbody>
8667 <tr>
8668 <td>accept, bind, connect</td>
8669 <td>-lsocket</td>
8670 <td>Solaris</td>
8671 </tr>
8672 <tr>
8673 <td>crypt</td>
8674 <td>-lcrypt</td>
8675 <td>DragonFly, NetBSD</td>
8676 </tr>
8677 <tr>
8678 <td>dlopen, dlsym</td>
8679 <td>-ldl</td>
8680 <td>Linux</td>
8681 </tr>
8682 <tr>
8683 <td>gethost*</td>
8684 <td>-lnsl</td>
8685 <td>Solaris</td>
8686 </tr>
8687 <tr>
8688 <td>inet_aton</td>
8689 <td>-lresolv</td>
8690 <td>Solaris</td>
8691 </tr>
8692 <tr>
8693 <td>nanosleep, sem_*, timer_*</td>
8694 <td>-lrt</td>
8695 <td>Solaris</td>
8696 </tr>
8697 <tr>
8698 <td>openpty</td>
8699 <td>-lutil</td>
8700 <td>Linux</td>
8701 </tr>
8702 </tbody>
8703 </table>
8704 </div>
8705 <p>To fix these linker errors, it is often sufficient to say
8706     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8707     -l<em class="replaceable"><code>foo</code></em></code> to the package
8708     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
8709     bmake</strong></span>.</p>
8710 <div class="sect3" title="19.5.3.1. Special issue: The SunPro compiler">
8711 <div class="titlepage"><div><div><h4 class="title">
8712 <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
8713 <p>When you are using the SunPro compiler, there is another
8714 possibility. That compiler cannot handle the following code:</p>
8715 <pre class="programlisting">
8716 extern int extern_func(int);
8717
8718 static inline int
8719 inline_func(int x)
8720 {
8721         return extern_func(x);
8722 }
8723
8724 int main(void)
8725 {
8726         return 0;
8727 }
8728 </pre>
8729 <p>It generates the code for <code class="function">inline_func</code> even if
8730 that function is never used. This code then refers to
8731 <code class="function">extern_func</code>, which can usually not be resolved. To
8732 solve this problem you can try to tell the package to disable inlining
8733 of functions.</p>
8734 </div>
8735 </div>
8736 <div class="sect2" title="19.5.4. Running out of memory">
8737 <div class="titlepage"><div><div><h3 class="title">
8738 <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
8739 <p>Sometimes packages fail to build because the compiler runs
8740     into an operating system specific soft limit.  With the
8741     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8742     to unlimit the resources.  Currently, the allowed values are
8743     <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span> (or both).
8744     Setting this variable is similar to running the shell builtin
8745     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
8746     segment size or maximum stack size of a process, respectively, to
8747     their hard limits.</p>
8748 </div>
8749 </div>
8750 <div class="sect1" title="19.6. Fixing problems in the install phase">
8751 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8752 <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
8753 <div class="sect2" title="19.6.1. Creating needed directories">
8754 <div class="titlepage"><div><div><h3 class="title">
8755 <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
8756 <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
8757     with some operating systems cannot create more than one
8758     directory at a time. As such, you should call
8759     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8760 <pre class="programlisting">
8761 ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8762 ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8763     </pre>
8764 <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
8765     dir2</code></span>&#8221;</span> to the
8766     <code class="varname">INSTALLATION_DIRS</code> variable, which will
8767     automatically do the right thing.</p>
8768 </div>
8769 <div class="sect2" title="19.6.2. Where to install documentation">
8770 <div class="titlepage"><div><div><h3 class="title">
8771 <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
8772 <p>In general, documentation should be installed into
8773     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8774     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8775     includes the version number of the package).</p>
8776 <p>Many modern packages using GNU autoconf allow to set the
8777     directory where HTML documentation is installed with the
8778     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
8779     is needed because otherwise the documentation ends up in
8780     <code class="filename">${PREFIX}/share/doc/html</code> or other
8781     places.</p>
8782 <p>An exception to the above is that library API documentation
8783     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
8784     browsers (devhelp) should be left at their default location, which
8785     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
8786     documentation can be recognized from files ending in
8787     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8788     (It is also acceptable to install such files in
8789     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8790     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8791     <code class="filename">.devhelp*</code> file must be directly in that
8792     directory then, no additional subdirectory level is allowed in
8793     this case. This is usually achieved by using
8794     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
8795     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8796     though.)</p>
8797 </div>
8798 <div class="sect2" title="19.6.3. Installing highscore files">
8799 <div class="titlepage"><div><div><h3 class="title">
8800 <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
8801 <p>Certain packages, most of them in the games category, install
8802     a score file that allows all users on the system to record their
8803     highscores.  In order for this to work, the binaries need to be
8804     installed setgid and the score files owned by the appropriate
8805     group and/or owner (traditionally the "games" user/group).  The
8806     following variables, documented in more detail in
8807     <code class="filename">mk/defaults/mk.conf</code>, control this
8808     behaviour: <code class="varname">SETGIDGAME</code>,
8809     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8810     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
8811 <p>Note that per default, setgid installation of games is
8812     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
8813     the other variables accordingly.</p>
8814 <p>A package should therefore never hard code file ownership or
8815     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8816     <code class="varname">INSTALL_GAME_DATA</code> to set these
8817     correctly.</p>
8818 </div>
8819 <div class="sect2" title="19.6.4. Adding DESTDIR support to packages">
8820 <div class="titlepage"><div><div><h3 class="title">
8821 <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
8822 <p><code class="varname">DESTDIR</code> support means that a package
8823     installs into a staging directory, not the final location of the
8824     files. Then a binary package is created which can be used for
8825     installation as usual. There are two ways: Either the package must
8826     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
8827     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
8828 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8829 <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
8830       set to <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>. If
8831       bsd.prefs.mk is included in the Makefile,
8832       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8833       the inclusion.</p></li>
8834 <li class="listitem"><p>All installation operations have to be prefixed with
8835       <code class="filename">${DESTDIR}</code>.</p></li>
8836 <li class="listitem"><p>automake gets this DESTDIR mostly right
8837       automatically. Many manual rules and pre/post-install often are
8838       incorrect; fix them.</p></li>
8839 <li class="listitem"><p>If files are installed with special owner/group
8840       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
8841 <li class="listitem"><p>In general, packages should support
8842       <code class="varname">UNPRIVILEGED</code> to be able to use
8843       DESTDIR.</p></li>
8844 </ul></div>
8845 </div>
8846 <div class="sect2" title="19.6.5. Packages with hardcoded paths to other interpreters">
8847 <div class="titlepage"><div><div><h3 class="title">
8848 <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
8849 <p>Your package may also contain scripts with hardcoded paths to
8850       other interpreters besides (or as well as) perl.  To correct the
8851       full pathname to the script interpreter, you need to set the
8852       following definitions in your <code class="filename">Makefile</code> (we
8853     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
8854 <pre class="programlisting">
8855 REPLACE_INTERPRETER+=   tcl
8856 REPLACE.tcl.old=        .*/bin/tclsh
8857 REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
8858 REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
8859 # relative to ${WRKSRC}, just as in REPLACE_PERL
8860     </pre>
8861 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
8862 <h3 class="title">Note</h3>
8863 <p>Before March 2006, these variables were called
8864     <code class="varname">_REPLACE.*</code> and
8865     <code class="varname">_REPLACE_FILES.*</code>.</p>
8866 </div>
8867 </div>
8868 <div class="sect2" title="19.6.6. Packages installing perl modules">
8869 <div class="titlepage"><div><div><h3 class="title">
8870 <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
8871 <p>Makefiles of packages providing perl5 modules should include
8872     the Makefile fragment
8873     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
8874     <span class="command"><strong>do-configure</strong></span> target for the standard perl
8875     configuration for such modules as well as various hooks to tune
8876     this configuration.  See comments in this file for
8877     details.</p>
8878 <p>Perl5 modules will install into different places depending
8879     on the version of perl used during the build process.  To
8880     address this, pkgsrc will append lines to the
8881     <code class="filename">PLIST</code> corresponding to the files listed in
8882     the installed <code class="filename">.packlist</code> file generated by
8883     most perl5 modules.  This is invoked by defining
8884     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8885     paths to packlist files, e.g.:</p>
8886 <pre class="programlisting">
8887 PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8888     </pre>
8889 <p>The variables <code class="varname">PERL5_SITELIB</code>,
8890     <code class="varname">PERL5_SITEARCH</code>, and
8891     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8892     in which perl5 modules may be installed, and may be used by
8893     perl5 packages that don't have a packlist.  These three
8894     variables are also substituted for in the
8895     <code class="filename">PLIST</code>.</p>
8896 </div>
8897 <div class="sect2" title="19.6.7. Packages installing info files">
8898 <div class="titlepage"><div><div><h3 class="title">
8899 <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
8900 <p>Some packages install info files or use the
8901     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
8902     commands.  <code class="varname">INFO_FILES</code> should be defined in
8903     the package Makefile so that <code class="filename">INSTALL</code> and
8904     <code class="filename">DEINSTALL</code> scripts will be generated to
8905     handle registration of the info files in the Info directory
8906     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
8907     files registration is either provided by the system, or by a
8908     special purpose package automatically added as dependency if
8909     needed.</p>
8910 <p><code class="varname">PKGINFODIR</code> is the directory under
8911     <code class="filename">${PREFIX}</code> where info files are primarily
8912     located. <code class="varname">PKGINFODIR</code> defaults to
8913     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
8914 <p>The info files for the package should be listed in the
8915     package <code class="filename">PLIST</code>; however any split info files
8916     need not be listed.</p>
8917 <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
8918     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
8919     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8920     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
8921     should be noted with the <code class="varname">TEXINFO_REQD</code>
8922     variable in the package <code class="filename">Makefile</code>. By
8923     default, a minimum version of 3.12 is required. If the system
8924     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
8925     does not match the required minimum, a build dependency on the
8926     <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
8927     be added automatically.</p>
8928 <p>The build and installation process of the software provided
8929     by the package should not use the
8930     <span class="command"><strong>install-info</strong></span> command as the registration of
8931     info files is the task of the package
8932     <code class="filename">INSTALL</code> script, and it must use the
8933     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
8934 <p>To achieve this goal, the pkgsrc infrastructure creates
8935     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8936     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
8937     in <code class="varname">PATH</code>.</p>
8938 <p>The script overriding <span class="command"><strong>install-info</strong></span> has
8939     no effect except the logging of a message. The script overriding
8940     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
8941     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8942     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
8943 </div>
8944 <div class="sect2" title="19.6.8. Packages installing man pages">
8945 <div class="titlepage"><div><div><h3 class="title">
8946 <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
8947 <p>All packages that install manual pages should install them
8948     into the same directory, so that there is one common place to look
8949     for them. In pkgsrc, this place is
8950     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8951     should be used in packages. The default for
8952     <code class="varname">PKGMANDIR</code> is
8953     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
8954     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
8955 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
8956 <h3 class="title">Note</h3>
8957 <p>The support for a custom <code class="varname">PKGMANDIR</code>
8958     is far from complete.</p>
8959 </div>
8960 <p>The <code class="filename">PLIST</code> files can just use
8961     <code class="filename">man/</code> as the top level directory for the man
8962     page file entries, and the pkgsrc framework will convert as
8963     needed. In all other places, the correct
8964     <code class="varname">PKGMANDIR</code> must be used.</p>
8965 <p>Packages that are
8966     configured with <code class="varname">GNU_CONFIGURE</code> set as
8967     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
8968     <code class="filename">./configure</code>
8969     --mandir switch to set where the man pages should be installed.
8970     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8971     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8972 <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8973     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8974     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
8975     Or if the <code class="filename">./configure</code> script uses
8976     a non-standard use of --mandir, you can set
8977     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
8978 <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
8979     information on installation of compressed manual pages.</p>
8980 </div>
8981 <div class="sect2" title="19.6.9. Packages installing GConf data files">
8982 <div class="titlepage"><div><div><h3 class="title">
8983 <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
8984 <p>If a package installs <code class="filename">.schemas</code> or
8985     <code class="filename">.entries</code> files, used by GConf,
8986     you need to take some extra steps to make sure they get registered
8987     in the database:</p>
8988 <div class="orderedlist"><ol class="orderedlist" type="1">
8989 <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
8990         instead of its <code class="filename">buildlink3.mk</code> file.  This
8991         takes care of rebuilding the GConf database at installation and
8992         deinstallation time, and tells the package where to install
8993         GConf data files using some standard configure arguments.  It
8994         also disallows any access to the database directly from the
8995         package.</p></li>
8996 <li class="listitem"><p>Ensure that the package installs its
8997         <code class="filename">.schemas</code> files under
8998         <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
8999         installed under <code class="filename">${PREFIX}/etc</code>, you will
9000         need to manually patch the package.</p></li>
9001 <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
9002         directory, as they will be handled automatically.  See
9003         <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>
9004 <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
9005         your <code class="filename">Makefile</code> with a list of all
9006         <code class="filename">.schemas</code> files installed by the package, if
9007         any.  Names must not contain any directories in them.</p></li>
9008 <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
9009         your <code class="filename">Makefile</code> with a
9010         list of all <code class="filename">.entries</code> files installed by the
9011         package, if any. Names must not contain any directories in
9012         them.</p></li>
9013 </ol></div>
9014 </div>
9015 <div class="sect2" title="19.6.10. Packages installing scrollkeeper/rarian data files">
9016 <div class="titlepage"><div><div><h3 class="title">
9017 <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
9018 <p>If a package installs <code class="filename">.omf</code> files, used by
9019     scrollkeeper/rarian, you need to take some extra steps to make sure they
9020     get registered in the database:</p>
9021 <div class="orderedlist"><ol class="orderedlist" type="1">
9022 <li class="listitem"><p>Include
9023         <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9024         instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
9025         takes care of rebuilding the scrollkeeper database at
9026         installation and deinstallation time, and disallows any access
9027         to it directly from the package.</p></li>
9028 <li class="listitem"><p>Check the PLIST and remove any entries under the
9029         <code class="filename">libdata/scrollkeeper</code> directory, as they
9030         will be handled automatically.</p></li>
9031 <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
9032         the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
9033         print-PLIST</strong></span> does this automatically.)</p></li>
9034 </ol></div>
9035 </div>
9036 <div class="sect2" title="19.6.11. Packages installing X11 fonts">
9037 <div class="titlepage"><div><div><h3 class="title">
9038 <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
9039 <p>If a package installs font files, you will need to rebuild
9040     the fonts database in the directory where they get installed at
9041     installation and deinstallation time.  This can be automatically
9042     done by using the pkginstall framework.</p>
9043 <p>You can list the directories where fonts are installed in the
9044     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9045     variables, where <em class="replaceable"><code>type</code></em> can be one of
9046     <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.
9047     Also make sure that the database file
9048     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9049 <p>Note that you should not create new directories for fonts;
9050     instead use the standard ones to avoid that the user needs to
9051     manually configure his X server to find them.</p>
9052 </div>
9053 <div class="sect2" title="19.6.12. Packages installing GTK2 modules">
9054 <div class="titlepage"><div><div><h3 class="title">
9055 <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
9056 <p>If a package installs GTK2 immodules or loaders, you need to
9057     take some extra steps to get them registered in the GTK2 database
9058     properly:</p>
9059 <div class="orderedlist"><ol class="orderedlist" type="1">
9060 <li class="listitem"><p>Include
9061       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9062       <code class="filename">buildlink3.mk</code> file.  This takes care of
9063       rebuilding the database at installation and deinstallation time.</p></li>
9064 <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9065       your package installs GTK2 immodules.</p></li>
9066 <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9067       GTK2 loaders.</p></li>
9068 <li class="listitem">
9069 <p>Patch the package to not touch any of the GTK2
9070       databases directly.  These are:</p>
9071 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9072 <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9073 <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
9074 </ul></div>
9075 </li>
9076 <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
9077       any entries under the <code class="filename">libdata/gtk-2.0</code>
9078       directory, as they will be handled automatically.</p></li>
9079 </ol></div>
9080 </div>
9081 <div class="sect2" title="19.6.13. Packages installing SGML or XML data">
9082 <div class="titlepage"><div><div><h3 class="title">
9083 <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
9084 <p>If a package installs SGML or XML data files that need to be
9085     registered in system-wide catalogs (like DTDs, sub-catalogs,
9086     etc.), you need to take some extra steps:</p>
9087 <div class="orderedlist"><ol class="orderedlist" type="1">
9088 <li class="listitem"><p>Include
9089         <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9090         your <code class="filename">Makefile</code>, which takes care of
9091         registering those files in system-wide catalogs at
9092         installation and deinstallation time.</p></li>
9093 <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
9094         any SGML catalogs installed by the package.</p></li>
9095 <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
9096         any XML catalogs installed by the package.</p></li>
9097 <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
9098         to be added to the SGML catalog.  These come in groups of
9099         three strings; see xmlcatmgr(1) for more information
9100         (specifically, arguments recognized by the 'add' action).
9101         Note that you will normally not use this variable.</p></li>
9102 <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
9103         to be added to the XML catalog.  These come in groups of three
9104         strings; see xmlcatmgr(1) for more information (specifically,
9105         arguments recognized by the 'add' action).  Note that you will
9106         normally not use this variable.</p></li>
9107 </ol></div>
9108 </div>
9109 <div class="sect2" title="19.6.14. Packages installing extensions to the MIME database">
9110 <div class="titlepage"><div><div><h3 class="title">
9111 <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
9112 <p>If a package provides extensions to the MIME database by
9113     installing <code class="filename">.xml</code> files inside
9114     <code class="filename">${PREFIX}/share/mime/packages</code>, you
9115     need to take some extra steps to ensure that the database is kept
9116     consistent with respect to these new files:</p>
9117 <div class="orderedlist"><ol class="orderedlist" type="1">
9118 <li class="listitem"><p>Include
9119         <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9120         (avoid using the <code class="filename">buildlink3.mk</code> file from
9121         this same directory, which is reserved for inclusion from
9122         other <code class="filename">buildlink3.mk</code> files).  It takes
9123         care of rebuilding the MIME database at installation and
9124         deinstallation time, and disallows any access to it directly
9125         from the package.</p></li>
9126 <li class="listitem"><p>Check the PLIST and remove any entries under the
9127         <code class="filename">share/mime</code> directory,
9128         <span class="emphasis"><em>except</em></span> for files saved under
9129         <code class="filename">share/mime/packages</code>.  The former are
9130         handled automatically by
9131         the update-mime-database program, but the latter are
9132         package-dependent and must be removed by the package that
9133         installed them in the first place.</p></li>
9134 <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
9135         from the PLIST.  They will be handled by the shared-mime-info
9136         package.</p></li>
9137 </ol></div>
9138 </div>
9139 <div class="sect2" title="19.6.15. Packages using intltool">
9140 <div class="titlepage"><div><div><h3 class="title">
9141 <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
9142 <p>If a package uses intltool during its build, add
9143     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9144     which forces it to use the intltool package provided by pkgsrc,
9145     instead of the one bundled with the distribution file.</p>
9146 <p>This tracks intltool's build-time dependencies and uses the
9147     latest available version; this way, the package benefits of any
9148     bug fixes that may have appeared since it was released.</p>
9149 </div>
9150 <div class="sect2" title="19.6.16. Packages installing startup scripts">
9151 <div class="titlepage"><div><div><h3 class="title">
9152 <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
9153 <p>If a package contains a rc.d script, it won't be copied into
9154     the startup directory by default, but you can enable it, by adding
9155     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
9156     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
9157     into <code class="filename">/etc/rc.d</code> when a package is installed, and
9158     it will automatically remove the scripts when the package is
9159     deinstalled.</p>
9160 </div>
9161 <div class="sect2" title="19.6.17. Packages installing TeX modules">
9162 <div class="titlepage"><div><div><h3 class="title">
9163 <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
9164 <p>If a package installs TeX packages into the texmf tree,
9165     the <code class="filename">ls-R</code> database of the tree needs to be
9166     updated.</p>
9167 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
9168 <h3 class="title">Note</h3>
9169 <p>Except the main TeX packages such as kpathsea,
9170     packages should install files
9171     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9172     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
9173 </div>
9174 <div class="orderedlist"><ol class="orderedlist" type="1">
9175 <li class="listitem"><p>Include
9176       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
9177       takes care of rebuilding the <code class="filename">ls-R</code>
9178       database at installation and deinstallation time.</p></li>
9179 <li class="listitem">
9180 <p>If your package installs files into a texmf
9181       tree other than the one
9182       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9183       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
9184       trees that need database update.</p>
9185 <p>If your package also installs font map files that need
9186       to be registered using <span class="command"><strong>updmap</strong></span>,
9187       include <code class="filename">../../print/texlive-tetex/map.mk</code> and
9188       set <code class="varname">TEX_MAP_FILES</code> and/or
9189       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
9190       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
9191       be run automatically at installation/deinstallation to
9192       enable/disable font map files for TeX output
9193       drivers.</p>
9194 </li>
9195 <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
9196       databases are included in <code class="filename">PLIST</code>, as
9197       they will be removed only by the teTeX-bin package.</p></li>
9198 </ol></div>
9199 </div>
9200 <div class="sect2" title="19.6.18. Packages supporting running binaries in emulation">
9201 <div class="titlepage"><div><div><h3 class="title">
9202 <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
9203     emulation</h3></div></div></div>
9204 <p>There are some packages that provide libraries and
9205     executables for running binaries from a one operating system
9206     on a different one (if the latter supports it).  One example
9207     is running Linux binaries on NetBSD.</p>
9208 <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>
9209     helps in extracting and packaging Linux rpm packages.</p>
9210 <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
9211     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
9212     if all libraries for each installed executable can be found by
9213     the dynamic linker.  Since the standard dynamic linker is run,
9214     this fails for emulation packages, because the libraries used
9215     by the emulation are not in the standard directories.</p>
9216 </div>
9217 <div class="sect2" title="19.6.19. Packages installing hicolor theme icons">
9218 <div class="titlepage"><div><div><h3 class="title">
9219 <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
9220 <p>If a package installs images under the
9221     <code class="filename">share/icons/hicolor</code> and/or updates the
9222     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9223     database, you need to take some extra steps to make sure that the
9224     shared theme directory is handled appropriately and that the cache
9225     database is rebuilt:</p>
9226 <div class="orderedlist"><ol class="orderedlist" type="1">
9227 <li class="listitem"><p>Include
9228         <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9229 <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9230         entry that refers to the theme cache.</p></li>
9231 <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9232           directories from the <code class="filename">share/icons/hicolor</code>
9233           hierarchy because they will be handled automatically.</p></li>
9234 </ol></div>
9235 <p>The best way to verify that the PLIST is correct with
9236       respect to the last two points is to regenerate it using
9237       <span class="command"><strong>make print-PLIST</strong></span>.</p>
9238 </div>
9239 <div class="sect2" title="19.6.20. Packages installing desktop files">
9240 <div class="titlepage"><div><div><h3 class="title">
9241 <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
9242 <p>If a package installs <code class="filename">.desktop</code> files
9243       under <code class="filename">share/applications</code> and these include
9244       MIME information, you need to take extra steps to ensure that they
9245       are registered into the MIME database:</p>
9246 <div class="orderedlist"><ol class="orderedlist" type="1">
9247 <li class="listitem"><p>Include
9248           <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9249 <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9250           <code class="filename">share/applications/mimeinfo.cache</code> file.
9251           It will be handled automatically.</p></li>
9252 </ol></div>
9253 <p>The best way to verify that the PLIST is correct with
9254       respect to the last point is to regenerate it using <span class="command"><strong>make
9255       print-PLIST</strong></span>.</p>
9256 </div>
9257 </div>
9258 <div class="sect1" title="19.7. Marking packages as having problems">
9259 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9260 <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
9261 <p>In some cases one does not have the time to solve a problem
9262   immediately. In this case, one can plainly mark a package as broken.  For
9263   this, one just sets the variable <code class="varname">BROKEN</code> to the
9264   reason why the package is broken (similar to the
9265   <code class="varname">RESTRICTED</code> variable).  A user trying to build
9266   the package will immediately be shown this message, and the build
9267   will not be even tried.</p>
9268 <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9269   intervals.</p>
9270 </div>
9271 </div>
9272 <div class="chapter" title="Chapter 20. Debugging">
9273 <div class="titlepage"><div><div><h2 class="title">
9274 <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
9275 <p>To check out all the gotchas when building a package, here are
9276   the steps that I do in order to get a package working.  Please note
9277   this is basically the same as what was explained in the previous
9278   sections, only with some debugging aids.</p>
9279 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9280 <li class="listitem"><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
9281 <li class="listitem">
9282 <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>,
9283       create a directory for a new package, change into it, then run
9284       <span class="command"><strong>url2pkg</strong></span>:</p>
9285 <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>
9286 <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>
9287 <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9288 </li>
9289 <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9290 <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9291 <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9292 <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
9293       configure step to the package's
9294       <code class="filename">Makefile</code>.</p></li>
9295 <li class="listitem">
9296 <p>Make the package compile, doing multiple rounds of</p>
9297 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9298 <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9299 <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9300 <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9301 <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9302 <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9303 <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9304 <p>Doing this step as non-root user will ensure that no files
9305       are modified that shouldn't be, especially during the build
9306       phase.  <span class="command"><strong>mkpatches</strong></span>,
9307       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
9308       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>
9309       package.</p>
9310 </li>
9311 <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9312       necessary; see <a class="xref" href="#components.Makefile" title="11.1. Makefile">Section 11.1, &#8220;<code class="filename">Makefile</code>&#8221;</a>.</p></li>
9313 <li class="listitem">
9314 <p>Generate a <code class="filename">PLIST</code>:</p>
9315 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9316 <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
9317 <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9318 <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9319 <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9320 <p>You usually need to be <code class="username">root</code> to do
9321       this.  Look if there are any files left:</p>
9322 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9323 <p>If this reveals any files that are missing in
9324       <code class="filename">PLIST</code>, add them.</p>
9325 </li>
9326 <li class="listitem">
9327 <p>Now that the <code class="filename">PLIST</code> is OK, install the
9328       package again and make a binary package:</p>
9329 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9330 <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9331 </li>
9332 <li class="listitem">
9333 <p>Delete the installed package:</p>
9334 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9335 </li>
9336 <li class="listitem">
9337 <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
9338       command, which shouldn't find anything now:</p>
9339 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9340 </li>
9341 <li class="listitem">
9342 <p>Reinstall the binary package:</p>
9343 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9344 </li>
9345 <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
9346 <li class="listitem">
9347 <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
9348       reports:</p>
9349 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9350 </li>
9351 <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a>.</p></li>
9352 </ul></div>
9353 </div>
9354 <div class="chapter" title="Chapter 21. Submitting and Committing">
9355 <div class="titlepage"><div><div><h2 class="title">
9356 <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
9357 <div class="toc">
9358 <p><b>Table of Contents</b></p>
9359 <dl>
9360 <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9361 <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9362 <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9363 <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9364 <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
9365 <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9366 <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
9367 </dl>
9368 </div>
9369 <div class="sect1" title="21.1. Submitting binary packages">
9370 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9371 <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
9372 <p>Our policy is that we accept binaries only from pkgsrc
9373         developers to guarantee that the packages don't contain any
9374         trojan horses etc. This is not to annoy anyone but rather to
9375         protect our users! You're still free to put up your home-made
9376         binary packages and tell the world where to get them. NetBSD
9377         developers doing bulk builds and wanting to upload them please
9378         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>
9379 </div>
9380 <div class="sect1" title="21.2. Submitting source packages (for non-NetBSD-developers)">
9381 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9382 <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
9383 <p>First, check that your package is complete, compiles and
9384         runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
9385         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>
9386         archive that contains all files that make up the package.
9387         Finally, send this package to the pkgsrc bug tracking system,
9388         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
9389         that, go to the web page
9390         <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
9391         which contains some instructions and a link to a form where you
9392         can submit packages.  The
9393         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
9394         also available as a substitute for either of the above two tools.
9395         </p>
9396 <p>In the form of the problem report, the category should be
9397         <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
9398         and version number, and the description field should contain a
9399         short description of your package (contents of the COMMENT
9400         variable or DESCR file are OK). The uuencoded package data should
9401         go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
9402 <p>If you want to submit several packages, please send a
9403         separate PR for each one, it's easier for us to track things
9404         that way.</p>
9405 <p>Alternatively, you can also import new packages into
9406         pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
9407         homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9408         for details.</p>
9409 </div>
9410 <div class="sect1" title="21.3. General notes when adding, updating, or removing packages">
9411 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9412 <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
9413 <p>Please note all package additions, updates, moves, and
9414         removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9415         important to keep this file up to date and conforming to the
9416         existing format, because it will be used by scripts to
9417         automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9418         sites. Additionally, check the
9419         <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9420         for the package you updated or removed, in case it was mentioned
9421         there.</p>
9422 <p>When the <code class="varname">PKGREVISION</code> of a package is
9423         bumped, the change should appear in
9424         <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9425         related or otherwise relevant. Mass bumps that result from a
9426         dependency being updated should not be mentioned. In all other
9427         cases it's the developer's decision.</p>
9428 <p>There is a make target that helps in creating proper
9429   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
9430   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9431   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9432   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9433   file is up-to-date (to avoid having to resolve conflicts later-on)
9434   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
9435   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
9436   For new packages, or package moves or removals, set the
9437   <code class="varname">CTYPE</code> variable on the command line to "Added",
9438   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
9439   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
9440   not the same as your NetBSD login name. The target also automatically
9441   removes possibly existing entries for the package in the
9442   <code class="filename">TODO</code> file. Don't forget to commit
9443   the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
9444   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9445   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9446   makes the cvs commands use the main repository.
9447   </p>
9448 </div>
9449 <div class="sect1" title="21.4. Committing: Importing a package into CVS">
9450 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9451 <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
9452 <p>This section is only of interest for pkgsrc developers with write
9453   access to the pkgsrc repository. Please remember that cvs
9454   imports files relative to the current working directory, and that
9455   the pathname that you
9456   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
9457   to place the files in the repository.  Newly created packages should be
9458   imported with a vendor tag of <span class="quote">&#8220;<span class="quote">TNF</span>&#8221;</span> and a release tag of
9459   <span class="quote">&#8220;<span class="quote">pkgsrc-base</span>&#8221;</span>, e.g:</p>
9460 <pre class="programlisting">
9461 <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9462 <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9463 </pre>
9464 <p>Remember to move the directory from which you imported out of
9465   the way, or cvs will complain the next time you <span class="quote">&#8220;<span class="quote">cvs
9466   update</span>&#8221;</span> your source tree.  Also don't forget to add the new
9467   package to the category's <code class="filename">Makefile</code>.</p>
9468 <p>The commit message of the initial import should include part of the
9469   <code class="filename">DESCR</code> file, so people reading the mailing lists know
9470   what the package is/does.</p>
9471 <p>For new packages, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> is preferred to <span class="quote">&#8220;<span class="quote">cvs
9472   add</span>&#8221;</span> because the former gets everything with a single command,
9473   and provides a consistent tag.</p>
9474 </div>
9475 <div class="sect1" title="21.5. Updating a package to a newer version">
9476 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9477 <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
9478 <p>Please always put a concise, appropriate and relevant summary of the
9479   changes between old and new versions into the commit log when updating
9480   a package. There are various reasons for this:</p>
9481 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9482 <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
9483   or its information may be overwritten by newer information.</p></li>
9484 <li class="listitem"><p>Having the change information between old and new versions in our CVS
9485   repository is very useful for people who use either cvs or anoncvs.</p></li>
9486 <li class="listitem"><p>Having the change information between old and new versions in our CVS
9487   repository is very useful for people who read the pkgsrc-changes mailing
9488   list, so that they can make tactical decisions about when to upgrade
9489   the package.</p></li>
9490 </ul></div>
9491 <p>Please also recognize that, just because a new version of a package
9492   has been released, it should not automatically be upgraded in the CVS
9493   repository.  We prefer to be conservative in the packages that are
9494   included in pkgsrc - development or beta packages are not really the
9495   best thing for most places in which pkgsrc is used. Please use your
9496   judgement about what should go into pkgsrc, and bear in mind that
9497   stability is to be preferred above new and possibly untested features.</p>
9498 </div>
9499 <div class="sect1" title="21.6. Renaming a package in pkgsrc">
9500 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9501 <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9502 <p>Renaming packages is not recommended.</p>
9503 <p>When renaming packages, be sure to fix any references to old name
9504   in other Makefiles, options, buildlink files, etc.</p>
9505 <p>Also When renaming a package, please define
9506   <code class="varname">SUPERSEDES</code> to the package name and dewey version
9507   pattern(s) of the previous package name.
9508   This may be repeated for multiple renames.
9509   The new package would be an exact replacement.
9510 </p>
9511 <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
9512   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9513   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9514   not be an exact replacement but is a suggestion for the replaced
9515   functionality.</p>
9516 </div>
9517 <div class="sect1" title="21.7. Moving a package in pkgsrc">
9518 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9519 <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9520 <p>It is preferred that packages are not renamed or moved, but if needed
9521   please follow these steps.
9522 </p>
9523 <div class="orderedlist"><ol class="orderedlist" type="1">
9524 <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9525 <li class="listitem">
9526 <p>Remove all CVS dirs.</p>
9527 <p>Alternatively to the first two steps you can also do:</p>
9528 <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>
9529 <p>and use that for further work.</p>
9530 </li>
9531 <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9532 <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
9533 instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
9534 <li class="listitem"><p>In the modified package's Makefile, consider setting
9535 <code class="varname">PREV_PKGPATH</code> to the previous category/package
9536 pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
9537 for doing an update using pkgsrc building; for example, it can
9538 search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-current"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
9539 (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9540 new <code class="varname">PKGPATH</code> for that moved package.  Note that
9541 it may have multiple matches, so the tool should also check on the
9542 <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
9543 probably has no value unless <code class="varname">SUPERSEDES</code> is not
9544 set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
9545 <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
9546 place.</p></li>
9547 <li class="listitem">
9548 <p>Check if any package depends on it:
9549 </p>
9550 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9551 <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9552 </li>
9553 <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9554 <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9555 <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9556 <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9557 <li class="listitem">
9558 <p>Commit the changed and removed files:</p>
9559 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9560 <p>(and any packages from step 5, of course).</p>
9561 </li>
9562 </ol></div>
9563 </div>
9564 </div>
9565 <div class="chapter" title="Chapter 22. Frequently Asked Questions">
9566 <div class="titlepage"><div><div><h2 class="title">
9567 <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
9568 <p>This section contains the answers to questions that may
9569         arise when you are writing a package. If you don't find your
9570         question answered here, first have a look in the other chapters,
9571         and if you still don't have the answer, ask on the
9572         <code class="literal">pkgsrc-users</code> mailing list.</p>
9573 <div class="qandaset" title="Frequently Asked Questions">
9574 <a name="id1168229333677"></a><dl>
9575 <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
9576         MAKEFLAGS, .MAKEFLAGS and
9577         MAKE_FLAGS?</a>
9578 </dt>
9579 <dt>22.2. <a href="#devfaq.make">What is the difference between
9580         MAKE, GMAKE and
9581         MAKE_PROGRAM?</a>
9582 </dt>
9583 <dt>22.3. <a href="#devfaq.cc">What is the difference between
9584         CC, PKG_CC and
9585         PKGSRC_COMPILER?</a>
9586 </dt>
9587 <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
9588         BUILDLINK_LDFLAGS,
9589         BUILDLINK_LDADD and
9590         BUILDLINK_LIBS?</a>
9591 </dt>
9592 <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
9593         VARNAME=BUILDLINK_PREFIX.foo
9594         say it's empty?</a>
9595 </dt>
9596 <dt>22.6. <a href="#devfaq.master_sites">What does
9597         ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9598         don't understand the := inside
9599         it.</a>
9600 </dt>
9601 <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
9602         developers?</a>
9603 </dt>
9604 <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
9605         documentation?</a>
9606 </dt>
9607 <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
9608 do?</a>
9609 </dt>
9610 </dl>
9611 <table border="0" width="100%" summary="Q and A Set">
9612 <col align="left" width="1%">
9613 <col>
9614 <tbody>
9615 <tr class="question" title="22.1.">
9616 <td align="left" valign="top">
9617 <a name="devfaq.makeflags"></a><a name="id1168229333681"></a><p><b>22.1.</b></p>
9618 </td>
9619 <td align="left" valign="top"><p>What is the difference between
9620         <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9621         <code class="varname">MAKE_FLAGS</code>?</p></td>
9622 </tr>
9623 <tr class="answer">
9624 <td align="left" valign="top"></td>
9625 <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9626         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
9627         <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9628         the <code class="varname">MAKE_PROGRAM</code> when building the
9629         package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9630 </tr>
9631 <tr class="question" title="22.2.">
9632 <td align="left" valign="top">
9633 <a name="devfaq.make"></a><a name="id1168229333783"></a><p><b>22.2.</b></p>
9634 </td>
9635 <td align="left" valign="top"><p>What is the difference between
9636         <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9637         <code class="varname">MAKE_PROGRAM</code>?</p></td>
9638 </tr>
9639 <tr class="answer">
9640 <td align="left" valign="top"></td>
9641 <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9642         <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
9643         infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9644         Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9645         use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9646         Make program that is used for building the
9647         package.</p></td>
9648 </tr>
9649 <tr class="question" title="22.3.">
9650 <td align="left" valign="top">
9651 <a name="devfaq.cc"></a><a name="id1168229333819"></a><p><b>22.3.</b></p>
9652 </td>
9653 <td align="left" valign="top"><p>What is the difference between
9654         <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9655         <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9656 </tr>
9657 <tr class="answer">
9658 <td align="left" valign="top"></td>
9659 <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9660         compiler, which can be configured by the pkgsrc user.
9661         <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9662         <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9663         path to a compiler, but the type of compiler that should be
9664         used. See <code class="filename">mk/compiler.mk</code> for more
9665         information about the latter variable.</p></td>
9666 </tr>
9667 <tr class="question" title="22.4.">
9668 <td align="left" valign="top">
9669 <a name="devfaq.bl3flags"></a><a name="id1168229333854"></a><p><b>22.4.</b></p>
9670 </td>
9671 <td align="left" valign="top"><p>What is the difference between
9672         <code class="varname">BUILDLINK_LDFLAGS</code>,
9673         <code class="varname">BUILDLINK_LDADD</code> and
9674         <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9675 </tr>
9676 <tr class="answer">
9677 <td align="left" valign="top"></td>
9678 <td align="left" valign="top"><p>[FIXME]</p></td>
9679 </tr>
9680 <tr class="question" title="22.5.">
9681 <td align="left" valign="top">
9682 <a name="devfaq.bl3prefix"></a><a name="id1168229333873"></a><p><b>22.5.</b></p>
9683 </td>
9684 <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
9685         VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9686         say it's empty?</p></td>
9687 </tr>
9688 <tr class="answer">
9689 <td align="left" valign="top"></td>
9690 <td align="left" valign="top"><p>For optimization reasons, some variables are only
9691         available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
9692         <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
9693         <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
9694         command.</p></td>
9695 </tr>
9696 <tr class="question" title="22.6.">
9697 <td align="left" valign="top">
9698 <a name="devfaq.master_sites"></a><a name="id1168229333898"></a><p><b>22.6.</b></p>
9699 </td>
9700 <td align="left" valign="top"><p>What does
9701         <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9702         don't understand the <code class="literal">:=</code> inside
9703         it.</p></td>
9704 </tr>
9705 <tr class="answer">
9706 <td align="left" valign="top"></td>
9707 <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9708         assignment operator, like you might expect at first sight.
9709         Instead, it is a degenerate form of
9710         <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9711         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
9712         may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9713         case of <code class="varname">MASTER_SITE_*</code>,
9714         <em class="replaceable"><code>old_string</code></em> is the empty string and
9715         <em class="replaceable"><code>new_string</code></em> is
9716         <code class="literal">package/</code>. That's where the
9717         <code class="literal">:</code> and the <code class="literal">=</code> fall
9718         together.</p></td>
9719 </tr>
9720 <tr class="question" title="22.7.">
9721 <td align="left" valign="top">
9722 <a name="devfaq.mailinglists"></a><a name="id1168229333965"></a><p><b>22.7.</b></p>
9723 </td>
9724 <td align="left" valign="top"><p>Which mailing lists are there for package
9725         developers?</p></td>
9726 </tr>
9727 <tr class="answer">
9728 <td align="left" valign="top"></td>
9729 <td align="left" valign="top"><div class="variablelist"><dl>
9730 <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
9731 <dd><p>This is a list for technical discussions related
9732         to pkgsrc development, e.g. soliciting feedback for changes to
9733         pkgsrc infrastructure, proposed new features, questions related
9734         to porting pkgsrc to a new platform, advice for maintaining a
9735         package, patches that affect many packages, help requests moved
9736         from pkgsrc-users when an infrastructure bug is found,
9737         etc.</p></dd>
9738 <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
9739 <dd><p>All bug reports in category "pkg" sent with
9740         <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
9741         directly; use one of the other mailing
9742         lists.</p></dd>
9743 </dl></div></td>
9744 </tr>
9745 <tr class="question" title="22.8.">
9746 <td align="left" valign="top">
9747 <a name="devfaq.documentation"></a><a name="id1168229333997"></a><p><b>22.8.</b></p>
9748 </td>
9749 <td align="left" valign="top"><p>Where is the pkgsrc
9750         documentation?</p></td>
9751 </tr>
9752 <tr class="answer">
9753 <td align="left" valign="top"></td>
9754 <td align="left" valign="top">
9755 <p>There are many places where you can find
9756         documentation about pkgsrc:</p>
9757 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9758 <li class="listitem"><p>The pkgsrc guide (this document) is a collection
9759         of chapters that explain large parts of pkgsrc, but some
9760         chapters tend to be outdated. Which ones they are is hard to
9761         say.</p></li>
9762 <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
9763         about certain features, announcements of new parts of the pkgsrc
9764         infrastructure and sometimes even announcements that a certain
9765         feature has been marked as obsolete. The benefit here is that
9766         each message has a date appended to it.</p></li>
9767 <li class="listitem"><p>Many of the files in the
9768         <code class="filename">mk/</code> directory start with a comment that
9769         describes the purpose of the file and how it can be used by the
9770         pkgsrc user and package authors. An easy way to find this
9771         documentation is to run <span class="command"><strong>bmake
9772         help</strong></span>.</p></li>
9773 <li class="listitem"><p>The CVS log messages are a rich source of
9774         information, but they tend to be highly abbreviated, especially
9775         for actions that occur often. Some contain a detailed
9776         description of what has changed, but they are geared towards the
9777         other pkgsrc developers, not towards an average pkgsrc user.
9778         They also only document <span class="emphasis"><em>changes</em></span>, so if you
9779         don't know what has been before, these messages may not be worth
9780         too much to you.</p></li>
9781 <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
9782         documented</span>&#8221;</span>, that is the documentation exists only in the
9783         mind of the developer who wrote the code. To get this
9784         information, use the <span class="command"><strong>cvs annotate</strong></span> command
9785         to see who has written it and ask on the
9786         <code class="literal">tech-pkg</code> mailing list, so that others can
9787         find your questions later (see above). To be sure that the
9788         developer in charge reads the mail, you may CC him or
9789         her.</p></li>
9790 </ul></div>
9791 </td>
9792 </tr>
9793 <tr class="question" title="22.9.">
9794 <td align="left" valign="top">
9795 <a name="devfaq.too-much-time"></a><a name="id1168229334052"></a><p><b>22.9.</b></p>
9796 </td>
9797 <td align="left" valign="top"><p>I have a little time to kill.  What shall I
9798 do?</p></td>
9799 </tr>
9800 <tr class="answer">
9801 <td align="left" valign="top"></td>
9802 <td align="left" valign="top">
9803 <p>This is not really an FAQ yet, but here's the answer
9804 anyway.</p>
9805 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9806 <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
9807     <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
9808     will tell you about newer versions of installed packages that are
9809     available, but not yet updated in pkgsrc.</p></li>
9810 <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
9811     &mdash; it contains a list of suggested new packages and a list of
9812     cleanups and enhancements for pkgsrc that would be nice to
9813     have.</p></li>
9814 <li class="listitem"><p>Review packages for which review was requested on
9815     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9816     mailing list.</p></li>
9817 </ul></div>
9818 </td>
9819 </tr>
9820 </tbody>
9821 </table>
9822 </div>
9823 </div>
9824 <div class="chapter" title="Chapter 23. GNOME packaging and porting">
9825 <div class="titlepage"><div><div><h2 class="title">
9826 <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
9827 <div class="toc">
9828 <p><b>Table of Contents</b></p>
9829 <dl>
9830 <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9831 <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9832 <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9833 <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
9834 </dl>
9835 </div>
9836 <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
9837 site</a>:</p>
9838 <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9839   environment, an intuitive and attractive desktop for users, and the
9840   GNOME development platform, an extensive framework for building
9841   applications that integrate into the rest of the desktop.</p></blockquote></div>
9842 <p>pkgsrc provides a seamless way to automatically build and install
9843 a complete GNOME environment <span class="emphasis"><em>under many different
9844 platforms</em></span>.  We can say with confidence that pkgsrc is one of
9845 the most advanced build and packaging systems for GNOME due to its
9846 included technologies buildlink3, the wrappers and tools framework and
9847 automatic configuration file management.  Lots of efforts are put into
9848 achieving a completely clean deinstallation of installed software
9849 components.</p>
9850 <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9851 the above also means that great efforts are put into making GNOME work
9852 under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9853 pkgsrc as its preferred packaging system, contributing lots of
9854 portability fixes to make GNOME build and install under it.</p>
9855 <p>This chapter is aimed at pkgsrc developers and other people
9856 interested in helping our GNOME porting and packaging efforts.  It
9857 provides instructions on how to manage the existing packages and some
9858 important information regarding their internals.</p>
9859 <div class="note" title="We need your help!" style="margin-left: 0.5in; margin-right: 0.5in;">
9860 <h3 class="title">We need your help!</h3>
9861 <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9862   and GNOME and are willing to learn new exciting stuff, please jump
9863   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9864   work</a> list!  There is still a long way to go to get a
9865   fully-functional GNOME desktop under NetBSD and we need your help to
9866   achieve it!</p>
9867 </div>
9868 <div class="sect1" title="23.1. Meta packages">
9869 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9870 <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
9871 <p>pkgsrc includes three GNOME-related meta packages:</p>
9872 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9873 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
9874     the core GNOME desktop environment.  It only includes the necessary
9875     bits to get it to boot correctly, although it may lack important
9876     functionality for daily operation.  The idea behind this package is
9877     to let end users build their own configurations on top of this one,
9878     first installing this meta package to achieve a functional setup and
9879     then adding individual applications.</p></li>
9880 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
9881     complete installation of the GNOME platform and desktop as defined
9882     by the GNOME project; this is based on the components distributed in
9883     the <code class="filename">platform/x.y/x.y.z/sources</code> and
9884     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9885     official FTP server.  Developer-only tools found in those
9886     directories are not installed unless required by some other
9887     component to work properly.  Similarly, packages from the bindings
9888     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9889     in unless required as a dependency for an end-user component.  This
9890     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>
9891 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
9892     Installs all the tools required to build a GNOME component when
9893     fetched from the CVS repository.  These are required to let the
9894     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9895 </ul></div>
9896 <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9897 sorted in a way that eases updates: a package may depend on other
9898 packages listed before it but not on any listed after it.  It is very
9899 important to keep this order to ease updates so... <span class="emphasis"><em>do not
9900 change it to alphabetical sorting!</em></span></p>
9901 </div>
9902 <div class="sect1" title="23.2. Packaging a GNOME application">
9903 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9904 <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
9905 <p>Almost all GNOME applications are written in C and use a common
9906 set of tools as their build system.  Things get different with the new
9907 bindings to other languages (such as Python), but the following will
9908 give you a general idea on the minimum required tools:</p>
9909 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9910 <li class="listitem">
9911 <p>Almost all GNOME applications use the GNU Autotools as their
9912     build system.  As a general rule you will need to tell this to your
9913     package:</p>
9914 <pre class="programlisting">
9915 GNU_CONFIGURE=yes
9916 USE_LIBTOOL=yes
9917 USE_TOOLS+=gmake
9918 </pre>
9919 </li>
9920 <li class="listitem">
9921 <p>If the package uses pkg-config to detect dependencies, add this
9922     tool to the list of required utilities:</p>
9923 <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
9924 <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
9925     the end of the build process to ensure that you did not miss to
9926     specify any dependency in your package and that the version
9927     requirements are all correct.</p>
9928 </li>
9929 <li class="listitem"><p>If the package uses intltool, be sure to add
9930     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9931     to handle dependencies and to force the package to use the latest
9932     available version.</p></li>
9933 <li class="listitem">
9934 <p>If the package uses gtk-doc (a documentation generation
9935     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
9936     tool is rather big and the distfile should come with pregenerated
9937     documentation anyway; if it does not, it is a bug that you ought to
9938     report.  For such packages you should disable gtk-doc (unless it is
9939     the default):</p>
9940 <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9941 <p>The default location of installed HTML files
9942     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
9943     and should not be changed unless the package insists on installing
9944     them somewhere else.  Otherwise programs as
9945     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
9946     do that with an entry similar to:</p>
9947 <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
9948 </li>
9949 </ul></div>
9950 <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9951 files under the installation prefix to maintain databases.  In this
9952 context, shared means that those exact same directories and files are
9953 used among several different packages, leading to conflicts in the
9954 <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
9955 handle the most common cases, so you have to forget about using
9956 <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9957 omitting shared files from them.  If you find yourself doing those,
9958 <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9959 <p>The following table lists the common situations that result in
9960 using shared directories or files.  For each of them, the appropriate
9961 solution is given.  After applying the solution be sure to
9962 <span class="emphasis"><em>regenerate the package's file list</em></span> with
9963 <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9964 <div class="table">
9965 <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
9966 <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
9967 <colgroup>
9968 <col>
9969 <col>
9970 </colgroup>
9971 <thead><tr>
9972 <th>If the package...</th>
9973 <th>Then...</th>
9974 </tr></thead>
9975 <tbody>
9976 <tr>
9977 <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
9978 <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, &#8220;Packages installing scrollkeeper/rarian data files&#8221;</a>.</td>
9979 </tr>
9980 <tr>
9981 <td>Installs icons under the
9982         <code class="filename">share/icons/hicolor</code> hierarchy or updates
9983         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
9984 <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>
9985 </tr>
9986 <tr>
9987 <td>Installs files under
9988         <code class="filename">share/mime/packages</code>.</td>
9989 <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>
9990 </tr>
9991 <tr>
9992 <td>Installs <code class="filename">.desktop</code> files under
9993         <code class="filename">share/applications</code> and these include MIME
9994         information.</td>
9995 <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>
9996 </tr>
9997 </tbody>
9998 </table></div>
9999 </div>
10000 <br class="table-break">
10001 </div>
10002 <div class="sect1" title="23.3. Updating GNOME to a newer version">
10003 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10004 <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
10005 <p>When seeing GNOME as a whole, there are two kinds of
10006 updates:</p>
10007 <div class="variablelist"><dl>
10008 <dt><span class="term">Major update</span></dt>
10009 <dd>
10010 <p>Given that there is still a very long way for GNOME 3 (if it
10011       ever appears), we consider a major update one that goes from a
10012       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
10013       where <code class="literal">Y</code> is even and greater than
10014       <code class="literal">X</code>.  These are hard to achieve because they
10015       introduce lots of changes in the components' code and almost all
10016       GNOME distfiles are updated to newer versions.  Some of them can
10017       even break API and ABI compatibility with the previous major
10018       version series.  As a result, the update needs to be done all at
10019       once to minimize breakage.</p>
10020 <p>A major update typically consists of around 80 package
10021       updates and the addition of some new ones.</p>
10022 </dd>
10023 <dt><span class="term">Minor update</span></dt>
10024 <dd>
10025 <p>We consider a minor update one that goes from a
10026       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10027       one where <code class="literal">Y</code> is greater than
10028       <code class="literal">X</code>.  These are easy to achieve because they do
10029       not update all GNOME components, can be done in an incremental way
10030       and do not break API nor ABI compatibility.</p>
10031 <p>A minor update typically consists of around 50 package
10032       updates, although the numbers here may vary a lot.</p>
10033 </dd>
10034 </dl></div>
10035 <p>In order to update the GNOME components in pkgsrc to a new stable
10036 release (either major or minor), the following steps should be
10037 followed:</p>
10038 <div class="orderedlist"><ol class="orderedlist" type="1">
10039 <li class="listitem">
10040 <p>Get a list of all the tarballs that form the new release by
10041     using the following commands.  These will leave the full list of the
10042     components' distfiles into the <code class="filename">list.txt</code>
10043     file:</p>
10044 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10045     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10046     awk '{ print $9 }' &gt;list.txt</code></strong>
10047 <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10048     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10049     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
10050 </li>
10051 <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
10052     bump their version to the release you are updating them to.  The
10053     three meta packages should be always consistent with versioning.
10054     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10055     in them.</p></li>
10056 <li class="listitem">
10057 <p>For each meta package, update all its
10058     <code class="varname">DEPENDS</code> lines to match the latest versions as
10059     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
10060     newer version (even if found in the FTP) because the meta packages
10061     are supposed to list the exact versions that form a specific GNOME
10062     release.  Exceptions are permitted here if a newer version solves a
10063     serious issue in the overall desktop experience; these typically
10064     come in the form of a revision bump in pkgsrc, not in newer versions
10065     from the developers.</p>
10066 <p>Packages not listed in the <code class="filename">list.txt</code> file
10067     should be updated to the latest version available (if found in
10068     pkgsrc).  This is the case, for example, of the dependencies on the
10069     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>
10070 </li>
10071 <li class="listitem">
10072 <p>Generate a patch from the modified meta packages and extract the
10073     list of "new" lines.  This will provide you an outline on what
10074     packages need to be updated in pkgsrc and in what order:</p>
10075 <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>
10076 </li>
10077 <li class="listitem"><p>For major desktop updates it is recommended to zap all your
10078     installed packages and start over from scratch at this point.</p></li>
10079 <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
10080     of <code class="filename">todo.txt</code> and update the packages listed in
10081     it in order.  For major desktop updates none of these should be
10082     committed until the entire set is completed because there are chances
10083     of breaking not-yet-updated packages.</p></li>
10084 <li class="listitem"><p>Once the packages are up to date and working, commit them to
10085     the tree one by one with appropriate log messages.  At the end,
10086     commit the three meta package updates and all the corresponding
10087     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
10088     <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>
10089 </ol></div>
10090 </div>
10091 <div class="sect1" title="23.4. Patching guidelines">
10092 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10093 <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
10094 <p>GNOME is a very big component in pkgsrc which approaches 100
10095 packages.  Please, it is very important that you always, always,
10096 <span class="strong"><strong>always</strong></span> feed back any portability
10097 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
10098 their attention on portability issues and to ensure that future versions
10099 can be built out-of-the box on NetBSD.  The less custom patches in
10100 pkgsrc, the easier further updates are.  Those developers in charge of
10101 issuing major GNOME updates will be grateful if you do that.</p>
10102 <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
10103 Bugzilla</a>.  Not all components use these to track bugs, but most
10104 of them do.  Do not be short on your reports: always provide detailed
10105 explanations of the current failure, how it can be improved to achieve
10106 maximum portability and, if at all possible, provide a patch against CVS
10107 head.  The more verbose you are, the higher chances of your patch being
10108 accepted.</p>
10109 <p>Also, please avoid using preprocessor magic to fix portability
10110 issues.  While the FreeBSD GNOME people are doing a great job in porting
10111 GNOME to their operating system, the official GNOME sources are now
10112 plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10113 and similar macros.  This hurts portability.  Please see our patching
10114 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
10115 details.</p>
10116 </div>
10117 </div>
10118 </div>
10119 <div class="part" title="Part III. The pkgsrc infrastructure internals">
10120 <div class="titlepage"><div><div><h1 class="title">
10121 <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10122 <div class="partintro" title="The pkgsrc infrastructure internals">
10123 <div></div>
10124 <p>This part of the guide deals with everything
10125         from the infrastructure that is behind the interfaces described
10126         in the developer's guide. A casual package maintainer should not
10127         need anything from this part.</p>
10128 <div class="toc">
10129 <p><b>Table of Contents</b></p>
10130 <dl>
10131 <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
10132 <dd><dl>
10133 <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10134 <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10135 <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
10136 <dd><dl>
10137 <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10138 <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
10139 </dl></dd>
10140 <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10141 <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
10142 <dd><dl>
10143 <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10144 <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
10145 </dl></dd>
10146 <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
10147 <dd><dl>
10148 <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10149 <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
10150 </dl></dd>
10151 </dl></dd>
10152 <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
10153 <dd><dl>
10154 <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10155 <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10156 <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
10157 <dd><dl>
10158 <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10159 <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
10160 </dl></dd>
10161 </dl></dd>
10162 <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
10163 <dd><dl>
10164 <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10165 <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
10166 </dl></dd>
10167 </dl>
10168 </div>
10169 </div>
10170 <div class="chapter" title="Chapter 24. Design of the pkgsrc infrastructure">
10171 <div class="titlepage"><div><div><h2 class="title">
10172 <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
10173 <div class="toc">
10174 <p><b>Table of Contents</b></p>
10175 <dl>
10176 <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10177 <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10178 <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
10179 <dd><dl>
10180 <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10181 <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
10182 </dl></dd>
10183 <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10184 <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
10185 <dd><dl>
10186 <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10187 <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
10188 </dl></dd>
10189 <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
10190 <dd><dl>
10191 <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
10192 <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
10193 </dl></dd>
10194 </dl>
10195 </div>
10196 <p>The pkgsrc infrastructure consists of many small Makefile
10197         fragments. Each such fragment needs a properly specified
10198         interface. This chapter explains how such an interface looks
10199         like.</p>
10200 <div class="sect1" title="24.1. The meaning of variable definitions">
10201 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10202 <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
10203 <p>Whenever a variable is defined in the pkgsrc
10204         infrastructure, the location and the way of definition provide
10205         much information about the intended use of that variable.
10206         Additionally, more documentation may be found in a header
10207         comment or in this pkgsrc guide.</p>
10208 <p>A special file is
10209         <code class="filename">mk/defaults/mk.conf</code>, which lists all
10210         variables that are intended to be user-defined. They are either
10211         defined using the <code class="literal">?=</code> operator or they are
10212         left undefined because defining them to anything would
10213         effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
10214         overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10215         file.</p>
10216 <p>Outside this file, the following conventions apply:
10217         Variables that are defined using the <code class="literal">?=</code>
10218         operator may be overridden by a package.</p>
10219 <p>Variables that are defined using the <code class="literal">=</code>
10220         operator may be used read-only at run-time.</p>
10221 <p>Variables whose name starts with an underscore must not be
10222         accessed outside the pkgsrc infrastructure at all. They may
10223         change without further notice.</p>
10224 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
10225 <h3 class="title">Note</h3>
10226 <p>These conventions are currently not applied
10227         consistently to the complete pkgsrc
10228         infrastructure.</p>
10229 </div>
10230 </div>
10231 <div class="sect1" title="24.2. Avoiding problems before they arise">
10232 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10233 <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
10234 <p>All variables that contain lists of things should default
10235         to being empty. Two examples that do not follow this rule are
10236         <code class="varname">USE_LANGUAGES</code> and
10237         <code class="varname">DISTFILES</code>. These variables cannot simply be
10238         modified using the <code class="literal">+=</code> operator in package
10239         <code class="filename">Makefile</code>s (or other files included by
10240         them), since there is no guarantee whether the variable is
10241         already set or not, and what its value is. In the case of
10242         <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
10243         the default value and just define it as in the following
10244         example.</p>
10245 <pre class="programlisting">
10246 DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10247 </pre>
10248 <p>Because of the selection of this default value, the same
10249         value appears in many package Makefiles. Similarly for
10250         <code class="varname">USE_LANGUAGES</code>, but in this case the default
10251         value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
10252         doesn't stand out. Nevertheless it is mentioned in many
10253         files.</p>
10254 </div>
10255 <div class="sect1" title="24.3. Variable evaluation">
10256 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10257 <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
10258 <div class="sect2" title="24.3.1. At load time">
10259 <div class="titlepage"><div><div><h3 class="title">
10260 <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
10261 <p>Variable evaluation takes place either at load time or at
10262         runtime, depending on the context in which they occur. The
10263         contexts where variables are evaluated at load time are:</p>
10264 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
10265 <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
10266         and <code class="literal">!=</code> operators,</p></li>
10267 <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
10268         <code class="literal">.for</code>,</p></li>
10269 <li class="listitem"><p>Dependency lines.</p></li>
10270 </ul></div>
10271 <p>A special exception are references to the iteration
10272         variables of <code class="literal">.for</code> loops, which are expanded
10273         inline, no matter in which context they appear.</p>
10274 <p>As the values of variables may change during load time,
10275         care must be taken not to evaluate them by accident. Typical
10276         examples for variables that should not be evaluated at load time
10277         are <code class="varname">DEPENDS</code> and
10278         <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10279         clear, here is an example:</p>
10280 <pre class="programlisting">
10281 CONFIGURE_ARGS=         # none
10282 CFLAGS=                 -O
10283 CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
10284
10285 CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
10286
10287 CFLAGS+=                -Wall
10288         </pre>
10289 <p>This code shows how the use of the <code class="literal">:=</code>
10290         operator can quickly lead to unexpected results. The first
10291         paragraph is fairly common code. The second paragraph evaluates
10292         the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10293         <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10294         <code class="literal">-Wall</code> is appended to the
10295         <code class="varname">CFLAGS</code>, but this addition will not appear in
10296         <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10297         paragraphs from above typically occur in completely unrelated
10298         files.</p>
10299 </div>
10300 <div class="sect2" title="24.3.2. At runtime">
10301 <div class="titlepage"><div><div><h3 class="title">
10302 <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
10303 <p>After all the files have been loaded, the values of the
10304         variables cannot be changed anymore. Variables that are used in
10305         the shell commands are expanded at this point.</p>
10306 </div>
10307 </div>
10308 <div class="sect1" title="24.4. How can variables be specified?">
10309 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10310 <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
10311 <p>There are many ways in which the definition and use of a
10312         variable can be restricted in order to detect bugs and
10313         violations of the (mostly unwritten) policies. See the
10314         <code class="literal">pkglint</code> developer's documentation for further
10315         details.</p>
10316 </div>
10317 <div class="sect1" title="24.5. Designing interfaces for Makefile fragments">
10318 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10319 <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
10320 <p>Most of the <code class="filename">.mk</code> files fall into one
10321         of the following classes. Cases where a file falls into more
10322         than one class should be avoided as it often leads to subtle
10323         bugs.</p>
10324 <div class="sect2" title="24.5.1. Procedures with parameters">
10325 <div class="titlepage"><div><div><h3 class="title">
10326 <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
10327 <p>In a traditional imperative programming language some of
10328         the <code class="filename">.mk</code> files could be described as
10329         procedures. They take some input parameters and&mdash;after
10330         inclusion&mdash;provide a result in output parameters. Since all
10331         variables in <code class="filename">Makefile</code>s have global scope
10332         care must be taken not to use parameter names that have already
10333         another meaning. For example, <code class="varname">PKGNAME</code> is a
10334         bad choice for a parameter name.</p>
10335 <p>Procedures are completely evaluated at preprocessing time.
10336         That is, when calling a procedure all input parameters must be
10337         completely resolvable. For example,
10338         <code class="varname">CONFIGURE_ARGS</code> should never be an input
10339         parameter since it is very likely that further text will be
10340         added after calling the procedure, which would effectively apply
10341         the procedure to only a part of the variable. Also, references
10342         to other variables wit will be modified after calling the
10343         procedure.</p>
10344 <p>A procedure can declare its output parameters either as
10345         suitable for use in preprocessing directives or as only
10346         available at runtime. The latter alternative is for variables
10347         that contain references to other runtime variables.</p>
10348 <p>Procedures shall be written such that it is possible to
10349         call the procedure more than once. That is, the file must not
10350         contain multiple-inclusion guards.</p>
10351 <p>Examples for procedures are
10352         <code class="filename">mk/bsd.options.mk</code> and
10353         <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10354         that the parameters are evaluated at load time, they should be
10355         assigned using the <code class="literal">:=</code> operator, which should
10356         be used only for this purpose.</p>
10357 </div>
10358 <div class="sect2" title="24.5.2. Actions taken on behalf of parameters">
10359 <div class="titlepage"><div><div><h3 class="title">
10360 <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
10361 <p>Action files take some input parameters and may define
10362         runtime variables. They shall not define loadtime variables.
10363         There are action files that are included implicitly by the
10364         pkgsrc infrastructure, while other must be included
10365         explicitly.</p>
10366 <p>An example for action files is
10367         <code class="filename">mk/subst.mk</code>.</p>
10368 </div>
10369 </div>
10370 <div class="sect1" title="24.6. The order in which files are loaded">
10371 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10372 <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
10373 <p>Package <code class="filename">Makefile</code>s usually consist of
10374         a set of variable definitions, and include the file
10375         <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10376         Before that, they may also include various other
10377         <code class="filename">*.mk</code> files if they need to query the
10378         availability of certain features like the type of compiler or
10379         the X11 implementation. Due to the heavy use of preprocessor
10380         directives like <code class="literal">.if</code> and
10381         <code class="literal">.for</code>, the order in which the files are loaded
10382         matters.</p>
10383 <p>This section describes at which point the various files
10384         are loaded and gives reasons for that order.</p>
10385 <div class="sect2" title="24.6.1. The order in bsd.prefs.mk">
10386 <div class="titlepage"><div><div><h3 class="title">
10387 <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
10388 </h3></div></div></div>
10389 <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10390         is to define some essential variables like
10391         <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10392         <code class="varname">MACHINE_ARCH</code>.</p>
10393 <p>Then, the user settings are loaded from the file specified
10394         in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
10395         After that, those variables
10396         that have not been overridden by the user are loaded from
10397         <code class="filename">mk/defaults/mk.conf</code>.</p>
10398 <p>After the user settings, the system settings and platform
10399         settings are loaded, which may override the user
10400         settings.</p>
10401 <p>Then, the tool definitions are loaded. The tool wrappers
10402         are not yet in effect. This only happens when building a
10403         package, so the proper variables must be used instead of the
10404         direct tool names.</p>
10405 <p>As the last steps, some essential variables from the
10406         wrapper and the package system flavor are loaded, as well as the
10407         variables that have been cached in earlier phases of a package
10408         build.</p>
10409 </div>
10410 <div class="sect2" title="24.6.2. The order in bsd.pkg.mk">
10411 <div class="titlepage"><div><div><h3 class="title">
10412 <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
10413 </h3></div></div></div>
10414 <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10415 <p>Then, the various <code class="filename">*-vars.mk</code> files are
10416         loaded, which fill default values for those variables that have
10417         not been defined by the package. These variables may later
10418         be used even in unrelated files.</p>
10419 <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10420         provides the target <code class="literal">error-check</code> that is added
10421         as a special dependency to all other targets that use
10422         <code class="varname">DELAYED_ERROR_MSG</code> or
10423         <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10424 <p>Then, the package-specific hacks from
10425         <code class="filename">hacks.mk</code> are included.</p>
10426 <p>Then, various other files follow. Most of them don't have
10427         any dependencies on what they need to have included before or
10428         after them, though some do.</p>
10429 <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10430         <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10431         restricts the use of these variables to all the files that have
10432         been included before. Appearances in later files will be
10433         silently ignored.</p>
10434 <p>Then, the files for the main targets are included, in the
10435         order of later execution, though the actual order should not
10436         matter.</p>
10437 <p>At last, some more files are included that don't set any
10438         interesting variables but rather just define make targets to be
10439         executed.</p>
10440 </div>
10441 </div>
10442 </div>
10443 <div class="chapter" title="Chapter 25. Regression tests">
10444 <div class="titlepage"><div><div><h2 class="title">
10445 <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
10446 <div class="toc">
10447 <p><b>Table of Contents</b></p>
10448 <dl>
10449 <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10450 <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10451 <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
10452 <dd><dl>
10453 <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10454 <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
10455 </dl></dd>
10456 </dl>
10457 </div>
10458 <p>The pkgsrc infrastructure consists of a large codebase,
10459         and there are many corners where every little bit of a file is
10460         well thought out, making pkgsrc likely to fail as soon as
10461         anything is changed near those parts. To prevent most changes
10462         from breaking anything, a suite of regression tests should go
10463         along with every important part of the pkgsrc infrastructure.
10464         This chapter describes how regression tests work in pkgsrc and
10465         how you can add new tests.</p>
10466 <div class="sect1" title="25.1. The regression tests framework">
10467 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10468 <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
10469 <p></p>
10470 </div>
10471 <div class="sect1" title="25.2. Running the regression tests">
10472 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10473 <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
10474 <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
10475         provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
10476         can simply run that command, which will run all tests in the
10477         <code class="filename">regress</code> category.</p>
10478 </div>
10479 <div class="sect1" title="25.3. Adding a new regression test">
10480 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10481 <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
10482 <p>Every directory in the <code class="filename">regress</code>
10483         category that contains a file called <code class="filename">spec</code>
10484         is considered a regression test. This file is a shell program
10485         that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
10486         The following functions can be overridden to suit your
10487         needs.</p>
10488 <div class="sect2" title="25.3.1. Overridable functions">
10489 <div class="titlepage"><div><div><h3 class="title">
10490 <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
10491 <p>These functions do not take any parameters. They are all
10492         called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, so you should be careful
10493         to check the exitcodes of any commands you run in the
10494         test.</p>
10495 <div class="variablelist"><dl>
10496 <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10497 <dd><p>This function prepares the environment for the
10498         test. By default it does nothing.</p></dd>
10499 <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10500 <dd><p>This function runs the actual test. By default,
10501         it calls <code class="varname">TEST_MAKE</code> with the arguments
10502         <code class="varname">MAKEARGS_TEST</code> and writes its output including
10503         error messages into the file
10504         <code class="varname">TEST_OUTFILE</code>.</p></dd>
10505 <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10506 <dd><p>This function is run after the test and is
10507         typically used to compare the actual output from the one that is
10508         expected. It can make use of the various helper functions from
10509         the next section.</p></dd>
10510 <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10511 <dd><p>This function cleans everything up after the
10512         test has been run. By default it does nothing.</p></dd>
10513 </dl></div>
10514 </div>
10515 <div class="sect2" title="25.3.2. Helper functions">
10516 <div class="titlepage"><div><div><h3 class="title">
10517 <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
10518 <div class="variablelist"><dl>
10519 <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10520 <dd><p>This function compares the exitcode of the
10521         <span class="command"><strong>do_test()</strong></span> function with its first parameter.
10522         If they differ, the test will fail.</p></dd>
10523 <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10524 <dd><p>This function checks for each of its parameters
10525         if the output from <span class="command"><strong>do_test()</strong></span> matches the
10526         extended regular expression. If it does not, the test will
10527         fail.</p></dd>
10528 <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10529 <dd><p>This function checks for each of its parameters
10530         if the output from <span class="command"><strong>do_test()</strong></span> does
10531         <span class="emphasis"><em>not</em></span> match the extended regular expression.
10532         If any of the regular expressions matches, the test will
10533         fail.</p></dd>
10534 </dl></div>
10535 </div>
10536 </div>
10537 </div>
10538 <div class="chapter" title="Chapter 26. Porting pkgsrc">
10539 <div class="titlepage"><div><div><h2 class="title">
10540 <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
10541 <div class="toc">
10542 <p><b>Table of Contents</b></p>
10543 <dl>
10544 <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10545 <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
10546 </dl>
10547 </div>
10548 <p>The pkgsrc system has already been ported to many
10549         operating systems, hardware architectures and compilers. This
10550         chapter explains the necessary steps to make pkgsrc even more
10551         portable.</p>
10552 <div class="sect1" title="26.1. Porting pkgsrc to a new operating system">
10553 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10554 <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
10555 <p>To port pkgsrc to a new operating system (called
10556         <code class="literal">MyOS</code> in this example), you need to touch the
10557         following files:</p>
10558 <div class="variablelist"><dl>
10559 <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>
10560 <dd><p>This file contains some basic definitions, for
10561         example the name of the C
10562         compiler.</p></dd>
10563 <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10564 <dd><p>Insert code that defines the variables
10565         <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10566         <code class="varname">LOWER_OS_VERSION</code>,
10567         <code class="varname">LOWER_VENDOR</code>,
10568         <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10569         <code class="varname">APPEND_ELF</code>, and the other variables that
10570         appear in this file.</p></dd>
10571 <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10572 <dd><p>This file contains the platform-specific
10573         definitions that are used by pkgsrc. Start by copying one of the
10574         other files and edit it to your
10575         needs.</p></dd>
10576 <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
10577 <dd><p>This file contains a list of directories,
10578         together with their permission bits and ownership. These
10579         directories will be created automatically with every package
10580         that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10581         be removed.</p></dd>
10582 <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
10583 <dd><p>Just copy one of the pre-existing x11.dist files
10584         to your
10585         <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10586 <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
10587 <dd><p>On some operating systems, the tools that are
10588         provided with the base system are not good enough for pkgsrc.
10589         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
10590         narrow limit on the line length they can process. Therefore
10591         pkgsrc brings its own tools, which can be enabled
10592         here.</p></dd>
10593 <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10594 <dd><p>This file defines the paths to all the tools
10595         that are needed by one or the other package in pkgsrc, as well
10596         as by pkgsrc itself. Find out where these tools are on your
10597         platform and add them.</p></dd>
10598 </dl></div>
10599 <p>Now, you should be able to build some basic packages, like
10600         <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>
10601 </div>
10602 <div class="sect1" title="26.2. Adding support for a new compiler">
10603 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10604 <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
10605 <p>TODO</p>
10606 </div>
10607 </div>
10608 </div>
10609 <div class="appendix" title="Appendix A. A simple example package: bison">
10610 <div class="titlepage"><div><div><h2 class="title">
10611 <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10612 <div class="toc">
10613 <p><b>Table of Contents</b></p>
10614 <dl>
10615 <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10616 <dd><dl>
10617 <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10618 <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10619 <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10620 <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
10621 </dl></dd>
10622 <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10623 </dl>
10624 </div>
10625 <p>We checked to find a piece of software that wasn't in the packages
10626     collection, and picked GNU bison. Quite why someone would want to have
10627     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
10628     present in the tree is beyond us, but it's useful for the purposes of
10629     this exercise.</p>
10630 <div class="sect1" title="A.1. files">
10631 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10632 <a name="example-files"></a>A.1. files</h2></div></div></div>
10633 <div class="sect2" title="A.1.1. Makefile">
10634 <div class="titlepage"><div><div><h3 class="title">
10635 <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10636 <pre class="programlisting">
10637 # $NetBSD$
10638 #
10639
10640 DISTNAME=       bison-1.25
10641 CATEGORIES=     devel
10642 MASTER_SITES=   ${MASTER_SITE_GNU}
10643
10644 MAINTAINER=     thorpej@NetBSD.org
10645 HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
10646 COMMENT=        GNU yacc clone
10647
10648 GNU_CONFIGURE=  yes
10649 INFO_FILES=     bison.info
10650
10651 .include "../../mk/bsd.pkg.mk"
10652 </pre>
10653 </div>
10654 <div class="sect2" title="A.1.2. DESCR">
10655 <div class="titlepage"><div><div><h3 class="title">
10656 <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10657 <pre class="programlisting">
10658 GNU version of yacc.  Can make re-entrant parsers, and numerous other
10659 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
10660 of the NetBSD source tree is beyond me.
10661 </pre>
10662 </div>
10663 <div class="sect2" title="A.1.3. PLIST">
10664 <div class="titlepage"><div><div><h3 class="title">
10665 <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10666 <pre class="programlisting">
10667 @comment $NetBSD$
10668 bin/bison
10669 man/man1/bison.1.gz
10670 share/bison.simple
10671 share/bison.hairy
10672 </pre>
10673 </div>
10674 <div class="sect2" title="A.1.4. Checking a package with pkglint">
10675 <div class="titlepage"><div><div><h3 class="title">
10676 <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
10677 </h3></div></div></div>
10678 <p>The NetBSD package system comes with
10679         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10680         which helps to check the contents of these
10681         files. After installation it is quite easy to use, just change to the
10682         directory of the package you wish to examine and execute
10683         <span class="command"><strong>pkglint</strong></span>:</p>
10684 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10685 looks fine.</pre>
10686 <p>Depending on the supplied command line arguments (see pkglint(1)),
10687         more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
10688         -Wall</strong></span> for a very thorough check.</p>
10689 </div>
10690 </div>
10691 <div class="sect1" title="A.2. Steps for building, installing, packaging">
10692 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10693 <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10694 <p>Create the directory where the package lives,
10695       plus any auxiliary directories:</p>
10696 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10697 <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10698 <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10699 <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10700 <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
10701       <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>)
10702       then continue with fetching the distfile:</p>
10703 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10704 &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
10705 &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10706 Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10707 ftp: Error retrieving file: 500 Internal error
10708
10709 &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10710 Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10711 ftp: Error retrieving file: 500 Internal error
10712
10713 &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10714 Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10715 Successfully retrieved file.</pre>
10716 <p>Generate the checksum of the distfile into
10717       <code class="filename">distinfo</code>:</p>
10718 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10719 <p>Now compile:</p>
10720 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10721 &gt;&gt; Checksum OK for bison-1.25.tar.gz.
10722 ===&gt;  Extracting for bison-1.25
10723 ===&gt;  Patching for bison-1.25
10724 ===&gt;   Ignoring empty patch directory
10725 ===&gt;  Configuring for bison-1.25
10726 creating cache ./config.cache
10727 checking for gcc... cc
10728 checking whether we are using GNU C... yes
10729 checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10730 checking how to run the C preprocessor... cc -E
10731 checking for minix/config.h... no
10732 checking for POSIXized ISC... no
10733 checking whether cross-compiling... no
10734 checking for ANSI C header files... yes
10735 checking for string.h... yes
10736 checking for stdlib.h... yes
10737 checking for memory.h... yes
10738 checking for working const... yes
10739 checking for working alloca.h... no
10740 checking for alloca... yes
10741 checking for strerror... yes
10742 updating cache ./config.cache
10743 creating ./config.status
10744 creating Makefile
10745 ===&gt;  Building for bison-1.25
10746 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
10747 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
10748 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
10749 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
10750 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
10751 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
10752 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
10753 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
10754 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
10755 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
10756 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
10757 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
10758 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
10759 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
10760 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
10761 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
10762 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
10763 cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g warshall.c
10764 cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g version.c
10765 cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt.c
10766 cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt1.c
10767 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
10768 ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10769 rm -f bison.s1
10770 sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
10771 <p>Everything seems OK, so install the files:</p>
10772 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10773 &gt;&gt; Checksum OK for bison-1.25.tar.gz.
10774 ===&gt;  Installing for bison-1.25
10775 sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
10776 rm -f /usr/pkg/bin/bison
10777 cd /usr/pkg/share; rm -f bison.simple bison.hairy
10778 rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10779 install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10780 /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10781 /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10782 cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10783 /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10784 ===&gt;  Registering installation for bison-1.25</pre>
10785 <p>You can now use bison, and also - if you decide so - remove it with
10786       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
10787       binary package, do this now:</p>
10788 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10789 &gt;&gt; Checksum OK for bison-1.25.tar.gz.
10790 ===&gt;  Building package for bison-1.25
10791 Creating package bison-1.25.tgz
10792 Registering depends:.
10793 Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10794 <p>Now that you don't need the source and object files
10795       any more, clean up:</p>
10796 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10797 ===&gt;  Cleaning for bison-1.25</pre>
10798 </div>
10799 </div>
10800 <div class="appendix" title="Appendix B. Build logs">
10801 <div class="titlepage"><div><div><h2 class="title">
10802 <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10803 <div class="toc">
10804 <p><b>Table of Contents</b></p>
10805 <dl>
10806 <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10807 <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10808 </dl>
10809 </div>
10810 <div class="sect1" title="B.1. Building figlet">
10811 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10812 <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10813 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10814 ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
10815 =&gt; figlet221.tar.gz doesn't seem to exist on this system.
10816 =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10817 =&gt; [172219 bytes]
10818 Connected to ftp.plig.net.
10819 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10820 331 Guest login ok, send your complete e-mail address as password.
10821 230-You are user #5 of 500 simultaneous users allowed.
10822 230-
10823 230-  ___ _             _ _
10824 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
10825 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
10826 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
10827 230-         |_|   |_|     |___|         |___|
10828 230-
10829 230-** Welcome to ftp.plig.org **
10830 230-
10831 230-Please note that all transfers from this FTP site are logged. If you
10832 230-do not like this, please disconnect now.
10833 230-
10834 230-This archive is available via
10835 230-
10836 230-HTTP:  http://ftp.plig.org/
10837 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
10838 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
10839 230-
10840 230-Please email comments, bug reports and requests for packages to be
10841 230-mirrored to ftp-admin@plig.org.
10842 230-
10843 230-
10844 230 Logged in anonymously.
10845 Remote system type is UNIX.
10846 Using binary mode to transfer files.
10847 200 Type okay.
10848 250 "/pub" is new cwd.
10849 250-"/pub/figlet" is new cwd.
10850 250-
10851 250-Welcome to the figlet archive at ftp.figlet.org
10852 250-
10853 250-    ftp://ftp.figlet.org/pub/figlet/
10854 250-
10855 250-The official FIGlet web page is:
10856 250-    http://www.figlet.org/
10857 250-
10858 250-If you have questions, please mailto:info@figlet.org. If you want to
10859 250-contribute a font or something else, you can email us.
10860 250
10861 250 "/pub/figlet/program" is new cwd.
10862 250 "/pub/figlet/program/unix" is new cwd.
10863 local: figlet221.tar.gz remote: figlet221.tar.gz
10864 502 Unimplemented command.
10865 227 Entering Passive Mode (195,40,6,41,246,104)
10866 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10867 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
10868 226 Transfer completed.
10869 172219 bytes received in 00:02 (75.99 KB/s)
10870 221 Goodbye.
10871 =&gt; Checksum OK for figlet221.tar.gz.
10872 ===&gt; Extracting for figlet-2.2.1nb2
10873 ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10874 ===&gt; Patching for figlet-2.2.1nb2
10875 ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
10876 ===&gt; Overriding tools for figlet-2.2.1nb2
10877 ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
10878 ===&gt; Configuring for figlet-2.2.1nb2
10879 ===&gt; Building for figlet-2.2.1nb2
10880 gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
10881 chmod a+x figlet
10882 gcc -O2 -o chkfont chkfont.c
10883 =&gt; Unwrapping files-to-be-installed.
10884 <code class="prompt">#</code>
10885 <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10886 ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
10887 ===&gt; Installing for figlet-2.2.1nb2
10888 install -d -o root -g wheel -m 755 /usr/pkg/bin
10889 install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10890 mkdir -p /usr/pkg/share/figlet
10891 cp figlet /usr/pkg/bin
10892 cp chkfont /usr/pkg/bin
10893 chmod 555 figlist showfigfonts
10894 cp figlist /usr/pkg/bin
10895 cp showfigfonts /usr/pkg/bin
10896 cp fonts/*.flf /usr/pkg/share/figlet
10897 cp fonts/*.flc /usr/pkg/share/figlet
10898 cp figlet.6 /usr/pkg/man/man6
10899 ===&gt; Registering installation for figlet-2.2.1nb2
10900 <code class="prompt">#</code></pre>
10901 </div>
10902 <div class="sect1" title="B.2. Packaging figlet">
10903 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10904 <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10905 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10906 ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
10907 ===&gt; Packaging figlet-2.2.1nb2
10908 ===&gt; Building binary package for figlet-2.2.1nb2
10909 Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10910 Using SrcDir value of /usr/pkg
10911 Registering depends:.
10912 <code class="prompt">#</code></pre>
10913 </div>
10914 </div>
10915 <div class="appendix" title="Appendix C. Directory layout of the pkgsrc FTP server">
10916 <div class="titlepage"><div><div><h2 class="title">
10917 <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10918 <div class="toc">
10919 <p><b>Table of Contents</b></p>
10920 <dl>
10921 <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10922 <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10923 <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10924 <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10925 <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10926 <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10927 source packages</a></span></dt>
10928 </dl>
10929 </div>
10930 <p>As in other big projects, the directory layout of pkgsrc
10931         is quite complex for newbies. This chapter explains where you
10932         find things on the FTP server. The base directory on
10933         <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>.
10934         On other servers it may be different, but inside this directory,
10935         everything should look the same, no matter on which server you
10936         are. This directory contains some subdirectories, which are
10937         explained below.</p>
10938 <div class="sect1" title="C.1. distfiles: The distributed source files">
10939 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10940 <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10941 <p>The directory <code class="filename">distfiles</code> contains lots
10942         of archive files from all pkgsrc packages, which are mirrored
10943         here. The subdirectories are called after their package names
10944         and are used when the distributed files have names that don't
10945         explicitly contain a version number or are otherwise too generic
10946         (for example <code class="filename">release.tar.gz</code>).</p>
10947 </div>
10948 <div class="sect1" title="C.2. misc: Miscellaneous things">
10949 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10950 <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10951 <p>This directory contains things that individual pkgsrc
10952         developers find worth publishing.</p>
10953 </div>
10954 <div class="sect1" title="C.3. packages: Binary packages">
10955 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10956 <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
10957 <p>This directory contains binary packages for the various
10958         platforms that are supported by pkgsrc.
10959         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>
10960 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
10961 <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
10962         operating system for which the packages have been built. The
10963         name is taken from the output of the <span class="command"><strong>uname</strong></span>
10964         command, so it may differ from the one you are used to
10965         hear.</p></li>
10966 <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
10967         architecture of the platform for which the packages have been
10968         built. It also includes the <code class="varname">ABI</code> (Application
10969         Binary Interface) for platforms that have several of
10970         them.</p></li>
10971 <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
10972         the operating system. For version numbers that change often (for
10973         example NetBSD-current), the often-changing part should be
10974         replaced with an <code class="literal">x</code>, for example
10975         <code class="literal">4.99.x</code>.</p></li>
10976 <li class="listitem"><p><code class="varname">TAG</code> is either
10977         <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10978         for a stable branch, or <code class="literal">head</code> for packages
10979         built from the HEAD branch. The latter should only be used when
10980         the packages are updated on a regular basis. Otherwise the date
10981         from checking out pkgsrc should be appended, for example
10982         <code class="literal">head_20071015</code>.</p></li>
10983 </ul></div>
10984 <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10985         can quickly click through the directories on the
10986         server and find the best binary packages for their machines. Since they
10987         usually know the operating system and the hardware architecture, OPSYS
10988         and ARCH are placed first. After these choices, they can select the
10989         best combination of OSVERSION and TAG together, since it is usually the
10990         case that packages stay compatible between different version of the
10991         operating system.</p>
10992 <p>In each of these directories, there is a
10993         whole binary packages collection for a specific platform. It has a directory called
10994         <code class="filename">All</code> which contains all binary packages.
10995         Besides that, there are various category directories that
10996         contain symbolic links to the real binary packages.</p>
10997 </div>
10998 <div class="sect1" title="C.4. reports: Bulk build reports">
10999 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11000 <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
11001 <p>Here are the reports from bulk builds, for those who want
11002         to fix packages that didn't build on some of the platforms. The
11003         structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
11004 </div>
11005 <div class="sect1" title="C.5. current, pkgsrc-20xxQy: source packages">
11006 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11007 <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
11008 <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
11009 source packages</h2></div></div></div>
11010 <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
11011         that is the files that define how to create binary packages from
11012         source archives.</p>
11013 <p>The directory <code class="filename">pkgsrc</code> contains a
11014         snapshot of the CVS repository, which is updated regularly. The
11015         file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
11016         directory, ready to be downloaded as a whole.</p>
11017 <p>In the directories for the quarterly branches, there is an
11018         additional file called
11019         <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
11020         which contains the state of pkgsrc when it was branched.</p>
11021 </div>
11022 </div>
11023 <div class="appendix" title="Appendix D. Editing guidelines for the pkgsrc guide">
11024 <div class="titlepage"><div><div><h2 class="title">
11025 <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
11026 <div class="toc">
11027 <p><b>Table of Contents</b></p>
11028 <dl>
11029 <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
11030 <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11031 </dl>
11032 </div>
11033 <p>This section contains information on editing the pkgsrc
11034         guide itself.</p>
11035 <div class="sect1" title="D.1. Make targets">
11036 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11037 <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11038 <p>The pkgsrc guide's source code is stored in
11039         <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11040         are created from it:</p>
11041 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
11042 <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11043 <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11044 <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
11045 <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
11046         The PDF version of the pkgsrc guide.</p></li>
11047 <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
11048         PostScript version of the pkgsrc guide.</p></li>
11049 </ul></div>
11050 </div>
11051 <div class="sect1" title="D.2. Procedure">
11052 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11053 <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
11054 <p>The procedure to edit the pkgsrc guide is:</p>
11055 <div class="procedure"><ol class="procedure" type="1">
11056 <li class="step" title="Step 1"><p>Make sure you have the packages needed to
11057         regenerate the pkgsrc guide (and other XML-based NetBSD
11058         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
11059         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
11060         PostScript and PDF versions. You will need both packages
11061         installed, to make sure documentation is consistent across all
11062         formats.</p></li>
11063 <li class="step" title="Step 2"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
11064         right directory. All further steps will take place
11065         here.</p></li>
11066 <li class="step" title="Step 3"><p>Edit the XML file(s) in
11067         <code class="filename">files/</code>.</p></li>
11068 <li class="step" title="Step 4"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
11069         guide for valid XML and to build the final output files. If you
11070         get any errors at this stage, you can just edit the files, as
11071         there are only symbolic links in the working directory, pointing
11072         to the files in <code class="filename">files/</code>.</p></li>
11073 <li class="step" title="Step 5"><p><span class="command"><strong>(cd files &amp;&amp; cvs
11074         commit)</strong></span></p></li>
11075 <li class="step" title="Step 6"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
11076         regenerate the output files with the proper RCS
11077         Ids.</p></li>
11078 <li class="step" title="Step 7">
11079 <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
11080         commit the files in both <code class="filename">pkgsrc/doc</code> and
11081         <code class="filename">htdocs</code>.</p>
11082 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
11083 <h3 class="title">Note</h3>
11084 <p>If you have added, removed or renamed some chapters,
11085         you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11086         <span class="command"><strong>cvs delete</strong></span> in the htdocs
11087         directory.</p>
11088 </div>
11089 </li>
11090 </ol></div>
11091 </div>
11092 </div>
11093 </div></body>
11094 </html>