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" type="text/css" href="/global.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
 248       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
 249       and
 250       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
 251       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
 252 </dl></dd>
 253 <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
 254 <dd><dl>
 255 <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
 256 <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
 257 </dl></dd>
 258 </dl></dd>
 259 <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
 260 <dd><dl>
 261 <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
 262 <dd><dl>
 263 <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
 264 <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
 265 </dl></dd>
 266 <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
 267 <dd><dl>
 268 <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
 269 <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
 270 <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
 271 <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
 272 </dl></dd>
 273 <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
 274 <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">15.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
 275 <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
 276 <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
 277 <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
 278 <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
 279 <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
 280 </dl></dd>
 281 <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
 282 <dd><dl>
 283 <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
 284 <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
 285 <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
 286 <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
 287 </dl></dd>
 288 <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
 289 <dd><dl>
 290 <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
 291 <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
 292 <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
 293 <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
 294 <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
 295 <dd><dl>
 296 <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
 297 <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
 298 </dl></dd>
 299 <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
 300 <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
 301 <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
 302 <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
 303 <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
 304 <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
 305 <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
 306 <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
 307 <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
 308 <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
 309 <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
 310 <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
 311 </dl></dd>
 312 <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
 313 <dd><dl>
 314 <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
 315 <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
 316 <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
 317 <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
 318 </dl></dd>
 319 <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
 320 <dd><dl>
 321 <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
 322 <dd><dl>
 323 <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
 324 <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.2. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
 325 <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
 326 <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
 327 <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
 328 <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
 329 <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
 330 <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
 331 <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
 332 <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
 333 <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
 334 <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
 335 </dl></dd>
 336 <dt><span class="sect1"><a href="#fixes.fetch">19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
 337 <dd><dl>
 338 <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
 339 <dt><span class="sect2"><a href="#modified-distfiles-same-name">19.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
 340 </dl></dd>
 341 <dt><span class="sect1"><a href="#fixes.configure">19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
 342 <dd><dl>
 343 <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
 344 <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
 345 <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
 346 </dl></dd>
 347 <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
 348 <dd><dl>
 349 <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
 350 <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
 351 <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
 352 <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
 353 </dl></dd>
 354 <dt><span class="sect1"><a href="#fixes.build">19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</a></span></dt>
 355 <dd><dl>
 356 <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
 357 <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
 358 <dt><span class="sect2"><a href="#undefined-reference">19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
 359 <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
 360 </dl></dd>
 361 <dt><span class="sect1"><a href="#fixes.install">19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</a></span></dt>
 362 <dd><dl>
 363 <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
 364 <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
 365 <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
 366 <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
 367 <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
 368 <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
 369 <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
 370 <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
 371 <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
 372 <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
 373 <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
 374 <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
 375 <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
 376 <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
 377 <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
 378 <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
 379 <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
 380 <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
 381     emulation</a></span></dt>
 382 <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
 383 <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
 384 </dl></dd>
 385 <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
 386 </dl></dd>
 387 <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
 388 <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
 389 <dd><dl>
 390 <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
 391 <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
 392 <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
 393 <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
 394 <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
 395 <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
 396 <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
 397 </dl></dd>
 398 <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
 399 <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
 400 <dd><dl>
 401 <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
 402 <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
 403 <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
 404 <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
 405 </dl></dd>
 406 </dl></dd>
 407 <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
 408 <dd><dl>
 409 <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
 410 <dd><dl>
 411 <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
 412 <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
 413 <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
 414 <dd><dl>
 415 <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
 416 <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
 417 </dl></dd>
 418 <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
 419 <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
 420 <dd><dl>
 421 <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
 422 <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
 423 </dl></dd>
 424 <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
 425 <dd><dl>
 426 <dt><span class="sect2"><a href="#infr.order.prefs">24.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
 427 <dt><span class="sect2"><a href="#infr.order.pkg">24.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
 428 </dl></dd>
 429 </dl></dd>
 430 <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
 431 <dd><dl>
 432 <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
 433 <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
 434 <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
 435 <dd><dl>
 436 <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
 437 <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
 438 </dl></dd>
 439 </dl></dd>
 440 <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
 441 <dd><dl>
 442 <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
 443 <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
 444 </dl></dd>
 445 </dl></dd>
 446 <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
 447 <dd><dl>
 448 <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
 449 <dd><dl>
 450 <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
 451 <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
 452 <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
 453 <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
 454 </dl></dd>
 455 <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
 456 </dl></dd>
 457 <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
 458 <dd><dl>
 459 <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
 460 <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
 461 </dl></dd>
 462 <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
 463 <dd><dl>
 464 <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
 465 <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
 466 <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
 467 <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
 468 <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
 469 <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
 470 source packages</a></span></dt>
 471 </dl></dd>
 472 <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
 473 <dd><dl>
 474 <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
 475 <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
 476 </dl></dd>
 477 </dl>
 478 </div>
 479 <div class="list-of-tables">
 480 <p><b>List of Tables</b></p>
 481 <dl>
 482 <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
 483 </dt>
 484 <dt>11.1. <a href="#patch-examples">Patching examples</a>
 485 </dt>
 486 <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
 487 </dt>
 488 </dl>
 489 </div>
 490 <div class="chapter" title="Chapter 1. What is pkgsrc?">
 491 <div class="titlepage"><div><div><h2 class="title">
 492 <a name="introduction"></a>Chapter 1. What is pkgsrc?</h2></div></div></div>
 493 <div class="toc">
 494 <p><b>Table of Contents</b></p>
 495 <dl>
 496 <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
 497 <dd><dl>
 498 <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
 499 <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
 500 </dl></dd>
 501 <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
 502 <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
 503 <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
 504 <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
 505 </dl>
 506 </div>
 507 <div class="sect1" title="1.1. Introduction">
 508 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 509 <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
 510 <p>There is a lot of software freely available for Unix-based
 511 systems, which is usually available in form of the source code. Before
 512 such software can be used, it needs to be configured to the local
 513 system, compiled and installed, and this is exactly what The NetBSD
 514 Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
 515 to handle binary packages, so that not every user has to build the
 516 packages for himself, which is a time-costly task.</p>
 517 <p>pkgsrc currently contains several thousand packages,
 518       including:</p>
 519 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 520 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache/README.html" target="_top"><code class="filename">www/apache</code></a> - The Apache
 521           web server</p></li>
 522 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
 523           web browser</p></li>
 524 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
 525           Desktop Environment</p></li>
 526 <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a> - The K
 527           Desktop Environment</p></li>
 528 </ul></div>
 529 <p>...just to name a few.</p>
 530 <p>pkgsrc has built-in support for handling varying dependencies,
 531       such as pthreads and X11, and extended features such as IPv6 support on
 532       a range of platforms.</p>
 533 <div class="sect2" title="1.1.1. Why pkgsrc?">
 534 <div class="titlepage"><div><div><h3 class="title">
 535 <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
 536 <p>
 537 pkgsrc provides the following key features:
 538 </p>
 539 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 540 <li class="listitem"><p>Easy building of software from source as well as the creation
 541   and installation of binary packages. The source and latest
 542   patches are retrieved from a master or mirror download site, checksum
 543   verified, then built on your system. Support for binary-only
 544   distributions is available for both native platforms and NetBSD
 545   emulated platforms.</p></li>
 546 <li class="listitem"><p>All packages are installed in a consistent directory tree,
 547   including binaries, libraries, man pages and other
 548   documentation.</p></li>
 549 <li class="listitem"><p>Package dependencies, including when performing package updates,
 550   are handled automatically. The configuration files of various
 551   packages are handled automatically during updates, so local changes
 552   are preserved.</p></li>
 553 <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
 554   consists of highly portable code. This allows the greatest speed of
 555   development when porting to a new platform. This portability also
 556   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
 557   platforms</em></span>.</p></li>
 558 <li class="listitem"><p>The installation prefix, acceptable software licenses,
 559   international encryption requirements and build-time options for a
 560   large number of packages are all set in a simple, central
 561   configuration file.</p></li>
 562 <li class="listitem"><p>The entire source (not including the distribution files) is
 563   freely available under a BSD license, so you may extend and adapt
 564   pkgsrc to your needs. Support for local packages and patches is
 565   available right out of the box, so you can configure it specifically
 566   for your environment.</p></li>
 567 </ul></div>
 568 <p>The following principles are basic to pkgsrc:</p>
 569 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
 570 <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
 571 &mdash; That means, if a package contains bugs, it's better to find
 572 them and to complain about them rather than to just install the package
 573 and hope that it works. There are numerous checks in pkgsrc that try to
 574 find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
 575 of shell scripts), and post-installation checks (installed files,
 576 references to shared libraries, script interpreters).</p></li>
 577 <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
 578 &mdash; Like NetBSD has been ported to many hardware architectures,
 579 pkgsrc has been ported to many operating systems. Care is taken that
 580 packages behave the same on all platforms.</p></li>
 581 </ul></div>
 582 </div>
 583 <div class="sect2" title="1.1.2. Supported platforms">
 584 <div class="titlepage"><div><div><h3 class="title">
 585 <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
 586 <p>pkgsrc consists of both a source distribution and a binary
 587 distribution for these operating systems. After retrieving the required
 588 source or binaries, you can be up and running with pkgsrc in just
 589 minutes!</p>
 590 <p>pkgsrc was derived from FreeBSD's ports system, and
 591       initially developed for NetBSD only. Since then, pkgsrc has
 592       grown a lot, and now supports the following platforms:</p>
 593 <div class="table">
 594 <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
 595 <div class="table-contents"><table summary="Platforms supported by pkgsrc" border="1">
 596 <colgroup>
 597 <col>
 598 <col>
 599 </colgroup>
 600 <thead><tr>
 601 <th>Platform</th>
 602 <th>Date Support Added</th>
 603 </tr></thead>
 604 <tbody>
 605 <tr>
 606 <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
 607 <td align="center">Aug 1997</td>
 608 </tr>
 609 <tr>
 610 <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
 611 <td align="center">Mar 1999</td>
 612 </tr>
 613 <tr>
 614 <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
 615 <td align="center">Jun 1999</td>
 616 </tr>
 617 <tr>
 618 <td>
 619           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
 620           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
 621         </td>
 622 <td align="center">Oct 2001</td>
 623 </tr>
 624 <tr>
 625 <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
 626 <td align="center">Nov 2002</td>
 627 </tr>
 628 <tr>
 629 <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
 630 <td align="center">Nov 2002</td>
 631 </tr>
 632 <tr>
 633 <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
 634 <td align="center">Dec 2002</td>
 635 </tr>
 636 <tr>
 637 <td>BSD/OS</td>
 638 <td align="center">Dec 2003</td>
 639 </tr>
 640 <tr>
 641 <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
 642 <td align="center">Dec 2003</td>
 643 </tr>
 644 <tr>
 645 <td>
 646           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
 647           (Microsoft Windows Services for Unix)
 648         </td>
 649 <td align="center">Mar 2004</td>
 650 </tr>
 651 <tr>
 652 <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
 653 <td align="center">Oct 2004</td>
 654 </tr>
 655 <tr>
 656 <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
 657 <td align="center">Nov 2004</td>
 658 </tr>
 659 <tr>
 660 <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
 661 <td align="center">Apr 2007</td>
 662 </tr>
 663 <tr>
 664 <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
 665 <td align="center">Sep 2010</td>
 666 </tr>
 667 </tbody>
 668 </table></div>
 669 </div>
 670 <br class="table-break">
 671 </div>
 672 </div>
 673 <div class="sect1" title="1.2. Overview">
 674 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 675 <a name="overview"></a>1.2. Overview</h2></div></div></div>
 676 <p>This document is divided into three parts. The first,
 677         <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
 678         describes how one can use one of the packages in the Package
 679         Collection, either by installing a precompiled binary package,
 680         or by building one's own copy using the NetBSD package system.
 681         The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
 682         package so it can be easily built by other NetBSD users without
 683         knowing about the package's building details. The third part,
 684         <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
 685         is intended for those who want to understand how pkgsrc is
 686         implemented.</p>
 687 <p>This document is available in various formats:
 688         <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
 689 </div>
 690 <div class="sect1" title="1.3. Terminology">
 691 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 692 <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
 693 <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
 694       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
 695       terminology used within this document.</p>
 696 <div class="variablelist"><dl>
 697 <dt><span class="term">Package</span></dt>
 698 <dd><p>A set of files and building instructions
 699             that describe what's necessary
 700             to build a certain piece of software using
 701             pkgsrc. Packages are traditionally stored under
 702             <code class="filename">/usr/pkgsrc</code>.</p></dd>
 703 <dt><span class="term">The NetBSD package system</span></dt>
 704 <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
 705           is part of the NetBSD operating system and can be bootstrapped
 706           to run on non-NetBSD operating systems as well.  It handles
 707           building (compiling), installing, and removing of
 708           packages.</p></dd>
 709 <dt><span class="term">Distfile</span></dt>
 710 <dd><p>This term describes the file or files that are
 711             provided by the author of the piece of software to
 712             distribute his work. All the changes necessary to build on
 713             NetBSD are reflected in the corresponding package. Usually
 714             the distfile is in the form of a compressed tar-archive,
 715             but other types are possible, too. Distfiles are usually
 716             stored below
 717             <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
 718 <dt><span class="term">Port</span></dt>
 719 <dd><p>This is the term used by FreeBSD and OpenBSD people
 720             for what we call a package.
 721             In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
 722             architecture.</p></dd>
 723 <dt><span class="term">Precompiled/binary package</span></dt>
 724 <dd>
 725 <p>A set of binaries built with pkgsrc from a distfile
 726             and stuffed together in a single <code class="filename">.tgz</code>
 727             file so it can be installed on machines of the same
 728             machine architecture without the need to
 729             recompile. Packages are usually generated in
 730             <code class="filename">/usr/pkgsrc/packages</code>; there is also
 731             an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
 732 <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
 733             especially in the context of precompiled packages.</p>
 734 </dd>
 735 <dt><span class="term">Program</span></dt>
 736 <dd><p>The piece of software to be installed which will be
 737           constructed from all the files in the distfile by the
 738           actions defined in the corresponding package.</p></dd>
 739 </dl></div>
 740 <div class="sect2" title="1.3.1. Roles involved in pkgsrc">
 741 <div class="titlepage"><div><div><h3 class="title">
 742 <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
 743 <div class="variablelist"><dl>
 744 <dt><span class="term">pkgsrc users</span></dt>
 745 <dd>
 746 <p>The
 747         pkgsrc users are people who use the packages provided by pkgsrc.
 748         Typically they are system administrators. The people using the
 749         software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
 750         users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
 751 <p>There are two kinds of pkgsrc users: Some only want to
 752         install pre-built binary packages. Others build the pkgsrc
 753         packages from source, either for installing them directly or for
 754         building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
 755         documentation.</p>
 756 </dd>
 757 <dt><span class="term">package maintainers</span></dt>
 758 <dd><p>A
 759         package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
 760 <dt><span class="term">infrastructure developers</span></dt>
 761 <dd><p>These people are involved in all those files
 762         that live in the <code class="filename">mk/</code> directory and below.
 763         Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
 764         too.</p></dd>
 765 </dl></div>
 766 </div>
 767 </div>
 768 <div class="sect1" title="1.4. Typography">
 769 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 770 <a name="typography"></a>1.4. Typography</h2></div></div></div>
 771 <p>When giving examples for commands, shell prompts are used to
 772       show if the command should/can be issued as root, or if
 773       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
 774       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
 775       shell prompt, assuming they use the C-shell or tcsh.</p>
 776 </div>
 777 </div>
 778 <div class="part" title="Part I. The pkgsrc user's guide">
 779 <div class="titlepage"><div><div><h1 class="title">
 780 <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
 781 <div class="toc">
 782 <p><b>Table of Contents</b></p>
 783 <dl>
 784 <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
 785 <dd><dl>
 786 <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
 787 <dd><dl>
 788 <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
 789 <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
 790 </dl></dd>
 791 <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
 792 <dd><dl>
 793 <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
 794 <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
 795 </dl></dd>
 796 </dl></dd>
 797 <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
 798 <dd><dl>
 799 <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
 800 <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
 801 <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
 802 <dd><dl>
 803 <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
 804 <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
 805 <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
 806 <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
 807 <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
 808 <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
 809 <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
 810 </dl></dd>
 811 </dl></dd>
 812 <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
 813 <dd><dl>
 814 <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
 815 <dd><dl>
 816 <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
 817 <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
 818 <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
 819 <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
 820 <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
 821 <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
 822 <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
 823 <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
 824 </dl></dd>
 825 <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
 826 <dd><dl>
 827 <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
 828 <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
 829 <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
 830 </dl></dd>
 831 </dl></dd>
 832 <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
 833 <dd><dl>
 834 <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
 835 <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
 836 <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
 837 <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
 838 <dd><dl>
 839 <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
 840 <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
 841 <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
 842 </dl></dd>
 843 <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
 844 <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
 845 </dl></dd>
 846 <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
 847 <dd><dl>
 848 <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
 849 <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
 850 </dl></dd>
 851 <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
 852 builds)</a></span></dt>
 853 <dd><dl>
 854 <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
 855 <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
 856 <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
 857 <dd><dl>
 858 <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
 859 <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
 860 <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
 861 <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
 862 <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
 863 <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
 864 <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
 865 <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
 866 </dl></dd>
 867 <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
 868 <dd><dl>
 869 <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
 870 <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
 871 </dl></dd>
 872 <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
 873 <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
 874 </dl></dd>
 875 <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
 876 <dd><dl>
 877 <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
 878 <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
 879 </dl></dd>
 880 <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
 881 <dd><dl>
 882 <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
 883 <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
 884 <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
 885 <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
 886 <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
 887 <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.6. How can I install/use modular X.org from pkgsrc?</a></span></dt>
 888 <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
 889 <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
 890 <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
 891 <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
 892 /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
 893 <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
 894 <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
 895 <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
 896 <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
 897 <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
 898 <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
 899 <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
 900 </dl></dd>
 901 </dl>
 902 </div>
 903 <div class="chapter" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">
 904 <div class="titlepage"><div><div><h2 class="title">
 905 <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
 906 <div class="toc">
 907 <p><b>Table of Contents</b></p>
 908 <dl>
 909 <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
 910 <dd><dl>
 911 <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar file</a></span></dt>
 912 <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
 913 </dl></dd>
 914 <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
 915 <dd><dl>
 916 <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
 917 <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
 918 </dl></dd>
 919 </dl>
 920 </div>
 921 <p>Before you download and extract the files, you need to decide
 922 where you want to extract them. When using pkgsrc as root user, pkgsrc
 923 is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
 924 free to install the sources and binary packages wherever you want in
 925 your filesystem, provided that the pathname does not contain white-space
 926 or other characters that are interpreted specially by the shell and some
 927 other programs. A safe bet is to use only letters, digits, underscores
 928 and dashes.</p>
 929 <div class="sect1" title="2.1. Getting pkgsrc for the first time">
 930 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 931 <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
 932 <p>Before you download any pkgsrc files, you should decide
 933         whether you want the <span class="emphasis"><em>current</em></span> branch or the
 934         <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
 935         quarterly basis from the current branch and only gets modified
 936         for security updates. The names of the stable branches are built
 937         from the year and the quarter, for example
 938         <code class="literal">2009Q1</code>.</p>
 939 <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
 940         want to download pkgsrc. You can get it as a tar file or via CVS.
 941         Both ways are described here.</p>
 942 <div class="sect2" title="2.1.1. As tar file">
 943 <div class="titlepage"><div><div><h3 class="title">
 944 <a name="getting-via-tar"></a>2.1.1. As tar file</h3></div></div></div>
 945 <p>The primary download location for all pkgsrc files is
 946         <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>. There are a
 947         number of subdirectories for different purposes, which are
 948         described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
 949 <p>The tar file for the current branch is in the directory
 950         <code class="filename">current</code> and is called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
 951         It is autogenerated daily.</p>
 952 <p>The tar file for the stable branch 2009Q1 is in the
 953         directory <code class="filename">pkgsrc-2009Q1</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2009Q1/pkgsrc-2009Q1.tar.gz" target="_top"><code class="filename">pkgsrc-2009Q1.tar.gz</code></a>.</p>
 954 <p>To download a pkgsrc stable tarball, run:</p>
 955 <pre class="screen">
 956 <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz</code></strong></pre>
 957 <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
 958         stable branch to be downloaded, for example,
 959         <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span>.</p>
 960 <p>Then, extract it with:</p>
 961 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf <em class="replaceable"><code>pkgsrc-20xxQy</code></em>.tar.gz -C /usr</code></strong></pre>
 962 <p>This will create the directory <code class="filename">pkgsrc/</code>
 963         in <code class="filename">/usr/</code> and all the package source will be
 964         stored under <code class="filename">/usr/pkgsrc/</code>.</p>
 965 <p>To download pkgsrc-current, run:</p>
 966 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
 967 </div>
 968 <div class="sect2" title="2.1.2. Via anonymous CVS">
 969 <div class="titlepage"><div><div><h3 class="title">
 970 <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
 971 <p>To fetch a specific pkgsrc stable branch, run:</p>
 972 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
 973 </pre>
 974 <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable
 975         branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2009Q1</span>&#8221;</span></p>
 976 <p>This will create the directory <code class="filename">pkgsrc/</code>
 977         in your <code class="filename">/usr/</code> directory and all the package source
 978         will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
 979 <p>To fetch the pkgsrc current branch, run:</p>
 980 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
 981 </pre>
 982 <p>Refer to <a class="ulink" href="http://NetBSD.org/FIXME" target="_top">list of available CVS mirrors</a> to choose faster one.</p>
 983 <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
 984 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
 985 </pre>
 986 <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
 987         For Bourne shells, you can set it in your <code class="filename">.profile</code>
 988         or better globally in <code class="filename">/etc/profile</code>:</p>
 989 <pre class="programlisting">
 990 # set CVS remote shell command
 991 CVS_RSH=ssh
 992 export CVS_RSH
 993 </pre>
 994 <p>By default, CVS doesn't do things like most people would expect it to do.
 995         But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
 996         in your home directory and saving the following lines to it.
 997         This file will save you lots of headache and some bug reports, so we strongly recommend it.
 998         You can find an explanation of this file in the CVS documentation.</p>
 999 <pre class="programlisting">
1000 # recommended CVS configuration file from the pkgsrc guide
1001 cvs -q -z3
1002 checkout -P
1003 update -dP
1004 diff -upN
1005 rdiff -u
1006 release -d
1007 </pre>
1008 </div>
1009 </div>
1010 <div class="sect1" title="2.2. Keeping pkgsrc up-to-date">
1011 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1012 <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1013 <p>The preferred way to keep pkgsrc up-to-date is via CVS
1014         (which also works if you have first installed it via a tar
1015         file). It saves bandwidth and hard disk activity, compared to
1016         downloading the tar file again.</p>
1017 <div class="sect2" title="2.2.1. Via tar files">
1018 <div class="titlepage"><div><div><h3 class="title">
1019 <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1020 <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1021 <h3 class="title">Warning</h3>
1022 <p>When updating from a tar file, you first need to
1023         completely remove the old pkgsrc directory. Otherwise those
1024         files that have been removed from pkgsrc in the mean time will
1025         not be removed on your local disk, resulting in inconsistencies.
1026         When removing the old files, any changes that you have done to
1027         the pkgsrc files will be lost after updating. Therefore updating
1028         via CVS is strongly recommended.</p>
1029 </div>
1030 <p>Note that by default the distfiles and the binary packages
1031         are saved in the pkgsrc tree, so don't forget to rescue them
1032         before updating. You can also configure pkgsrc to use other than
1033         the default directories by setting the
1034         <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1035         variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1036 <p>To update pkgsrc from a tar file, download the tar file as
1037         explained above. Then, make sure that you have not made any
1038         changes to the files in the pkgsrc directory. Remove the pkgsrc
1039         directory and extract the new tar file. Done.</p>
1040 </div>
1041 <div class="sect2" title="2.2.2. Via CVS">
1042 <div class="titlepage"><div><div><h3 class="title">
1043 <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1044 <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
1045 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
1046 </pre>
1047 <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
1048 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; env CVS_RSH=ssh cvs up -dP</code></strong>
1049 </pre>
1050 <div class="sect3" title="2.2.2.1. Switching between different pkgsrc branches">
1051 <div class="titlepage"><div><div><h4 class="title">
1052 <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1053 <p>When updating pkgsrc, the CVS program keeps track of the
1054         branch you selected. But if you, for whatever reason, want to
1055         switch from the stable branch to the current one, you can do it
1056         by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
1057         <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1058         back to the stable branch, add the
1059         <span class="quote">&#8220;<span class="quote">-rpkgsrc-2009Q3</span>&#8221;</span> option.</p>
1060 </div>
1061 <div class="sect3" title="2.2.2.2. What happens to my changes when updating?">
1062 <div class="titlepage"><div><div><h4 class="title">
1063 <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1064 <p>When you update pkgsrc, the CVS program will only touch
1065         those files that are registered in the CVS repository. That
1066         means that any packages that you created on your own will stay
1067         unmodified. If you change files that are managed by CVS, later
1068         updates will try to merge your changes with those that have been
1069         done by others. See the CVS manual, chapter
1070         <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1071 </div>
1072 </div>
1073 </div>
1074 </div>
1075 <div class="chapter" title="Chapter 3. Using pkgsrc on systems other than NetBSD">
1076 <div class="titlepage"><div><div><h2 class="title">
1077 <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1078 <div class="toc">
1079 <p><b>Table of Contents</b></p>
1080 <dl>
1081 <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
1082 <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
1083 <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
1084 <dd><dl>
1085 <dt><span class="sect2"><a href="#darwin">3.3.1. Darwin (Mac OS X)</a></span></dt>
1086 <dt><span class="sect2"><a href="#freebsd">3.3.2. FreeBSD</a></span></dt>
1087 <dt><span class="sect2"><a href="#interix">3.3.3. Interix</a></span></dt>
1088 <dt><span class="sect2"><a href="#irix">3.3.4. IRIX</a></span></dt>
1089 <dt><span class="sect2"><a href="#linux">3.3.5. Linux</a></span></dt>
1090 <dt><span class="sect2"><a href="#openbsd">3.3.6. OpenBSD</a></span></dt>
1091 <dt><span class="sect2"><a href="#solaris">3.3.7. Solaris</a></span></dt>
1092 </dl></dd>
1093 </dl>
1094 </div>
1095 <div class="sect1" title="3.1. Binary distribution">
1096 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1097 <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1098 <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1099 </div>
1100 <div class="sect1" title="3.2. Bootstrapping pkgsrc">
1101 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1102 <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1103 <p>Installing the bootstrap kit from source should be as simple as:</p>
1104 <pre class="screen">
1105 <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout pkgsrc</code></strong>
1106 <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1107 <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
1108     </pre>
1109 <p>See <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a> for other ways to get
1110     pkgsrc before bootstrapping. The given
1111     <span class="command"><strong>bootstrap</strong></span> command will use the defaults of
1112     <code class="filename">/usr/pkg</code> for the
1113     <span class="emphasis"><em>prefix</em></span> where programs will be installed in,
1114     and <code class="filename">/var/db/pkg</code> for the package database
1115     directory where pkgsrc will do its internal bookkeeping.
1116     However, these can also be set using command-line
1117     arguments.</p>
1118 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1119 <h3 class="title">Note</h3>
1120 <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
1121       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
1122       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1123       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1124 </div>
1125 </div>
1126 <div class="sect1" title="3.3. Platform-specific notes">
1127 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1128 <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1129 <p>Here are some platform-specific notes you should be aware of.</p>
1130 <div class="sect2" title="3.3.1. Darwin (Mac OS X)">
1131 <div class="titlepage"><div><div><h3 class="title">
1132 <a name="darwin"></a>3.3.1. Darwin (Mac OS X)</h3></div></div></div>
1133 <p>Darwin 5.x and up are supported. Before you start, you
1134       will need to download and install the Mac OS X Developer Tools
1135       from Apple's Developer Connection. See
1136       <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1137       for details.  Also, make sure you install X11 (an optional
1138       package included with the Developer Tools) if you intend to
1139       build packages that use the X11 Window System.</p>
1140 </div>
1141 <div class="sect2" title="3.3.2. FreeBSD">
1142 <div class="titlepage"><div><div><h3 class="title">
1143 <a name="freebsd"></a>3.3.2. FreeBSD</h3></div></div></div>
1144 <p>FreeBSD 4.7 and 5.0 have been tested and are supported,
1145       other versions may work.</p>
1146 <p>Care should be taken so that the tools that this kit installs do not conflict
1147       with the FreeBSD userland tools. There are several steps:</p>
1148 <div class="orderedlist"><ol class="orderedlist" type="1">
1149 <li class="listitem"><p>FreeBSD stores its ports pkg database in
1150           <code class="filename">/var/db/pkg</code>. It is therefore
1151           recommended that you choose a different location (e.g.
1152           <code class="filename">/usr/pkgdb</code>) by
1153           using the --pkgdbdir option to the bootstrap script.</p></li>
1154 <li class="listitem">
1155 <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1156           good idea to move them out of the way to avoid confusion, e.g.</p>
1157 <pre class="screen">
1158 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1159 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1160 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1161 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1162 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1163           </pre>
1164 </li>
1165 <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1166           <code class="filename">/etc/mk.conf.example</code> file
1167           when you use the bootstrap script.</p></li>
1168 </ol></div>
1169 </div>
1170 <div class="sect2" title="3.3.3. Interix">
1171 <div class="titlepage"><div><div><h3 class="title">
1172 <a name="interix"></a>3.3.3. Interix</h3></div></div></div>
1173 <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1174       providing a Unix-like environment with a tighter kernel integration than
1175       available with Cygwin.  It is part of the Windows Services for Unix
1176       package, available for free for any licensed copy of Windows 2000, XP
1177       (not including XP Home), or 2003.  SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1178 <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
1179       are not officially supported.  (The main difference in 3.0/3.1 is lack
1180       of pthreads, but other parts of libc may also be lacking.)</p>
1181 <p>Services for Unix Applications (aka SUA) is an integrated
1182       component of Windows Server 2003 R2 (5.2), Windows Vista and
1183       Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
1184       (6.1).  As of this writing, the SUA's Interix 6.0 (32bit) and
1185       6.1 (64bit) subsystems have been tested.  Other versions may
1186       work as well. The Interix 5.x subsystem has not yet been tested
1187       with pkgsrc.</p>
1188 <div class="sect3" title="3.3.3.1. When installing Interix/SFU">
1189 <div class="titlepage"><div><div><h4 class="title">
1190 <a name="platform.interix-sfu-install"></a>3.3.3.1. When installing Interix/SFU</h4></div></div></div>
1191 <p>At an absolute minimum, the following packages must be installed from
1192         the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1193 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1194 <li class="listitem"><p>Utilities -&gt; Base Utilities</p></li>
1195 <li class="listitem"><p>Interix GNU Components -&gt; (all)</p></li>
1196 <li class="listitem"><p>Remote Connectivity</p></li>
1197 <li class="listitem"><p>Interix SDK</p></li>
1198 </ul></div>
1199 <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1200         "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
1201         /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
1202         pkgsrc (or from a binary package).</p>
1203 <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1204         not need to be installed, but Remote Connectivity itself should be
1205         installed in order to have a working inetd.</p>
1206 <p>During installation you may be asked whether to enable setuid
1207         behavior for Interix programs, and whether to make pathnames default to
1208         case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
1209         enabled.  (Without case-sensitivity, a large number of packages including
1210         perl will not build.)</p>
1211 <p>NOTE:  Newer Windows service packs change the way binary execution
1212         works (via the Data Execution Prevention feature).  In order to use
1213         pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
1214         POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
1215         must be installed.  Hotfixes are available from Microsoft through a
1216         support contract; however, Debian Interix Port has made most Interix
1217         hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1218 <p>In addition to the hotfix noted above, it may be necessary to
1219         disable Data Execution Prevention entirely to make Interix functional.
1220         This may happen only with certain types of CPUs; the cause is not fully
1221         understood at this time.  If gcc or other applications still segfault
1222         repeatedly after installing one of the hotfixes note above, the
1223         following option can be added to the appropriate "boot.ini" line on the
1224         Windows boot drive:  /NoExecute=AlwaysOff
1225         (WARNING, this will disable DEP completely, which may be a security
1226         risk if applications are often run as a user in the Administrators
1227         group!)</p>
1228 </div>
1229 <div class="sect3" title="3.3.3.2. What to do if Interix/SFU is already installed">
1230 <div class="titlepage"><div><div><h4 class="title">
1231 <a name="platform.interix-sfu-postinstall"></a>3.3.3.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1232 <p>If SFU is already installed and you wish to alter these settings to work
1233         with pkgsrc, note the following things.</p>
1234 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1235 <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1236             Windows Services for UNIX, then click Change.  In the installer, choose
1237             Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1238 <li class="listitem">
1239 <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1240             change the following registry key:</p>
1241 <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
1242 <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
1243 </li>
1244 <li class="listitem">
1245 <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1246             following registry key:</p>
1247 <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
1248 <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
1249 </li>
1250 </ul></div>
1251 </div>
1252 <div class="sect3" title="3.3.3.3. Important notes for using pkgsrc">
1253 <div class="titlepage"><div><div><h4 class="title">
1254 <a name="platform.interix-notes"></a>3.3.3.3. Important notes for using pkgsrc</h4></div></div></div>
1255 <p>The package manager (either the pkgsrc "su" user, or the user
1256         running "pkg_add") must be a member of the local Administrators
1257         group.  Such a user must also be used to run the bootstrap.  This is
1258         slightly relaxed from the normal pkgsrc requirement of "root".</p>
1259 <p>The package manager should use a umask of 002.  "make install" will
1260         automatically complain if this is not the case.  This ensures that
1261         directories written in /var/db/pkg are Administrators-group writeable.</p>
1262 <p>The popular Interix binary packages from http://www.interopsystems.com/
1263         use an older version of pkgsrc's pkg_* tools.  Ideally, these should
1264         NOT be used in conjunction with pkgsrc.  If you choose to use them at
1265         the same time as the pkgsrc packages, ensure that you use the proper
1266         pkg_* tools for each type of binary package.</p>
1267 <p>The TERM setting used for DOS-type console windows (including those
1268         invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
1269         don't have a termcap/terminfo entry for it, but the following .termcap
1270         entry provides adequate emulation in most cases:</p>
1271 <pre class="programlisting">
1272 interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1273         </pre>
1274 </div>
1275 <div class="sect3" title="3.3.3.4. Limitations of the Interix platform">
1276 <div class="titlepage"><div><div><h4 class="title">
1277 <a name="platform.interix-limits"></a>3.3.3.4. Limitations of the Interix platform</h4></div></div></div>
1278 <p>Though Interix suffices as a familiar and flexible substitute
1279         for a full Unix-like platform, it has some drawbacks that should
1280         be noted for those desiring to make the most of Interix.</p>
1281 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1282 <li class="listitem">
1283 <p><span class="strong"><strong>X11:</strong></span></p>
1284 <p>Interix comes with the standard set of X11R6 client libraries,
1285           and can run X11 based applications, but it does
1286           <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1287           <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
1288           <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1289           (available in a trimmed version for Interix from Interop Systems as the
1290           <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1291           and the free X11 server included with
1292           <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1293 </li>
1294 <li class="listitem">
1295 <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
1296 <p>Because Interix runs in a completely different NT subsystem from
1297           Win32 applications, it does not currently support various X11
1298           protocol extensions for acceleration (such as MIT-SHM or DGA).
1299           Most interactive applications to a local X server will run
1300           reasonably fast, but full motion video and other graphics
1301           intensive applications may require a faster-than-expected CPU.</p>
1302 </li>
1303 <li class="listitem">
1304 <p><span class="strong"><strong>Audio:</strong></span></p>
1305 <p>Interix has no native support for audio output.  For audio
1306           support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1307           audio system on Interix.  Unlike on most platforms, the
1308           <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1309           <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1310           server component.  To output audio via an Interix host, the
1311           <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1312           must also be installed.</p>
1313 </li>
1314 <li class="listitem">
1315 <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
1316 <p>Direct device access is not currently supported in Interix, so it
1317           is not currently possible to access CD/DVD drives, USB devices,
1318           or SCSI devices through non-filesystem means.  Among other things,
1319           this makes it impossible to use Interix directly for CD/DVD
1320           burning.</p>
1321 </li>
1322 <li class="listitem">
1323 <p><span class="strong"><strong>Tape drives:</strong></span></p>
1324 <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1325           drives are also not directly accessible in Interix.  However,
1326           support is in work to make tape drive access possible by using
1327           Cygwin as a bridge (similarly to audio bridged via Cygwin's
1328           esound server).</p>
1329 </li>
1330 </ul></div>
1331 </div>
1332 <div class="sect3" title="3.3.3.5. Known issues for pkgsrc on Interix">
1333 <div class="titlepage"><div><div><h4 class="title">
1334 <a name="platform.interix-knownissues"></a>3.3.3.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1335 <p>It is not necessary, in general, to have a "root" user on the
1336         Windows system; any member of the local Administrators group will
1337         suffice.  However, some packages currently assume that the user
1338         named "root" is the privileged user.  To accommodate these, you
1339         may create such a user; make sure it is in the local group
1340         Administrators (or your language equivalent).</p>
1341 <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1342         0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
1343         time being, install packages as the local Administrator (or
1344         your language equivalent), or run the following command after
1345         installing a package to work around the issue:</p>
1346 <pre class="screen">
1347 <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
1348         </pre>
1349 </div>
1350 </div>
1351 <div class="sect2" title="3.3.4. IRIX">
1352 <div class="titlepage"><div><div><h3 class="title">
1353 <a name="irix"></a>3.3.4. IRIX</h3></div></div></div>
1354 <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1355       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
1356       according to your preference.  If you do not have a license for the MIPSpro
1357       compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1358 <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1359       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>,
1360       etc.</p>
1361 <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1362         switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
1363         you start out using "abi=n32", that's what all your packages will be built
1364         with.</p>
1365 <p>Therefore, please make sure that you have no conflicting
1366       <code class="varname">CFLAGS</code> in your environment or the
1367       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1368       try to link n32 object files with lib64 or vice versa.  Check your
1369       <code class="filename">/etc/compiler.defaults</code>!</p>
1370 <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1371       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
1372       as it appears that IRIX linker occasionally runs into issues when trying to
1373       link over a network-mounted file system.</p>
1374 <p>The bootstrapping process should set all the right options for programs such
1375       as imake(1), but you may want to set some options depending on your local
1376       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
1377       course, your compiler's man pages for details.</p>
1378 <p>If you are using SGI's MIPSPro compiler, please set
1379
1380       </p>
1381 <pre class="programlisting">
1382 PKGSRC_COMPILER=        mipspro
1383       </pre>
1384 <p>
1385
1386       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1387       are using gcc and may end up passing invalid flags to the compiler.  Note that
1388       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
1389       default.</p>
1390 <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1391       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1392       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
1393       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
1394       '--preserve-path' flag.</p>
1395 </div>
1396 <div class="sect2" title="3.3.5. Linux">
1397 <div class="titlepage"><div><div><h3 class="title">
1398 <a name="linux"></a>3.3.5. Linux</h3></div></div></div>
1399 <p>Some versions of Linux (for example Debian GNU/Linux) need
1400       either libtermcap or libcurses (libncurses).  Installing the
1401       distributions libncurses-dev package (or equivalent) should fix
1402       the problem.</p>
1403 <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
1404       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
1405       i386 have been tested.</p>
1406 <p>To bootstrap using icc, assuming the default icc installation
1407       directory:</p>
1408 <pre class="programlisting">
1409 env CC=/opt/intel_cc_80/bin/icc LDFLAGS=-static-libcxa \
1410 ac_cv___attribute__=yes ./bootstrap
1411       </pre>
1412 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1413 <h3 class="title">Note</h3>
1414 <p>icc 8.1 needs the `-i-static' argument instead of -static-libcxa.</p>
1415 </div>
1416 <p>icc supports __attribute__, but the GNU configure test uses a nested
1417       function, which icc does not support. #undef'ing __attribute__ has the
1418       unfortunate side-effect of breaking many of the Linux header files, which
1419       cannot be compiled properly without __attribute__. The test must be
1420       overridden so that __attribute__ is assumed supported by the
1421       compiler.</p>
1422 <p>After bootstrapping, you should set <code class="varname">PKGSRC_COMPILER</code>
1423       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1424 <pre class="programlisting">
1425 PKGSRC_COMPILER=        icc
1426       </pre>
1427 <p>The default installation directory for icc is
1428       <code class="filename">/opt/intel_cc_80</code>, which
1429       is also the pkgsrc default. If you have installed it into a different
1430       directory, set <code class="varname">ICCBASE</code> in
1431       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1432 <pre class="programlisting">
1433 ICCBASE=                /opt/icc
1434       </pre>
1435 <p>pkgsrc uses the static linking method of the runtime libraries
1436       provided by icc, so binaries can be run on other systems which do not
1437       have the shared libraries installed.</p>
1438 <p>Libtool, however, extracts a list of libraries from the
1439       <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
1440       records it, throwing away the -Bstatic and -Bdynamic options
1441       interspersed between the libraries.  This means that
1442       libtool-linked C++ shared libraries will have a runtime
1443       dependency on the icc libraries until this is fixed in
1444       libtool.</p>
1445 </div>
1446 <div class="sect2" title="3.3.6. OpenBSD">
1447 <div class="titlepage"><div><div><h3 class="title">
1448 <a name="openbsd"></a>3.3.6. OpenBSD</h3></div></div></div>
1449 <p>OpenBSD 3.0 and 3.2 are tested and supported.</p>
1450 <p>Care should be taken so that the tools that this kit installs do not conflict
1451       with the OpenBSD userland tools. There are several steps:</p>
1452 <div class="orderedlist"><ol class="orderedlist" type="1">
1453 <li class="listitem"><p>OpenBSD stores its ports pkg database in
1454           <code class="filename">/var/db/pkg</code>. It is therefore
1455           recommended that you choose a different location (e.g.
1456           <code class="filename">/usr/pkgdb</code>) by
1457           using the --pkgdbdir option to the bootstrap script.</p></li>
1458 <li class="listitem">
1459 <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1460           good idea to move them out of the way to avoid confusion, e.g.</p>
1461 <pre class="screen">
1462 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1463 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
1464 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
1465 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1466 <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
1467           </pre>
1468 </li>
1469 <li class="listitem">
1470 <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1471           <code class="filename">/etc/mk.conf.example</code> file
1472           when you use the bootstrap script. OpenBSD's make program uses
1473           <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1474           as well. You can work around this by enclosing all the pkgsrc-specific parts
1475           of the file with:</p>
1476 <pre class="programlisting">
1477 .ifdef BSD_PKG_MK
1478 # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
1479 .else
1480 # OpenBSD stuff
1481 .endif
1482           </pre>
1483 </li>
1484 </ol></div>
1485 </div>
1486 <div class="sect2" title="3.3.7. Solaris">
1487 <div class="titlepage"><div><div><h3 class="title">
1488 <a name="solaris"></a>3.3.7. Solaris</h3></div></div></div>
1489 <p>Solaris 2.6 through 9 are supported on both x86 and sparc.
1490       You will need a working C compiler. Both gcc 2.95.3 and
1491       Sun WorkShop 5 have been tested.</p>
1492 <p>The following packages are required on Solaris 8 for the bootstrap
1493       process and to build packages.</p>
1494 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1495 <li class="listitem"><p>SUNWsprot</p></li>
1496 <li class="listitem"><p>SUNWarc</p></li>
1497 <li class="listitem"><p>SUNWbtool</p></li>
1498 <li class="listitem"><p>SUNWtoo</p></li>
1499 <li class="listitem"><p>SUNWlibm</p></li>
1500 </ul></div>
1501 <p>Please note that the use of GNU binutils on Solaris is
1502       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1503 <p>Whichever compiler you use, please ensure the compiler tools and
1504       your $prefix are in your <code class="varname">PATH</code>. This includes
1505       <code class="filename">/usr/ccs/{bin,lib}</code>
1506       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1507 <div class="sect3" title="3.3.7.1. If you are using gcc">
1508 <div class="titlepage"><div><div><h4 class="title">
1509 <a name="solaris-gcc-note"></a>3.3.7.1. If you are using gcc</h4></div></div></div>
1510 <p>It makes life much simpler if you only use the same gcc consistently
1511         for building all packages.</p>
1512 <p>It is recommended that an external gcc be used only for bootstrapping,
1513         then either build gcc from
1514         <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
1515         package, then remove gcc used during bootstrapping.</p>
1516 <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>
1517 </div>
1518 <div class="sect3" title="3.3.7.2. If you are using Sun WorkShop">
1519 <div class="titlepage"><div><div><h4 class="title">
1520 <a name="solaris-sun-workshop-note"></a>3.3.7.2. If you are using Sun WorkShop</h4></div></div></div>
1521 <p>You will need at least the following packages installed (from WorkShop
1522         5.0)</p>
1523 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1524 <li class="listitem"><p>SPROcc
1525           - Sun WorkShop Compiler C 5.0</p></li>
1526 <li class="listitem"><p>SPROcpl
1527           - Sun WorkShop Compiler C++ 5.0</p></li>
1528 <li class="listitem"><p>SPROild
1529           - Sun WorkShop Incremental Linker</p></li>
1530 <li class="listitem"><p>SPROlang
1531           - Sun WorkShop Compilers common components</p></li>
1532 </ul></div>
1533 <p>You should set the following variables in your
1534         <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1535 <pre class="programlisting">
1536 CC=     cc
1537 CXX=    CC
1538 CPP=    cc -E
1539 CXXCPP= CC -E
1540 </pre>
1541 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1542 <h3 class="title">Note</h3>
1543 <p>The <code class="varname">CPP</code> setting might break some
1544         packages that use the C preprocessor for processing things other
1545         than C source code.</p>
1546 </div>
1547 </div>
1548 <div class="sect3" title="3.3.7.3. Building 64-bit binaries with SunPro">
1549 <div class="titlepage"><div><div><h4 class="title">
1550 <a name="solaris-sunpro-64"></a>3.3.7.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1551 <p>To build 64-bit packages, you just need to have the
1552         following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1553 <pre class="programlisting">
1554 PKGSRC_COMPILER=        sunpro
1555 ABI=                    64
1556 </pre>
1557 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1558 <h3 class="title">Note</h3>
1559 <p>This setting has been tested for the SPARC
1560         architecture. Intel and AMD machines need some more
1561         work.</p>
1562 </div>
1563 </div>
1564 <div class="sect3" title="3.3.7.4. Common problems">
1565 <div class="titlepage"><div><div><h4 class="title">
1566 <a name="plat.sunos.problems"></a>3.3.7.4. Common problems</h4></div></div></div>
1567 <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1568       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
1569       The workaround is to use another shell for the configure
1570       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
1571       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1572 <pre class="programlisting">
1573 CONFIG_SHELL=   ${LOCALBASE}/bin/bash
1574 WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1575       </pre>
1576 <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>
1577 </div>
1578 </div>
1579 </div>
1580 </div>
1581 <div class="chapter" title="Chapter 4. Using pkgsrc">
1582 <div class="titlepage"><div><div><h2 class="title">
1583 <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
1584 <div class="toc">
1585 <p><b>Table of Contents</b></p>
1586 <dl>
1587 <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
1588 <dd><dl>
1589 <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
1590 <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1591 <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
1592 <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
1593 <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
1594 <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>
1595 <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1596 <dt><span class="sect2"><a href="#a-word-of-warning">4.1.8. A word of warning</a></span></dt>
1597 </dl></dd>
1598 <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
1599 <dd><dl>
1600 <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
1601 <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
1602 <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
1603 </dl></dd>
1604 </dl>
1605 </div>
1606 <p>Basically, there are two ways of using pkgsrc. The first
1607 is to only install the package tools and to use binary packages
1608 that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
1609 in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1610 of pkgsrc, too. Then you are able to build your own packages,
1611 and you can still use binary packages from someone else.</p>
1612 <div class="sect1" title="4.1. Using binary packages">
1613 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1614 <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1615 <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1616   server and its mirrors, there are collections of binary packages,
1617   ready to be installed. These binary packages have been built using the
1618   default settings for the directories, that is:</p>
1619 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
1620 <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>
1621 <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
1622 <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>
1623 </ul></div>
1624 <p>If you cannot use these directories for whatever reasons (maybe
1625   because you're not root), you cannot use these binary packages, but
1626   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>
1627 <div class="sect2" title="4.1.1. Finding binary packages">
1628 <div class="titlepage"><div><div><h3 class="title">
1629 <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1630 <p>To install binary packages, you first need to know from where
1631     to get them. The first place where you should look is on the main
1632     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>
1633 <p>This directory contains binary packages for multiple
1634     platforms. First, select your operating system. (Ignore the
1635     directories with version numbers attached to it, they just exist for
1636     legacy reasons.) Then, select your hardware architecture, and in the
1637     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1638 <p>In this directory, you often find a file called
1639     <code class="filename">bootstrap.tar.gz</code> which contains the package
1640     management tools. If the file is missing, it is likely that your
1641     operating system already provides those tools. Download the file and
1642     extract it in the <code class="filename">/</code> directory. It will create
1643     the directories <code class="filename">/usr/pkg</code> (containing the tools
1644     for managing binary packages) and <code class="filename">/var/db/pkg</code>
1645     (the database of installed packages).</p>
1646 </div>
1647 <div class="sect2" title="4.1.2. Installing binary packages">
1648 <div class="titlepage"><div><div><h3 class="title">
1649 <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1650 <p>In the directory from the last section, there is a
1651     subdirectory called <code class="filename">All</code>, which contains all the
1652     binary packages that are available for the platform, excluding those
1653     that may not be distributed via FTP or CDROM (depending on which
1654     medium you are using).</p>
1655 <p>To install packages directly from an FTP or HTTP server, run
1656     the following commands in a Bourne-compatible shell (be sure to
1657     <span class="command"><strong>su</strong></span> to root first):</p>
1658 <pre class="screen">
1659 <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1660 <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>
1661 <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1662 </pre>
1663 <p>Instead of URLs, you can also use local paths, for example if
1664     you are installing from a set of CDROMs, DVDs or an NFS-mounted
1665     repository. If you want to install packages from multiple sources,
1666     you can separate them by a semicolon in
1667     <code class="varname">PKG_PATH</code>.</p>
1668 <p>After these preparations, installing a package is very
1669     easy:</p>
1670 <pre class="screen">
1671 <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
1672 <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1673 <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
1674 </pre>
1675 <p>Note that any prerequisite packages needed to run the
1676     package in question will be installed, too, assuming they are
1677     present where you install from.</p>
1678 <p>Adding packages might install vulnerable packages.
1679     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1680     regularly, especially after installing new packages, and verify
1681     that the vulnerabilities are acceptable for your configuration.</p>
1682 <p>After you've installed packages, be sure to have
1683     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
1684     <code class="varname">PATH</code> so you can actually start the just
1685     installed program.</p>
1686 </div>
1687 <div class="sect2" title="4.1.3. Deinstalling packages">
1688 <div class="titlepage"><div><div><h3 class="title">
1689 <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
1690 <p>To deinstall a package, it does not matter whether it was
1691     installed from source code or from a binary package. The
1692     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
1693     To delete a package, you can just run <span class="command"><strong>pkg_delete
1694     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1695     name can be given with or without version number. Wildcards can
1696     also be used to deinstall a set of packages, for example
1697     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
1698     so that the shell does not expand them before
1699     <code class="literal">pkg_delete</code> sees them.</p>
1700 <p>The <code class="option">-r</code> option is very powerful: it
1701     removes all the packages that require the package in question
1702     and then removes the package itself. For example:
1703
1704     </p>
1705 <pre class="screen">
1706 <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
1707     </pre>
1708 <p>
1709
1710     will remove jpeg and all the packages that used it; this allows
1711     upgrading the jpeg package.</p>
1712 </div>
1713 <div class="sect2" title="4.1.4. Getting information about installed packages">
1714 <div class="titlepage"><div><div><h3 class="title">
1715 <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1716 <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1717     installed packages or binary package files.</p>
1718 </div>
1719 <div class="sect2" title="4.1.5. Checking for security vulnerabilities in installed packages">
1720 <div class="titlepage"><div><div><h3 class="title">
1721 <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1722 <p>
1723       The NetBSD Security-Officer and Packages Groups maintain a list of
1724       known security vulnerabilities to packages which are (or have been)
1725       included in pkgsrc.  The list is available from the NetBSD
1726       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>.
1727     </p>
1728 <p>
1729       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1730       this list can be downloaded
1731       automatically, and a security audit of all packages installed on a system
1732       can take place.
1733     </p>
1734 <p>
1735       There are two components to auditing.  The first
1736       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1737       is for downloading
1738       the list of vulnerabilities from the NetBSD FTP site.  The second
1739       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1740       installed packages are vulnerable.  If a package is vulnerable, you
1741       will see output similar to the following:
1742     </p>
1743 <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1744     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1745 <p>
1746       You may wish to have the
1747       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1748       file downloaded daily so that
1749       it remains current.  This may be done by adding an appropriate entry
1750       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
1751       </p>
1752 <pre class="screen">
1753 # download vulnerabilities file
1754 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1755       </pre>
1756 <p>
1757       will update the vulnerability list every day at 3AM. You may wish to do
1758       this more often than once a day.
1759
1760       In addition, you may wish to run the package audit from the daily
1761       security script.  This may be accomplished by adding the following
1762       line to <code class="filename">/etc/security.local</code>:
1763       </p>
1764 <pre class="screen">
1765 /usr/sbin/pkg_admin audit
1766       </pre>
1767 <p>
1768     </p>
1769 </div>
1770 <div class="sect2" title="4.1.6. Finding if newer versions of your installed packages are in pkgsrc">
1771 <div class="titlepage"><div><div><h3 class="title">
1772 <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1773 <p>
1774       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
1775       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1776       argument to check if your packages are up-to-date, e.g.
1777     </p>
1778 <pre class="screen">
1779 <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1780 ...
1781 Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
1782     </pre>
1783 <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1784     package on your system and rebuild any dependencies.
1785     </p>
1786 </div>
1787 <div class="sect2" title="4.1.7. Other administrative functions">
1788 <div class="titlepage"><div><div><h3 class="title">
1789 <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1790 <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1791     administrative functions on the package system.</p>
1792 </div>
1793 <div class="sect2" title="4.1.8. A word of warning">
1794 <div class="titlepage"><div><div><h3 class="title">
1795 <a name="a-word-of-warning"></a>4.1.8. A word of warning</h3></div></div></div>
1796 <p>Please pay very careful attention to the warnings
1797     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
1798     inherent dangers of installing binary packages which you did
1799     not create yourself, and the security holes that can be
1800     introduced onto your system by indiscriminate adding of such
1801     files.</p>
1802 <p>The same warning of course applies to every package you
1803     install from source when you haven't completely read and
1804     understood the source code of the package, the compiler that
1805     is used to build the package and all the other tools that are
1806     involved.</p>
1807 </div>
1808 </div>
1809 <div class="sect1" title="4.2. Building packages from source">
1810 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1811 <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1812 <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
1813   directory now contains a set of packages, organized into
1814   categories. You can browse the online index of packages, or run
1815   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1816   directory to build local <code class="filename">README.html</code> files for
1817   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>
1818 <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
1819   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
1820   should do so by setting <code class="varname">LOCALBASE</code> in
1821   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1822   different <code class="varname">LOCALBASE</code> definitions on the same
1823   system (inside a chroot is an exception). </p>
1824 <p>The rest of this chapter assumes that the package is already
1825   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
1826   instructions how to create your own packages.</p>
1827 <div class="sect2" title="4.2.1. Requirements">
1828 <div class="titlepage"><div><div><h3 class="title">
1829 <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1830 <p>To build packages from source, you need a working C
1831     compiler. On NetBSD, you need to install the
1832     <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
1833     sets. If you want to build X11-related packages, the
1834     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1835     sets are required, too.</p>
1836 </div>
1837 <div class="sect2" title="4.2.2. Fetching distfiles">
1838 <div class="titlepage"><div><div><h3 class="title">
1839 <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
1840 <p>The first step for building a package is downloading the
1841     distfiles (i.e. the unmodified source). If they have not yet been
1842     downloaded, pkgsrc will fetch them automatically.</p>
1843 <p>If you have all files that you need in the
1844     <code class="filename">distfiles</code> directory,
1845     you don't need to connect. If the distfiles are on CD-ROM, you can
1846     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
1847     </p>
1848 <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
1849 <p>
1850     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1851 <p>By default a list of distribution sites will be randomly
1852     intermixed to prevent huge load on servers which holding popular
1853     packages (for example, SourceForge.net mirrors). Thus, every
1854     time when you need to fetch yet another distfile all the mirrors
1855     will be tried in new (random) order. You can turn this feature
1856     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
1857     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1858 <p>You can overwrite some of the major distribution sites to
1859     fit to sites that are close to your own.  By setting one or two
1860     variables you can modify the order in which the master sites are
1861     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
1862     delimited list of domain suffixes.
1863     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
1864     contains a whitespace delimited list of regular expressions.  It
1865     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
1866     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
1867     some examples.  This may save some of your bandwidth and
1868     time.</p>
1869 <p>You can change these settings either in your shell's environment, or,
1870     if you want to keep the settings, by editing the
1871     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1872     and adding the definitions there.</p>
1873 <p>
1874       If a package depends on many other packages (such as
1875       <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
1876       alternate between periods of
1877       downloading source, and compiling. To ensure you have all the source
1878       downloaded initially you can run the command:
1879       </p>
1880 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
1881 <p>
1882       which will output and run a set of shell commands to fetch the
1883       necessary files into the <code class="filename">distfiles</code> directory.  You can
1884       also choose to download the files manually.
1885     </p>
1886 </div>
1887 <div class="sect2" title="4.2.3. How to build and install">
1888 <div class="titlepage"><div><div><h3 class="title">
1889 <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1890 <p>
1891       Once the software has downloaded, any patches will be applied, then it
1892       will be compiled for you. This may take some time depending on your
1893       computer, and how many other packages the software depends on and their
1894       compile time.
1895     </p>
1896 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
1897 <h3 class="title">Note</h3>
1898 <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1899     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1900     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1901 </div>
1902 <p>For example, type</p>
1903 <pre class="screen">
1904 <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
1905 <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
1906     </pre>
1907 <p>at the shell prompt to build the various components of the
1908     package.</p>
1909 <p>The next stage is to actually install the newly compiled
1910     program onto your system. Do this by entering:
1911
1912     </p>
1913 <pre class="screen">
1914 <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
1915     </pre>
1916 <p>
1917
1918     while you are still in the directory for whatever package you
1919     are installing.</p>
1920 <p>Installing the package on your system may require you to
1921     be root.  However, pkgsrc has a
1922     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
1923     to only become root for the actual installation step.</p>
1924 <p>That's it, the software should now be installed and setup for use.
1925     You can now enter:
1926
1927     </p>
1928 <pre class="screen">
1929 <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
1930     </pre>
1931 <p>
1932
1933     to remove the compiled files in the work directory, as you shouldn't need
1934     them any more. If other packages were also added to your system
1935     (dependencies) to allow your program to compile, you can tidy these up
1936     also with the command:</p>
1937 <pre class="screen">
1938 <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
1939     </pre>
1940 <p>Taking the figlet utility as an example, we can install it on our
1941     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1942 <p>The program is installed under the default root of the
1943     packages tree - <code class="filename">/usr/pkg</code>. Should this not
1944     conform to your tastes, set the <code class="varname">LOCALBASE</code>
1945     variable in your environment, and it will use that value as the
1946     root of your packages tree. So, to use
1947     <code class="filename">/usr/local</code>, set
1948     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
1949     Please note that you should use a directory which is dedicated to
1950     packages and not shared with other programs (i.e., do not try and
1951     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
1952     to add any of your own files or directories (such as
1953     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
1954     <code class="filename">pkgsrc/</code>) below the
1955     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
1956     conflicts between programs and other files installed by the
1957     package system and whatever else may have been installed
1958     there.</p>
1959 <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1960     alter some configuration options at build time.  Have a look at
1961     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
1962     of what will be set there by default.  Environment variables such
1963     as <code class="varname">LOCALBASE</code> can be set in
1964     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1965     set them each time you want to use pkgsrc.</p>
1966 <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
1967     covers</span>&#8221;</span> to see what is going on when a package is building
1968     or being installed. This may be for debugging purposes, or out of
1969     simple curiosity. A number of utility values have been added to
1970     help with this.</p>
1971 <div class="orderedlist"><ol class="orderedlist" type="1">
1972 <li class="listitem">
1973 <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
1974         <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
1975         information will be displayed. For example,</p>
1976 <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1977 <p>will show all the commands that are invoked, up to and
1978         including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1979 </li>
1980 <li class="listitem">
1981 <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>
1982         definition, then the <code class="varname">VARNAME</code> definition
1983         should be used, in conjunction with the show-var
1984         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>
1985         variable <code class="varname">LOCALBASE</code>:</p>
1986 <pre class="screen">
1987 <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1988 /usr/pkg
1989 <code class="prompt">%</code>
1990         </pre>
1991 </li>
1992 </ol></div>
1993 <p>If you want to install a binary package that you've either
1994     created yourself (see next section), that you put into
1995     pkgsrc/packages manually or that is located on a remote FTP
1996     server, you can use the "bin-install" target. This target will
1997     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>,
1998     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1999     sites searched is kept in the variable
2000     <code class="varname">BINPKG_SITES</code>, which defaults to
2001     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>
2002     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
2003     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
2004     details.</p>
2005 <p>A final word of warning: If you set up a system that has a
2006     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
2007     set that before any packages are installed, as you cannot use
2008     several directories for the same purpose. Doing so will result in
2009     pkgsrc not being able to properly detect your installed packages,
2010     and fail miserably. Note also that precompiled binary packages are
2011     usually built with the default <code class="varname">LOCALBASE</code> of
2012     <code class="filename">/usr/pkg</code>, and that you should
2013     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
2014     <code class="varname">LOCALBASE</code>.</p>
2015 </div>
2016 </div>
2017 </div>
2018 <div class="chapter" title="Chapter 5. Configuring pkgsrc">
2019 <div class="titlepage"><div><div><h2 class="title">
2020 <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
2021 <div class="toc">
2022 <p><b>Table of Contents</b></p>
2023 <dl>
2024 <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
2025 <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
2026 <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
2027 <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
2028 <dd><dl>
2029 <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
2030 <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
2031 <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
2032 </dl></dd>
2033 <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
2034 <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
2035 </dl>
2036 </div>
2037 <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
2038 called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
2039 that file depends on the installation. On NetBSD, when you use
2040 <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
2041 <code class="filename">/etc/</code>. In all other cases the default location is
2042 <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
2043 bootstrap program to install the binary packages.</p>
2044 <p>During the bootstrap, an example configuration file is created. To
2045 use that, you have to create the directory
2046 <code class="filename">${PREFIX}/etc</code> and copy the example file
2047 there.</p>
2048 <p>The format of the configuration file is that of the usual
2049 BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
2050 is done by setting variables in this file. Note that you can define all
2051 kinds of variables, and no special error checking (for example for
2052 spelling mistakes) takes place, so you have to try it out to see if it
2053 works.</p>
2054 <div class="sect1" title="5.1. General configuration">
2055 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2056 <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
2057 <p>In this section, you can find some variables that apply to all
2058     pkgsrc packages. A complete list of the variables that can be
2059     configured by the user is available in
2060     <code class="filename">mk/defaults/mk.conf</code>, together with some
2061     comments that describe each variable's intent.</p>
2062 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2063 <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
2064             packages will be installed. The default is
2065             <code class="filename">/usr/pkg</code>. Do not mix binary packages
2066             with different <code class="varname">LOCALBASE</code>s!</p></li>
2067 <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
2068             <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
2069             installed. The default is
2070             <code class="filename">${LOCALBASE}/cross</code>.</p></li>
2071 <li class="listitem"><p><code class="varname">X11BASE</code>: Where
2072             X11 is installed on the system. The default is
2073             <code class="filename">/usr/X11R6</code>.</p></li>
2074 <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
2075             downloaded copies of the original source distributions used
2076             for building pkgsrc packages. The default is
2077             <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
2078 <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
2079             database about installed packages is stored.  The default is
2080             <code class="filename">/var/db/pkg</code>.</p></li>
2081 <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
2082             If set, override the packages'
2083             <code class="varname">MASTER_SITES</code> with this value.</p></li>
2084 <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
2085             Backup location(s) for distribution files and patch files
2086             if not found locally or in
2087             <code class="filename">${MASTER_SITES}</code> or
2088             <code class="filename">${PATCH_SITES}</code> respectively.
2089             The defaults are
2090             <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
2091             and
2092             <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
2093 <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
2094             List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
2095             <em class="replaceable"><code>arch</code></em> are replaced with OS
2096             release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
2097             (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
2098 <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
2099             List of acceptable licenses. License names are case-sensitive.
2100             Whenever you try to build a package whose license is not in this
2101             list, you will get an error message. If the license condition is
2102             simple enough, the error message will include specific
2103             instructions on how to change this variable.</p></li>
2104 </ul></div>
2105 </div>
2106 <div class="sect1" title="5.2. Variables affecting the build process">
2107 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2108 <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
2109 <p>XXX
2110       </p>
2111 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2112 <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
2113             directory for the binary packages. The default is
2114             <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
2115 <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
2116             The top level directory where, if defined, the separate
2117             working directories will get created, and symbolically
2118             linked to from <code class="filename">${WRKDIR}</code> (see below).
2119             This is useful for building packages on several
2120             architectures, then <code class="filename">${PKGSRCDIR}</code>
2121             can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
2122             is local to every architecture. (It should be noted that
2123             <code class="varname">PKGSRCDIR</code> should not be set by the user
2124             &mdash; it is an internal definition which refers to the
2125             root of the pkgsrc tree. It is possible to have many
2126             pkgsrc tree instances.)</p></li>
2127 <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
2128             Directory for local patches that aren't part of pkgsrc.
2129             See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;patches/*&#8221;</a> for more
2130             information.</p></li>
2131 <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
2132             the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
2133             BSD-style Makefile. If this is not set,
2134             <code class="varname">MAKECONF</code> is set to
2135             <code class="filename">/dev/null</code> to avoid picking up
2136             settings used by builds in <code class="filename">/usr/src</code>.</p></li>
2137 <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
2138             By default, dependencies are only installed, and no binary
2139             package is created for them. You can set this variable to
2140             <code class="literal">package</code> to automatically create binary
2141             packages after installing dependencies.</p></li>
2142 </ul></div>
2143 </div>
2144 <div class="sect1" title="5.3. Variables affecting the installation process">
2145 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2146 <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
2147 <p>Most packages support installation into a
2148     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
2149     to be built, before the actual filesystem is touched. DESTDIR
2150     support exists in two variations:</p>
2151 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2152 <li class="listitem"><p>Basic DESTDIR support means that the package
2153       installation and packaging is still run as root.</p></li>
2154 <li class="listitem"><p>Full DESTDIR support can run the complete
2155       build, installation and packaging as normal user. Root
2156       privileges are only needed to add packages.</p></li>
2157 </ul></div>
2158 <p>DESTDIR support is now the default. To switch back to non-DESTDIR,
2159     you can set
2160     <code class="varname">USE_DESTDIR=no</code>; this setting will be deprecated though,
2161     so it's preferable to convert a package to DESTDIR instead.</p>
2162 <p>DESTDIR support changes the behaviour of various targets
2163     slightly. To install a package after building it, use
2164     <code class="literal">package-install</code>. <code class="literal">package</code> and
2165     <code class="literal">install</code> don't do that any
2166     longer. <code class="literal">package-install</code> can be used as
2167     <code class="varname">DEPENDS_TARGET</code>.  <code class="literal">bin-install</code>
2168     will ask for the root password to install the package and fail,
2169     <code class="literal">package-install</code> will ask again.</p>
2170 <p>With basic DESTDIR support, <strong class="userinput"><code>make
2171     clean</code></strong> needs to be run as root.</p>
2172 <p>Considering the <code class="filename">foo/bar</code> package,
2173     DESTDIR full support can be tested using the following commands
2174
2175 </p>
2176 <pre class="programlisting">
2177 <code class="prompt">$</code> id
2178 uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
2179 <code class="prompt">$</code> mkdir $HOME/packages
2180 <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
2181 </pre>
2182 <p>
2183
2184     Verify <code class="varname">DESTDIR</code> full support, no root privileges
2185     should be needed
2186
2187 </p>
2188 <pre class="programlisting">
2189 <code class="prompt">$</code> make USE_DESTDIR=yes install
2190 </pre>
2191 <p>
2192
2193     Create a package without root privileges
2194
2195 </p>
2196 <pre class="programlisting">
2197 <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package
2198 </pre>
2199 <p>
2200
2201     For the following command, you must be able to gain root
2202     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>
2203
2204 </p>
2205 <pre class="programlisting">
2206 <code class="prompt">$</code> make USE_DESTDIR=yes PACKAGES=$HOME/packages package-install
2207 </pre>
2208 <p>
2209
2210     Then, as a simple user
2211
2212 </p>
2213 <pre class="programlisting">
2214 <code class="prompt">$</code> make clean
2215 </pre>
2216 <p>
2217
2218     </p>
2219 </div>
2220 <div class="sect1" title="5.4. Selecting and configuring the compiler">
2221 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2222 <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
2223 <div class="sect2" title="5.4.1. Selecting the compiler">
2224 <div class="titlepage"><div><div><h3 class="title">
2225 <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
2226 <p>By default, pkgsrc will use GCC to build packages.  This may be
2227     overridden by setting the following variables in /etc/mk.conf:</p>
2228 <div class="variablelist"><dl>
2229 <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
2230 <dd>
2231 <p>This is a list of values specifying the chain of
2232           compilers to invoke when building packages.  Valid values
2233           are:</p>
2234 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2235 <li class="listitem"><p><code class="varname">distcc</code>:
2236             distributed C/C++ (chainable)</p></li>
2237 <li class="listitem"><p><code class="varname">ccache</code>:
2238             compiler cache (chainable)</p></li>
2239 <li class="listitem"><p><code class="varname">gcc</code>:
2240             GNU C/C++ Compiler</p></li>
2241 <li class="listitem"><p><code class="varname">mipspro</code>:
2242             Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
2243 <li class="listitem"><p><code class="varname">mipspro</code>:
2244             Silicon Graphics, Inc. MIPSpro (o32)</p></li>
2245 <li class="listitem"><p><code class="varname">sunpro</code>:
2246             Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
2247 </ul></div>
2248 <p>The default is
2249           <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
2250           <code class="varname">ccache</code> and/or
2251           <code class="varname">distcc</code> with an appropriate
2252           <code class="varname">PKGSRC_COMPILER</code> setting,
2253           e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
2254           variable should always be terminated with a value for
2255           a real compiler.  Note that only one real compiler
2256           should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
2257           is not allowed).</p>
2258 </dd>
2259 <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
2260 <dd><p>This specifies the minimum version of GCC to use
2261           when building packages.  If the system GCC doesn't
2262           satisfy this requirement, then pkgsrc will build and
2263           install one of the GCC packages to use instead.</p></dd>
2264 </dl></div>
2265 </div>
2266 <div class="sect2" title="5.4.2. Additional flags to the compiler (CFLAGS)">
2267 <div class="titlepage"><div><div><h3 class="title">
2268 <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
2269 <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
2270         please make sure to use the <code class="literal">+=</code> operator
2271         instead of the <code class="literal">=</code> operator:</p>
2272 <pre class="programlisting">
2273 CFLAGS+=        -your -flags
2274 </pre>
2275 <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
2276         <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
2277         need to add their own flags.  You may want to take a look
2278         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>
2279         package if you're interested in optimization specifically
2280         for the current CPU. </p>
2281 </div>
2282 <div class="sect2" title="5.4.3. Additional flags to the linker (LDFLAGS)">
2283 <div class="titlepage"><div><div><h3 class="title">
2284 <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
2285 <p>If you want to pass flags to the linker, both in the configure
2286 step and the build step, you can do this in two ways.  Either set
2287 <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
2288 between the two is that <code class="varname">LIBS</code> will be appended to
2289 the command line, while <code class="varname">LDFLAGS</code> come earlier.
2290 <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
2291 machines depending on the setting of <code class="varname">USE_IMAKE</code> or
2292 the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
2293 <code class="varname">CFLAGS</code>, if you do not wish to override these
2294 settings, use the <code class="literal">+=</code> operator:</p>
2295 <pre class="programlisting">
2296 LDFLAGS+=        -your -linkerflags
2297 </pre>
2298 </div>
2299 </div>
2300 <div class="sect1" title="5.5. Developer/advanced settings">
2301 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2302 <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
2303 <p>XXX
2304       </p>
2305 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2306 <li class="listitem">
2307 <p><code class="varname">PKG_DEVELOPER</code>:
2308             Run some sanity checks that package developers want:
2309             </p>
2310 <div class="itemizedlist"><ul class="itemizedlist" type="circle">
2311 <li class="listitem"><p>make sure patches apply with zero
2312               fuzz</p></li>
2313 <li class="listitem"><p>run check-shlibs to see that all
2314               binaries will find their shared libs.</p></li>
2315 </ul></div>
2316 <p>
2317         </p>
2318 </li>
2319 <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
2320         of debugging output which is displayed whilst making and
2321         installing the package.  The default value for this is 0,
2322         which will not display the commands as they are executed
2323         (normal, default, quiet operation); the value 1 will display
2324         all shell commands before their invocation, and the value 2
2325         will display both the shell commands before their invocation,
2326         and their actual execution progress with <span class="command"><strong>set
2327         -x</strong></span> will be displayed.</p></li>
2328 </ul></div>
2329 <p>
2330     </p>
2331 </div>
2332 <div class="sect1" title="5.6. Selecting Build Options">
2333 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2334 <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
2335 <p>Some packages have build time options, usually to select
2336     between different dependencies, enable optional support for big
2337     dependencies or enable experimental features.</p>
2338 <p>To see which options, if any, a package supports, and which
2339     options are mutually exclusive, run <span class="command"><strong>make
2340     show-options</strong></span>, for example:</p>
2341 <pre class="programlisting">
2342     The following options are supported by this package:
2343         ssl      Enable SSL support.
2344     Exactly one of the following gecko options is required:
2345         firefox  Use firefox as gecko rendering engine.
2346         mozilla  Use mozilla as gecko rendering engine.
2347     At most one of the following database options may be selected:
2348         mysql    Enable support for MySQL database.
2349         pgsql    Enable support for PostgreSQL database.
2350
2351     These options are enabled by default: firefox
2352     These options are currently enabled: mozilla ssl
2353 </pre>
2354 <p>The following variables can be defined in
2355     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
2356     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
2357     which can be used to select or disable options for all packages
2358     that support them, and
2359     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
2360     which can be used to select or disable options specifically for
2361     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
2362     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
2363     are disabled. A few examples:</p>
2364 <pre class="screen">
2365 <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>
2366 PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
2367 PKG_OPTIONS.kdebase=    debug -sasl
2368 PKG_OPTIONS.apache=     suexec </pre>
2369 <p>It is important to note that options that were specifically
2370     suggested by the package maintainer must be explicitly removed if
2371     you do not wish to include the option.  If you are unsure you can view
2372     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
2373 <p>The following settings are consulted in the order given, and
2374     the last setting that selects or disables an option is
2375     used:</p>
2376 <div class="orderedlist"><ol class="orderedlist" type="1">
2377 <li class="listitem"><p>the default options as suggested by the package
2378       maintainer</p></li>
2379 <li class="listitem"><p>the options implied by the settings of legacy
2380       variables (see below)</p></li>
2381 <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
2382 <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
2383 </ol></div>
2384 <p>For groups of mutually exclusive options, the last option
2385     selected is used, all others are automatically disabled.  If an
2386     option of the group is explicitly disabled, the previously
2387     selected option, if any, is used.  It is an error if no option
2388     from a required group of options is selected, and building the
2389     package will fail.</p>
2390 <p>Before the options framework was introduced, build options
2391     were selected by setting a variable (often named
2392     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
2393     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
2394     transition to the options framework for the user, these legacy
2395     variables are converted to the appropriate options setting
2396     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
2397     automatically.  A warning is issued to prompt the user to update
2398     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
2399     directly.  Support for the legacy variables will be removed
2400     eventually.</p>
2401 </div>
2402 </div>
2403 <div class="chapter" title="Chapter 6. Creating binary packages">
2404 <div class="titlepage"><div><div><h2 class="title">
2405 <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
2406 <div class="toc">
2407 <p><b>Table of Contents</b></p>
2408 <dl>
2409 <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
2410 <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
2411 </dl>
2412 </div>
2413 <div class="sect1" title="6.1. Building a single binary package">
2414 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2415 <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
2416 <p>Once you have built and installed a package, you can create
2417     a <span class="emphasis"><em>binary package</em></span> which can be installed on
2418     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
2419     the same package on a group of hosts and wasting CPU time. It also
2420     provides a simple means for others to install your package, should
2421     you distribute it.</p>
2422 <p>To create a binary package, change into the appropriate
2423     directory in pkgsrc, and run <span class="command"><strong>make
2424     package</strong></span>:</p>
2425 <pre class="screen">
2426 <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
2427 <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
2428     </pre>
2429 <p>This will build and install your package (if not already done),
2430     and then build a binary package from what was installed. You can
2431     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
2432     it. Binary packages are created by default in
2433     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
2434     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
2435     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>
2436 <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
2437     such a binary package.</p>
2438 </div>
2439 <div class="sect1" title="6.2. Settings for creation of binary packages">
2440 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2441 <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
2442 <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>
2443 </div>
2444 </div>
2445 <div class="chapter" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">
2446 <div class="titlepage"><div><div><h2 class="title">
2447 <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
2448 builds)</h2></div></div></div>
2449 <div class="toc">
2450 <p><b>Table of Contents</b></p>
2451 <dl>
2452 <dt><span class="sect1"><a href="#bulk.pre">7.1. Think first, build later</a></span></dt>
2453 <dt><span class="sect1"><a href="#bulk.req">7.2. Requirements of a bulk build</a></span></dt>
2454 <dt><span class="sect1"><a href="#bulk.old">7.3. Running an old-style bulk build</a></span></dt>
2455 <dd><dl>
2456 <dt><span class="sect2"><a href="#binary.configuration">7.3.1. Configuration</a></span></dt>
2457 <dt><span class="sect2"><a href="#other-environmental-considerations">7.3.2. Other environmental considerations</a></span></dt>
2458 <dt><span class="sect2"><a href="#operation">7.3.3. Operation</a></span></dt>
2459 <dt><span class="sect2"><a href="#what-it-does">7.3.4. What it does</a></span></dt>
2460 <dt><span class="sect2"><a href="#disk-space-requirements">7.3.5. Disk space requirements</a></span></dt>
2461 <dt><span class="sect2"><a href="#setting-up-a-sandbox">7.3.6. Setting up a sandbox for chrooted builds</a></span></dt>
2462 <dt><span class="sect2"><a href="#building-a-partial-set">7.3.7. Building a partial set of packages</a></span></dt>
2463 <dt><span class="sect2"><a href="#bulk-upload">7.3.8. Uploading results of a bulk build</a></span></dt>
2464 </dl></dd>
2465 <dt><span class="sect1"><a href="#bulk.pbulk">7.4. Running a pbulk-style bulk build</a></span></dt>
2466 <dd><dl>
2467 <dt><span class="sect2"><a href="#bulk.pbulk.prepare">7.4.1. Preparation</a></span></dt>
2468 <dt><span class="sect2"><a href="#bulk.pbulk.conf">7.4.2. Configuration</a></span></dt>
2469 </dl></dd>
2470 <dt><span class="sect1"><a href="#creating-cdroms">7.5. Creating a multiple CD-ROM packages collection</a></span></dt>
2471 <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.5.1. Example of cdpack</a></span></dt></dl></dd>
2472 </dl>
2473 </div>
2474 <p>When you have multiple machines that should run the same packages,
2475 it is wasted time if they all build their packages themselves from
2476 source. There are two ways of getting a set of binary packages: The old
2477 bulk build system, or the new (as of 2007) parallel bulk build (pbulk)
2478 system. This chapter describes how to set them up so that the packages
2479 are most likely to be usable later.</p>
2480 <div class="sect1" title="7.1. Think first, build later">
2481 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2482 <a name="bulk.pre"></a>7.1. Think first, build later</h2></div></div></div>
2483 <p>Since a bulk build takes several days or even weeks to finish, you
2484 should think about the setup before you start everything. Pay attention
2485 to at least the following points:</p>
2486 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2487 <li class="listitem">
2488 <p>If you want to upload the binary packages to
2489 ftp.NetBSD.org, make sure the setup complies to the requirements for binary
2490 packages:</p>
2491 <div class="itemizedlist"><ul class="itemizedlist" type="circle">
2492 <li class="listitem"><p>To end up on ftp.NetBSD.org, the packages must be built
2493 by a NetBSD developer on a trusted machine (that is, where you and only
2494 you have root access).</p></li>
2495 <li class="listitem"><p>Packages on ftp.NetBSD.org should only be created from
2496 the stable branches (like 2009Q1), so that users browsing the available
2497 collections can see at a glance how old the packages
2498 are.</p></li>
2499 <li class="listitem"><p>The packages must be built as root, since some packages
2500 require set-uid binaries at runtime, and creating those packages as
2501 unprivileged user doesn't work well at the moment.</p></li>
2502 </ul></div>
2503 </li>
2504 <li class="listitem"><p>Make sure that the bulk build cannot break anything in
2505 your system. Most bulk builds run as root, so they should be run at least
2506 in a chroot environment or something even more restrictive, depending on
2507 what the operating system provides. There have been numerous cases where
2508 certain packages tried to install files outside the
2509 <code class="filename">LOCALBASE</code> or wanted to edit some files in
2510 <code class="filename">/etc</code>. Furthermore, the bulk builds install and
2511 deinstall packages in <code class="filename">/usr/pkg</code> (or whatever
2512 <code class="filename">LOCALBASE</code> is) during their operation, so be sure
2513 that you don't need any package during the build.</p></li>
2514 </ul></div>
2515 </div>
2516 <div class="sect1" title="7.2. Requirements of a bulk build">
2517 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2518 <a name="bulk.req"></a>7.2. Requirements of a bulk build</h2></div></div></div>
2519 <p>A complete bulk build requires lots of disk space. Some of the
2520 disk space can be read-only, some other must be writable. Some can be on
2521 remote filesystems (such as NFS) and some should be local. Some can be
2522 temporary filesystems, others must survive a sudden reboot.</p>
2523 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2524 <li class="listitem"><p>10 GB for the distfiles (read-write, remote, temporary)</p></li>
2525 <li class="listitem"><p>10 GB for the binary packages (read-write, remote, permanent)</p></li>
2526 <li class="listitem"><p>400 MB for the pkgsrc tree (read-only, remote, permanent)</p></li>
2527 <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary for pbulk, permanent for old-bulk)</p></li>
2528 <li class="listitem"><p>5 GB for the log files (read-write, remote, permanent)</p></li>
2529 <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
2530 </ul></div>
2531 </div>
2532 <div class="sect1" title="7.3. Running an old-style bulk build">
2533 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2534 <a name="bulk.old"></a>7.3. Running an old-style bulk build</h2></div></div></div>
2535 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
2536 <h3 class="title">Note</h3>
2537 <p>There are two ways of doing a bulk build. The old-style
2538 one and the new-style <span class="quote">&#8220;<span class="quote">pbulk</span>&#8221;</span>. The latter is the recommended
2539 way.</p>
2540 </div>
2541 <div class="sect2" title="7.3.1. Configuration">
2542 <div class="titlepage"><div><div><h3 class="title">
2543 <a name="binary.configuration"></a>7.3.1. Configuration</h3></div></div></div>
2544 <div class="sect3" title="7.3.1.1. build.conf">
2545 <div class="titlepage"><div><div><h4 class="title">
2546 <a name="binary.bulk.build.conf"></a>7.3.1.1. <code class="filename">build.conf</code>
2547 </h4></div></div></div>
2548 <p>The <code class="filename">build.conf</code> file is the main
2549         configuration file for bulk builds. You can configure how your
2550         copy of pkgsrc is kept up to date, how the distfiles are
2551         downloaded, how the packages are built and how the report is
2552         generated. You can find an annotated example file in
2553         <code class="filename">pkgsrc/mk/bulk/build.conf-example</code>. To use
2554         it, copy <code class="filename">build.conf-example</code> to
2555         <code class="filename">build.conf</code> and edit it, following the
2556         comments in that file.</p>
2557 </div>
2558 <div class="sect3" title="7.3.1.2. mk.conf">
2559 <div class="titlepage"><div><div><h4 class="title">
2560 <a name="binary.mk.conf"></a>7.3.1.2. <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
2561 </h4></div></div></div>
2562 <p>You may want to set variables in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
2563         Look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for
2564         details of the default settings. You will want to ensure that
2565         <code class="varname">ACCEPTABLE_LICENSES</code> meet your local policy.
2566         As used in this example, <code class="varname">SKIP_LICENSE_CHECK=yes</code>
2567         completely bypasses the license check.</p>
2568 <pre class="programlisting">
2569 PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
2570 WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
2571 BSDSRCDIR=      /usr/src
2572 BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
2573 OBJHOSTNAME?=   yes               # use work.`hostname`
2574 FAILOVER_FETCH= yes               # insist on the correct checksum
2575 PKG_DEVELOPER?= yes
2576 SKIP_LICENSE_CHECK=    yes
2577 </pre>
2578 <p>Some options that are especially useful for bulk builds
2579         can be found at the top lines of the file
2580         <code class="filename">mk/bulk/bsd.bulk-pkg.mk</code>. The most useful
2581         options of these are briefly described here.</p>
2582 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2583 <li class="listitem"><p>If you are on a slow machine, you may want to
2584           set <code class="varname">USE_BULK_BROKEN_CHECK</code> to
2585           <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.</p></li>
2586 <li class="listitem"><p>If you are doing bulk builds from a read-only
2587           copy of pkgsrc, you have to set <code class="varname">BULKFILESDIR</code>
2588           to the directory where all log files are created. Otherwise the
2589           log files are created in the pkgsrc directory.</p></li>
2590 <li class="listitem"><p>Another important variable is
2591           <code class="varname">BULK_PREREQ</code>, which is a list of packages that
2592           should be always available while building other
2593           packages.</p></li>
2594 </ul></div>
2595 <p>Some other options are scattered in the pkgsrc
2596         infrastructure:</p>
2597 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2598 <li class="listitem"><p><code class="varname">ALLOW_VULNERABLE_PACKAGES</code>
2599           should be set to <code class="literal">yes</code>. The purpose of the
2600           bulk builds is creating binary packages, no matter if they
2601           are vulnerable or not. Leaving this variable unset would
2602           prevent the bulk build system from even trying to build
2603           them, so possible building errors would not show
2604           up.</p></li>
2605 <li class="listitem"><p><code class="varname">CHECK_FILES</code>
2606           (<code class="filename">pkgsrc/mk/check/check-files.mk</code>) can be set to
2607           <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed set of files
2608           matches the <code class="filename">PLIST</code>.</p></li>
2609 <li class="listitem"><p><code class="varname">CHECK_INTERPRETER</code>
2610           (<code class="filename">pkgsrc/mk/check/check-interpreter.mk</code>) can be set to
2611           <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> to check that the installed
2612           <span class="quote">&#8220;<span class="quote">#!</span>&#8221;</span>-scripts will find their
2613           interpreter.</p></li>
2614 <li class="listitem"><p><code class="varname">PKGSRC_RUN_TEST</code> can be
2615           set to <span class="quote">&#8220;<span class="quote"><code class="literal">yes</code></span>&#8221;</span> to run each
2616           package's self-test before installing it. Note that some
2617           packages make heavy use of <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> random
2618           numbers, so you need to assure that the machine on which you
2619           are doing the bulk builds is not completely idle. Otherwise
2620           some test programs will seem to hang, while they are just
2621           waiting for new random data to be
2622           available.</p></li>
2623 </ul></div>
2624 </div>
2625 <div class="sect3" title="7.3.1.3. pre-build.local">
2626 <div class="titlepage"><div><div><h4 class="title">
2627 <a name="pre-build.local"></a>7.3.1.3. <code class="filename">pre-build.local</code>
2628 </h4></div></div></div>
2629 <p>It is possible to configure the bulk build to perform
2630         certain site-specific tasks at the end of the pre-build
2631         stage.  If the file
2632         <code class="filename">pre-build.local</code> exists in
2633         <code class="filename">/usr/pkgsrc/mk/bulk</code>, it will be executed
2634         (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
2635         stage.  An example use of
2636         <code class="filename">pre-build.local</code> is to have the line:</p>
2637 <pre class="screen">echo "I do not have enough disk space to build this pig." \
2638         &gt; misc/openoffice/$BROKENF</pre>
2639 <p>to prevent the system from trying to build a particular package
2640         which requires nearly 3 GB of disk space.</p>
2641 </div>
2642 </div>
2643 <div class="sect2" title="7.3.2. Other environmental considerations">
2644 <div class="titlepage"><div><div><h3 class="title">
2645 <a name="other-environmental-considerations"></a>7.3.2. Other environmental considerations</h3></div></div></div>
2646 <p>As <code class="filename">/usr/pkg</code> will be completely
2647       deleted at the start of bulk builds, make sure your login
2648       shell is placed somewhere else. Either drop it into
2649       <code class="filename">/usr/local/bin</code> (and adjust your login
2650       shell in the passwd file), or (re-)install it via
2651       <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
2652       you can login after a reboot (remember that your current
2653       process won't die if the package is removed, you just can't
2654       start any new instances of the shell any more).  Also, if you
2655       use NetBSD earlier than 1.5, or you still want to use the pkgsrc
2656       version of ssh for some reason, be sure to install ssh before
2657       starting it from <code class="filename">rc.local</code>:</p>
2658 <pre class="programlisting">
2659 (cd /usr/pkgsrc/security/ssh &amp;&amp; make bulk-install)
2660 if [ -f /usr/pkg/etc/rc.d/sshd ]; then
2661   /usr/pkg/etc/rc.d/sshd
2662 fi
2663 </pre>
2664 <p>Not doing so will result in you being not able to log in
2665       via ssh after the bulk build is finished or if the machine
2666       gets rebooted or crashes. You have been warned! :)</p>
2667 </div>
2668 <div class="sect2" title="7.3.3. Operation">
2669 <div class="titlepage"><div><div><h3 class="title">
2670 <a name="operation"></a>7.3.3. Operation</h3></div></div></div>
2671 <p>Make sure you don't need any of the packages still
2672       installed.</p>
2673 <div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2674 <h3 class="title">Warning</h3>
2675 <p>During the bulk build, <span class="emphasis"><em>all packages, their
2676         configuration files and some more files from
2677         <code class="filename">/var</code>, <code class="filename">/home</code> and
2678         possibly other locations will be removed! So don't run a bulk
2679         build with privileges that might harm your
2680         system.</em></span></p>
2681 </div>
2682 <p>Be sure to remove all other things that might
2683       interfere with builds, like some libs installed in
2684       <code class="filename">/usr/local</code>, etc. then become root and type:</p>
2685 <pre class="screen">
2686 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2687 <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build</code></strong>
2688       </pre>
2689 <p>If for some reason your last build didn't complete (power
2690       failure, system panic, ...), you can continue it by
2691       running:</p>
2692 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/build restart</code></strong></pre>
2693 <p>At the end of the bulk build, you will get a summary via mail,
2694       and find build logs in the directory specified by
2695       <code class="varname">FTP</code> in the <code class="filename">build.conf</code>
2696       file.</p>
2697 </div>
2698 <div class="sect2" title="7.3.4. What it does">
2699 <div class="titlepage"><div><div><h3 class="title">
2700 <a name="what-it-does"></a>7.3.4. What it does</h3></div></div></div>
2701 <p>The bulk builds consist of three steps:</p>
2702 <div class="variablelist"><dl>
2703 <dt><span class="term">1. pre-build</span></dt>
2704 <dd><p>The script updates your pkgsrc tree via (anon)cvs, then
2705             cleans out any broken distfiles, and removes all
2706             packages installed.</p></dd>
2707 <dt><span class="term">2. the bulk build</span></dt>
2708 <dd><p>This is basically <span class="quote">&#8220;<span class="quote">make bulk-package</span>&#8221;</span> with
2709             an optimised order in which packages will be
2710             built. Packages that don't require other packages will
2711             be built first, and packages with many dependencies will
2712             be built later.</p></dd>
2713 <dt><span class="term">3. post-build</span></dt>
2714 <dd><p>Generates a report that's placed in the directory
2715             specified in the <code class="filename">build.conf</code> file
2716             named <code class="filename">broken.html</code>, a short version
2717             of that report will also be mailed to the build's
2718             admin.</p></dd>
2719 </dl></div>
2720 <p>During the build, a list of broken packages will be compiled
2721       in <code class="filename">/usr/pkgsrc/.broken</code> (or
2722       <code class="filename">.../.broken.${MACHINE}</code> if
2723       <code class="varname">OBJMACHINE</code> is set), individual build logs
2724       of broken builds can be found in the package's
2725       directory. These files are used by the bulk-targets to mark
2726       broken builds to not waste time trying to rebuild them, and
2727       they can be used to debug these broken package builds
2728       later.</p>
2729 </div>
2730 <div class="sect2" title="7.3.5. Disk space requirements">
2731 <div class="titlepage"><div><div><h3 class="title">
2732 <a name="disk-space-requirements"></a>7.3.5. Disk space requirements</h3></div></div></div>
2733 <p>Currently, roughly the following requirements are valid for
2734       NetBSD 2.0/i386:</p>
2735 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2736 <li class="listitem"><p>10 GB - distfiles (NFS ok)</p></li>
2737 <li class="listitem"><p>8 GB - full set of all binaries (NFS ok)</p></li>
2738 <li class="listitem"><p>5 GB - temp space for compiling (local disk recommended)</p></li>
2739 </ul></div>
2740 <p>Note that all pkgs will be de-installed as soon as they are
2741       turned into a binary package, and that sources are removed,
2742       so there is no excessively huge demand to disk
2743       space. Afterwards, if the package is needed again, it will
2744       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
2745       there are no cycles wasted by recompiling.</p>
2746 </div>
2747 <div class="sect2" title="7.3.6. Setting up a sandbox for chrooted builds">
2748 <div class="titlepage"><div><div><h3 class="title">
2749 <a name="setting-up-a-sandbox"></a>7.3.6. Setting up a sandbox for chrooted builds</h3></div></div></div>
2750 <p>If you don't want all the packages nuked from a machine
2751       (rendering it useless for anything but pkg compiling), there
2752       is the possibility of doing the package bulk build inside a
2753       chroot environment.</p>
2754 <p>The first step is to set up a chroot sandbox,
2755       e.g. <code class="filename">/usr/sandbox</code>.  This can be done by
2756       using null mounts, or manually.</p>
2757 <p>There is a shell script called
2758       <code class="filename">pkgsrc/mk/bulk/mksandbox</code> which will set
2759       up the sandbox environment using null mounts. It will also
2760       create a script called <code class="filename">sandbox</code> in the
2761       root of the sandbox environment, which will allow the null
2762       mounts to be activated using the <span class="command"><strong>sandbox
2763       mount</strong></span> command and deactivated using the
2764       <span class="command"><strong>sandbox umount</strong></span> command.</p>
2765 <p>To set up a sandbox environment by hand, after extracting all
2766       the sets from a NetBSD installation or doing a <span class="command"><strong>make
2767       distribution DESTDIR=/usr/sandbox</strong></span> in
2768       <code class="filename">/usr/src/etc</code>, be sure the following items
2769       are present and properly configured:</p>
2770 <div class="procedure"><ol class="procedure" type="1">
2771 <li class="step" title="Step 1">
2772 <p>Kernel</p>
2773 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /netbsd /usr/sandbox</code></strong></pre>
2774 </li>
2775 <li class="step" title="Step 2">
2776 <p><code class="filename">/dev/*</code></p>
2777 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/dev ; sh MAKEDEV all</code></strong></pre>
2778 </li>
2779 <li class="step" title="Step 3">
2780 <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>
2781 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/resolv.conf /usr/sandbox/etc</code></strong></pre>
2782 </li>
2783 <li class="step" title="Step 4">
2784 <p>Working(!) mail config (hostname, sendmail.cf):</p>
2785 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cp /etc/mail/sendmail.cf /usr/sandbox/etc/mail</code></strong></pre>
2786 </li>
2787 <li class="step" title="Step 5">
2788 <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>
2789 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</code></strong></pre>
2790 </li>
2791 <li class="step" title="Step 6">
2792 <p><code class="filename">/usr/src</code> (system sources,
2793           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>
2794 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>ln -s ../disk1/cvs .</code></strong>
2795           <code class="prompt">#</code> <strong class="userinput"><code>ln -s cvs/src-2.0 src</code></strong></pre>
2796 </li>
2797 <li class="step" title="Step 7">
2798 <p>Create <code class="filename">/var/db/pkg</code> (not part of default install):</p>
2799 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/var/db/pkg</code></strong></pre>
2800 </li>
2801 <li class="step" title="Step 8">
2802 <p>Create <code class="filename">/usr/pkg</code> (not part of default install):</p>
2803 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>mkdir /usr/sandbox/usr/pkg</code></strong></pre>
2804 </li>
2805 <li class="step" title="Step 9">
2806 <p>Checkout pkgsrc via cvs into
2807           <code class="filename">/usr/sandbox/usr/pkgsrc</code>:</p>
2808 <pre class="screen">
2809 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr</code></strong>
2810 <code class="prompt">#</code> <strong class="userinput"><code>cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -d -P pkgsrc</code></strong>
2811           </pre>
2812 <p>Do not mount/link this to the copy of your pkgsrc tree
2813           you do development in, as this will likely cause problems!</p>
2814 </li>
2815 <li class="step" title="Step 10"><p>Make
2816           <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code> and
2817           <code class="filename">.../distfiles</code> point somewhere
2818           appropriate. NFS- and/or nullfs-mounts may come in handy!</p></li>
2819 <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>
2820 <li class="step" title="Step 12"><p>Adjust <code class="filename">mk/bulk/build.conf</code> to suit your needs.</p></li>
2821 </ol></div>
2822 <p>When the chroot sandbox is set up, you can start
2823       the build with the following steps:</p>
2824 <pre class="screen">
2825 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2826 <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-build</code></strong>
2827       </pre>
2828 <p>This will just jump inside the sandbox and start building.  At
2829         the end of the build, mail will be sent with the results of
2830         the build. Created binary pkgs will be in
2831         <code class="filename">/usr/sandbox/usr/pkgsrc/packages</code>
2832       (wherever that points/mounts to/from).</p>
2833 </div>
2834 <div class="sect2" title="7.3.7. Building a partial set of packages">
2835 <div class="titlepage"><div><div><h3 class="title">
2836 <a name="building-a-partial-set"></a>7.3.7. Building a partial set of packages</h3></div></div></div>
2837 <p>In addition to building a complete set of all packages in
2838       pkgsrc, the <code class="filename">pkgsrc/mk/bulk/build</code> script
2839       may be used to build a subset of the packages contained in
2840       pkgsrc.  By setting <code class="varname">SPECIFIC_PKGS</code>
2841       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the variables</p>
2842 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2843 <li class="listitem"><p>SITE_SPECIFIC_PKGS</p></li>
2844 <li class="listitem"><p>HOST_SPECIFIC_PKGS</p></li>
2845 <li class="listitem"><p>GROUP_SPECIFIC_PKGS</p></li>
2846 <li class="listitem"><p>USER_SPECIFIC_PKGS</p></li>
2847 </ul></div>
2848 <p>will define the set of packages which should be built.
2849       The bulk build code will also include any packages which are
2850       needed as dependencies for the explicitly listed packages.</p>
2851 <p>One use of this is to do a bulk build with
2852       <code class="varname">SPECIFIC_PKGS</code> in a chroot sandbox
2853       periodically to have a complete set of the binary packages
2854       needed for your site available without the overhead of
2855       building extra packages that are not needed.</p>
2856 </div>
2857 <div class="sect2" title="7.3.8. Uploading results of a bulk build">
2858 <div class="titlepage"><div><div><h3 class="title">
2859 <a name="bulk-upload"></a>7.3.8. Uploading results of a bulk build</h3></div></div></div>
2860 <p>This section describes how pkgsrc developers can upload binary
2861       pkgs built by bulk builds to ftp.NetBSD.org.</p>
2862 <p>If you would like to automatically create checksum files for the
2863       binary packages you intend to upload, remember to set
2864       <code class="varname">MKSUMS=yes</code> in your
2865       <code class="filename">mk/bulk/build.conf</code>.</p>
2866 <p>If you would like to PGP sign the checksum files (highly
2867       recommended!), remember to set
2868       <code class="varname">SIGN_AS=username@NetBSD.org</code> in your
2869       <code class="filename">mk/bulk/build.conf</code>.  This will prompt you for
2870       your GPG password to sign the files before uploading everything.</p>
2871 <p>Then, make sure that you have <code class="varname">RSYNC_DST</code>
2872       set properly in your <code class="filename">mk/bulk/build.conf</code>
2873       file, i.e. adjust it to something like one of the following:</p>
2874 <pre class="screen">RSYNC_DST=ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
2875 <p>Please use appropriate values for "20xxQy" (the branch),
2876       "a.b.c" (the OS version) and "arch" here. If your login on ftp.NetBSD.org
2877       is different from your local login, write your login directly
2878       into the variable, e.g. my local account is "feyrer", but for my
2879       login "hubertf", I use:</p>
2880 <pre class="screen">RSYNC_DST=hubertf@ftp.NetBSD.org:/pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</pre>
2881 <p>A separate <code class="filename">upload</code> directory is used
2882       here to allow "closing" the directory during upload. To do
2883       so, run the following command on ftp.NetBSD.org next:</p>
2884 <pre class="screen">nbftp% <strong class="userinput"><code>mkdir -p -m 750 /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy/upload</code></strong></pre>
2885 <p>Before uploading the binary pkgs, ssh authentication needs
2886       to be set up. This example shows how to set up temporary keys
2887       for the root account <span class="emphasis"><em>inside the sandbox</em></span>
2888       (assuming that no keys should be present there usually):</p>
2889 <pre class="screen">
2890 <code class="prompt">#</code> <strong class="userinput"><code>chroot /usr/sandbox</code></strong>
2891 chroot-<code class="prompt">#</code> <strong class="userinput"><code>rm $HOME/.ssh/id-dsa*</code></strong>
2892 chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh-keygen -t rsa</code></strong>
2893 chroot-<code class="prompt">#</code> <strong class="userinput"><code>cat $HOME/.ssh/id-rsa.pub</code></strong>
2894       </pre>
2895 <p>Now take the output of <code class="filename">id-rsa.pub</code> and
2896       append it to your <code class="filename">~/.ssh/authorized_keys</code>
2897       file on ftp.NetBSD.org. You should remove the key after the
2898       upload is done!</p>
2899 <p>Next, test if your ssh connection really works:</p>
2900 <pre class="screen">chroot-<code class="prompt">#</code> <strong class="userinput"><code>ssh ftp.NetBSD.org date</code></strong> </pre>
2901 <p>Use "-l yourNetBSDlogin" here as appropriate!</p>
2902 <p>Now after all this works, you can exit the sandbox and start
2903       the upload:</p>
2904 <pre class="screen">
2905 chroot-<code class="prompt">#</code> <strong class="userinput"><code>exit</code></strong>
2906 <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sandbox/usr/pkgsrc</code></strong>
2907 <code class="prompt">#</code> <strong class="userinput"><code>sh mk/bulk/do-sandbox-upload</code></strong>
2908       </pre>
2909 <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
2910       <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
2911       upload. The upload script will take care of not uploading
2912       restricted packages.</p>
2913 <p>After the upload has ended, first thing is to revoke ssh access:</p>
2914 <pre class="screen">nbftp% <strong class="userinput"><code>vi ~/.ssh/authorized_keys</code></strong>
2915       Gdd:x! </pre>
2916 <p>Use whatever is needed to remove the key you've entered
2917       before! Last, move the uploaded packages out of the
2918       <code class="filename">upload</code> directory to have them accessible
2919       to everyone:</p>
2920 <pre class="screen">
2921 nbftp% <strong class="userinput"><code>cd /pub/pkgsrc/packages/NetBSD/arch/a.b.c-20xxQy</code></strong>
2922 nbftp% <strong class="userinput"><code>mv upload/* .</code></strong>
2923 nbftp% <strong class="userinput"><code>rmdir upload</code></strong>
2924 nbftp% <strong class="userinput"><code>chgrp -R netbsd .</code></strong>
2925 nbftp% <strong class="userinput"><code>find . -type d | xargs chmod 775</code></strong>
2926       </pre>
2927 </div>
2928 </div>
2929 <div class="sect1" title="7.4. Running a pbulk-style bulk build">
2930 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2931 <a name="bulk.pbulk"></a>7.4. Running a pbulk-style bulk build</h2></div></div></div>
2932 <p>Running a pbulk-style bulk build works roughly as follows:</p>
2933 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2934 <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
2935 <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
2936 </ul></div>
2937 <div class="sect2" title="7.4.1. Preparation">
2938 <div class="titlepage"><div><div><h3 class="title">
2939 <a name="bulk.pbulk.prepare"></a>7.4.1. Preparation</h3></div></div></div>
2940 <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>
2941 <pre class="screen">
2942 $ <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
2943 $ <strong class="userinput"><code>./bootstrap/bootstrap --prefix=/usr/pbulk --varbase=/usr/pbulk/var --workdir=/tmp/pbulk-bootstrap</code></strong>
2944 $ <strong class="userinput"><code>rm -rf /tmp/pbulk-bootstrap</code></strong>
2945 </pre>
2946 <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>
2947 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
2948 <li class="listitem"><p><code class="literal"><code class="varname">PKG_DEVELOPER</code>=yes</code>, to enable many consistency checks,</p></li>
2949 <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>
2950 <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>
2951 <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>
2952 <li class="listitem"><p><code class="literal"><code class="varname">SKIP_LICENSE_CHECK</code>=yes</code>, to bypass the license checks.</p></li>
2953 </ul></div>
2954 <p>Now you are ready to build the rest of the pbulk infrastructure.</p>
2955 <pre class="screen">
2956 $ <strong class="userinput"><code>cd pkgtools/pbulk</code></strong>
2957 $ <strong class="userinput"><code>/usr/pbulk/bin/bmake install</code></strong>
2958 $ <strong class="userinput"><code>rm -rf /tmp/pbulk-outer</code></strong>
2959 </pre>
2960 <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>
2961 </div>
2962 <div class="sect2" title="7.4.2. Configuration">
2963 <div class="titlepage"><div><div><h3 class="title">
2964 <a name="bulk.pbulk.conf"></a>7.4.2. Configuration</h3></div></div></div>
2965 <p>TODO; see pkgsrc/doc/HOWTO-pbulk for more information.</p>
2966 <p>TODO: continue writing</p>
2967 </div>
2968 </div>
2969 <div class="sect1" title="7.5. Creating a multiple CD-ROM packages collection">
2970 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
2971 <a name="creating-cdroms"></a>7.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
2972 <p>After your pkgsrc bulk-build has completed, you may wish to
2973     create a CD-ROM set of the resulting binary packages to assist
2974     in installing packages on other machines.  The
2975     <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
2976     a simple tool for creating the ISO 9660 images.
2977     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
2978     way that keeps all the dependencies for a given package on the same
2979     CD as that package.</p>
2980 <div class="sect2" title="7.5.1. Example of cdpack">
2981 <div class="titlepage"><div><div><h3 class="title">
2982 <a name="cdpack-example"></a>7.5.1. Example of cdpack</h3></div></div></div>
2983 <p>Complete documentation for cdpack is found in the cdpack(1)
2984       man page. The following short example assumes that the binary
2985       packages are left in
2986       <code class="filename">/usr/pkgsrc/packages/All</code> and that
2987       sufficient disk space exists in <code class="filename">/u2</code> to
2988       hold the ISO 9660 images.</p>
2989 <pre class="screen">
2990 <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
2991 <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
2992 <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
2993       </pre>
2994 <p>If you wish to include a common set of files
2995       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
2996       etc.) on each CD in the collection, then you need to create a
2997       directory which contains these files. e.g.</p>
2998 <pre class="screen">
2999 <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
3000 <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
3001 <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
3002 <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
3003 <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
3004 <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
3005 <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
3006       </pre>
3007 <p>Now create the images:</p>
3008 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
3009 <p>Each image will contain <code class="filename">README</code>,
3010       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
3011       in their root directories.</p>
3012 </div>
3013 </div>
3014 </div>
3015 <div class="chapter" title="Chapter 8. Directory layout of the installed files">
3016 <div class="titlepage"><div><div><h2 class="title">
3017 <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
3018 <div class="toc">
3019 <p><b>Table of Contents</b></p>
3020 <dl>
3021 <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
3022 <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
3023 </dl>
3024 </div>
3025 <p>The files that are installed by pkgsrc are organized in a way that
3026 is similar to what you find in the <code class="filename">/usr</code> directory
3027 of the base system. But some details are different. This is because
3028 pkgsrc initially came from FreeBSD and had adopted its file system
3029 hierarchy. Later it was largely influenced by NetBSD. But no matter
3030 which operating system you are using pkgsrc with, you can expect the
3031 same layout for pkgsrc.</p>
3032 <p>There are mainly four root directories for pkgsrc, which are all
3033 configurable in the <code class="filename">bootstrap/bootstrap</code> script.
3034 When pkgsrc has been installed as root, the default locations
3035 are:</p>
3036 <pre class="programlisting">
3037 LOCALBASE=              /usr/pkg
3038 PKG_SYSCONFBASE=        /usr/pkg/etc
3039 VARBASE=                /var
3040 PKG_DBDIR=              /var/db/pkg
3041 </pre>
3042 <p>In unprivileged mode (when pkgsrc has been installed as any other
3043 user), the default locations are:</p>
3044 <pre class="programlisting">
3045 LOCALBASE=              ${HOME}/pkg
3046 PKG_SYSCONFBASE=        ${HOME}/pkg/etc
3047 VARBASE=                ${HOME}/pkg/var
3048 PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
3049 </pre>
3050 <p>What these four directories are for, and what they look like is
3051 explained below.</p>
3052 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3053 <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
3054 <code class="filename">/usr</code> directory in the base system. It is the
3055 <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
3056 the well-known subdirectories like <code class="filename">bin</code>,
3057 <code class="filename">include</code>, <code class="filename">lib</code>,
3058 <code class="filename">share</code> and
3059 <code class="filename">sbin</code>.</p></li>
3060 <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
3061 <code class="filename">/var</code> in the base system. Some programs (especially
3062 games, network daemons) need write access to it during normal
3063 operation.</p></li>
3064 <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
3065 <code class="filename">/etc</code> in the base system. It contains configuration
3066 files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
3067 itself.</p></li>
3068 </ul></div>
3069 <div class="sect1" title="8.1. File system layout in ${LOCALBASE}">
3070 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3071 <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
3072 </h2></div></div></div>
3073 <p>The following directories exist in a typical pkgsrc installation
3074 in <code class="filename">${LOCALBASE}</code>.</p>
3075 <div class="variablelist"><dl>
3076 <dt><span class="term"><code class="filename">bin</code></span></dt>
3077 <dd><p>Contains executable programs that are intended to be
3078 directly used by the end user.</p></dd>
3079 <dt><span class="term"><code class="filename">emul</code></span></dt>
3080 <dd><p>Contains files for the emulation layers of various other
3081 operating systems, especially for
3082 NetBSD.</p></dd>
3083 <dt><span class="term"><code class="filename">etc</code> (the usual location of
3084 <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
3085 <dd><p>Contains
3086 the configuration files.</p></dd>
3087 <dt><span class="term"><code class="filename">include</code></span></dt>
3088 <dd><p>Contains headers for the C and C++ programming
3089 languages.</p></dd>
3090 <dt><span class="term"><code class="filename">info</code></span></dt>
3091 <dd><p>Contains GNU info files of various
3092 packages.</p></dd>
3093 <dt><span class="term"><code class="filename">lib</code></span></dt>
3094 <dd><p>Contains shared and static
3095 libraries.</p></dd>
3096 <dt><span class="term"><code class="filename">libdata</code></span></dt>
3097 <dd><p>Contains data files that don't change after
3098 installation. Other data files belong into
3099 <code class="filename">${VARBASE}</code>.</p></dd>
3100 <dt><span class="term"><code class="filename">libexec</code></span></dt>
3101 <dd><p>Contains programs that are not intended to be used by
3102 end users, such as helper programs or network
3103 daemons.</p></dd>
3104 <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
3105 <dd><p>Contains programs that are intended to be executed as
3106 CGI scripts by a web server.</p></dd>
3107 <dt><span class="term"><code class="filename">man</code> (the usual value of
3108 <code class="filename">${PKGMANDIR}</code>)</span></dt>
3109 <dd><p>Contains brief
3110 documentation in form of manual pages.</p></dd>
3111 <dt><span class="term"><code class="filename">sbin</code></span></dt>
3112 <dd><p>Contains programs that are intended to be used only by
3113 the super-user.</p></dd>
3114 <dt><span class="term"><code class="filename">share</code></span></dt>
3115 <dd><p>Contains platform-independent data files that don't
3116 change after installation.</p></dd>
3117 <dt><span class="term"><code class="filename">share/doc</code></span></dt>
3118 <dd><p>Contains documentation files provided by the
3119 packages.</p></dd>
3120 <dt><span class="term"><code class="filename">share/examples</code></span></dt>
3121 <dd><p>Contains example files provided by the packages. Among
3122 others, the original configuration files are saved here and copied to
3123 <code class="filename">${PKG_SYSCONFDIR}</code> during
3124 installation.</p></dd>
3125 <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
3126 <dd><p>Contains the original files for rc.d
3127 scripts.</p></dd>
3128 <dt><span class="term"><code class="filename">var</code> (the usual location of
3129 <code class="filename">${VARBASE}</code>)</span></dt>
3130 <dd><p>Contains files
3131 that may be modified after
3132 installation.</p></dd>
3133 </dl></div>
3134 </div>
3135 <div class="sect1" title="8.2. File system layout in ${VARBASE}">
3136 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3137 <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
3138 </h2></div></div></div>
3139 <div class="variablelist"><dl>
3140 <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
3141 <code class="filename">${PKG_DBDIR}</code>)</span></dt>
3142 <dd><p>Contains
3143 information about the currently installed
3144 packages.</p></dd>
3145 <dt><span class="term"><code class="filename">games</code></span></dt>
3146 <dd><p>Contains highscore
3147 files.</p></dd>
3148 <dt><span class="term"><code class="filename">log</code></span></dt>
3149 <dd><p>Contains log files.</p></dd>
3150 <dt><span class="term"><code class="filename">run</code></span></dt>
3151 <dd><p>Contains informational files about daemons that are
3152 currently running.</p></dd>
3153 </dl></div>
3154 </div>
3155 </div>
3156 <div class="chapter" title="Chapter 9. Frequently Asked Questions">
3157 <div class="titlepage"><div><div><h2 class="title">
3158 <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
3159 <div class="toc">
3160 <p><b>Table of Contents</b></p>
3161 <dl>
3162 <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
3163 <dt><span class="sect1"><a href="#pkgviews-docs">9.2. Where's the pkgviews documentation?</a></span></dt>
3164 <dt><span class="sect1"><a href="#faq-pkgtools">9.3. Utilities for package management (pkgtools)</a></span></dt>
3165 <dt><span class="sect1"><a href="#non-root-pkgsrc">9.4. How to use pkgsrc as non-root</a></span></dt>
3166 <dt><span class="sect1"><a href="#resume-transfers">9.5. How to resume transfers when fetching distfiles?</a></span></dt>
3167 <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>
3168 <dt><span class="sect1"><a href="#fetch-behind-firewall">9.7. How to fetch files from behind a firewall</a></span></dt>
3169 <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>
3170 <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
3171 <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
3172 /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
3173 <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>
3174 <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
3175 <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
3176 <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
3177 <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
3178 <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
3179 <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>
3180 </dl>
3181 </div>
3182 <p>This section contains hints, tips &amp; tricks on special things in
3183 pkgsrc that we didn't find a better place for in the previous chapters, and
3184 it contains items for both pkgsrc users and developers.</p>
3185 <div class="sect1" title="9.1. Are there any mailing lists for pkg-related discussion?">
3186 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3187 <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
3188 <p>The following mailing lists may be of interest to pkgsrc users:</p>
3189 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3190 <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
3191           This is a general purpose list for most issues regarding
3192           pkgsrc, regardless of platform, e.g. soliciting user help
3193           for pkgsrc configuration, unexpected build failures, using
3194           particular packages, upgrading pkgsrc installations,
3195           questions regarding the pkgsrc release branches, etc.  General announcements or
3196           proposals for changes that impact the pkgsrc user community,
3197           e.g. major infrastructure changes, new features, package
3198           removals, etc., may also be posted.</p></li>
3199 <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
3200           A list where the results of pkgsrc bulk builds are sent and
3201           discussed.</p></li>
3202 <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
3203           This list is for those who are interested in getting a
3204           commit message for every change committed to pkgsrc. It is
3205           also available in digest form, meaning one daily message
3206           containing all commit messages for changes to the package
3207           source tree in that 24 hour period.</p></li>
3208 </ul></div>
3209 <p>To subscribe, do:</p>
3210 <pre class="programlisting">
3211 <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
3212 </pre>
3213 <p>Archives for all these mailing lists are available from
3214 <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
3215 </div>
3216 <div class="sect1" title="9.2. Where's the pkgviews documentation?">
3217 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3218 <a name="pkgviews-docs"></a>9.2. Where's the pkgviews documentation?</h2></div></div></div>
3219 <p>Pkgviews is tightly integrated with buildlink.  You can find a
3220 pkgviews User's guide in
3221 <code class="filename">pkgsrc/mk/buildlink3/PKGVIEWS_UG</code>.</p>
3222 </div>
3223 <div class="sect1" title="9.3. Utilities for package management (pkgtools)">
3224 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3225 <a name="faq-pkgtools"></a>9.3. Utilities for package management (pkgtools)</h2></div></div></div>
3226 <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
3227 a number of useful utilities for both users and developers of pkgsrc.  This
3228 section attempts only to make the reader aware of the utilities and when
3229 they might be useful, and not to duplicate the documentation that comes
3230 with each package.</p>
3231 <p>Utilities used by pkgsrc (automatically installed when needed):</p>
3232 <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>:
3233       Symlinks for use by buildlink.</p></li></ul></div>
3234 <p>OS tool augmentation (automatically installed when needed):</p>
3235 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3236 <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>:
3237       Calculates various kinds of checksums (including SHA1).</p></li>
3238 <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>:
3239       Compatibility library for pkgsrc tools.</p></li>
3240 <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
3241       non-BSD systems due to lack of native mtree.</p></li>
3242 <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>:
3243       Up-to-date replacement for
3244       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
3245       systems where pkg_install is not present.</p></li>
3246 </ul></div>
3247 <p>Utilities used by pkgsrc (not automatically installed):</p>
3248 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3249 <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>:
3250       Create a binary package from an
3251       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
3252       save the old package.</p></li>
3253 <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>:
3254       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
3255       from multiple locations. It currently supports the following
3256       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
3257 <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
3258       packages someplace else (enabled by default).</p></li>
3259 <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
3260       the best compiler flags to optimise code for your current
3261       CPU and compiler. </p></li>
3262 </ul></div>
3263 <p>Utilities for keeping track of installed packages, being up to date,
3264 etc:</p>
3265 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3266 <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
3267       packages whose installed versions do not match the latest pkgsrc
3268       entries.</p></li>
3269 <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
3270       dependency graphs of packages, to aid in choosing a strategy for
3271       updating.</p></li>
3272 <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
3273       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>
3274 <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
3275       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
3276 <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
3277       does various checks on the complete pkgsrc system.</p></li>
3278 <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
3279       packages you have installed.</p></li>
3280 </ul></div>
3281 <p>Utilities for people maintaining or creating individual packages:</p>
3282 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3283 <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
3284       making and maintaining patches for a package (includes pkgdiff,
3285       pkgvi, mkpatches, etc.).</p></li>
3286 <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>,
3287       <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
3288       converting to pkgsrc.</p></li>
3289 <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
3290       pkgsrc to a Solaris package.</p></li>
3291 </ul></div>
3292 <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
3293 utilities)</p>
3294 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3295 <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
3296       packages in a chrooted area.</p></li>
3297 <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
3298       kernel version for chrooted cross builds.</p></li>
3299 </ul></div>
3300 </div>
3301 <div class="sect1" title="9.4. How to use pkgsrc as non-root">
3302 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3303 <a name="non-root-pkgsrc"></a>9.4. How to use pkgsrc as non-root</h2></div></div></div>
3304 <p>If you want to use pkgsrc as non-root user, you can set some
3305 variables to make pkgsrc work under these conditions.  At the very least,
3306 you need to set <code class="varname">UNPRIVILEGED</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>; this
3307 will turn on unprivileged mode and set multiple related variables to allow
3308 installation of packages as non-root.</p>
3309 <p>In case the defaults are not enough, you may want to tune some other
3310 variables used.  For example, if the automatic user/group detection leads
3311 to incorrect values (or not the ones you would like to use), you can change
3312 them by setting <code class="varname">UNPRIVILEGED_USER</code> and
3313 <code class="varname">UNPRIVILEGED_GROUP</code> respectively.</p>
3314 <p>As regards bootstrapping, please note that the
3315 <span class="command"><strong>bootstrap</strong></span> script will ease non-root configuration when
3316 given the <span class="quote">&#8220;<span class="quote">--ignore-user-check</span>&#8221;</span> flag, as it will choose and
3317 use multiple default directories under <code class="filename">~/pkg</code> as the
3318 installation targets.  These directories can be overridden by the
3319 <span class="quote">&#8220;<span class="quote">--prefix</span>&#8221;</span> flag provided by the script, as well as some others
3320 that allow finer tuning of the tree layout.</p>
3321 </div>
3322 <div class="sect1" title="9.5. How to resume transfers when fetching distfiles?">
3323 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3324 <a name="resume-transfers"></a>9.5. How to resume transfers when fetching distfiles?</h2></div></div></div>
3325 <p>By default, resuming transfers in pkgsrc is disabled, but you can
3326 enable this feature by adding the option
3327 <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
3328 <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
3329 distfile is found, pkgsrc will try to resume it.</p>
3330 <p>You can also
3331 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
3332 <code class="varname">FETCH_USING</code> variable.  You can specify the program by
3333 using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
3334 by using the value manual.  A value of custom disables the system defaults
3335 and dependency tracking for the fetch program.  In that case you have to
3336 provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
3337 <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
3338 <code class="varname">FETCH_AFTER_ARGS</code>.</p>
3339 <p>For example, if you want to use
3340 <code class="filename">wget</code> to download, you'll have to use something
3341 like:</p>
3342 <pre class="programlisting">
3343 FETCH_USING=    wget
3344 </pre>
3345 </div>
3346 <div class="sect1" title="9.6. How can I install/use modular X.org from pkgsrc?">
3347 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3348 <a name="x.org-from-pkgsrc"></a>9.6. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
3349 <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
3350 (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
3351 you will have to add the following line into
3352 <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
3353 <pre class="programlisting">
3354 X11_TYPE=modular
3355 </pre>
3356 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
3357 <h3 class="title">Note</h3>
3358 <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
3359 </p>
3360 </div>
3361 </div>
3362 <div class="sect1" title="9.7. How to fetch files from behind a firewall">
3363 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3364 <a name="fetch-behind-firewall"></a>9.7. How to fetch files from behind a firewall</h2></div></div></div>
3365 <p>If you are sitting behind a firewall which does not allow direct
3366 connections to Internet hosts (i.e. non-NAT), you may specify the
3367 relevant proxy hosts.  This is done using an environment variable in the
3368 form of a URL, e.g. in Amdahl, the machine
3369 <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
3370 port 80 as the proxy port number.  So the proxy environment variables
3371 are:</p>
3372 <pre class="programlisting">
3373 ftp_proxy=ftp://orpheus.amdahl.com:80/
3374 http_proxy=http://orpheus.amdahl.com:80/
3375 </pre>
3376 </div>
3377 <div class="sect1" title="9.8. How do I tell make fetch to do passive FTP?">
3378 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3379 <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>
3380 <p>This depends on which utility is used to retrieve distfiles.  From
3381 <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
3382 the first available command from the following list:</p>
3383 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
3384 <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
3385 <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
3386 </ul></div>
3387 <p>On a default NetBSD installation, this will be
3388 <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
3389 connections first, and falls back to active connections if the server
3390 refuses to do passive.  For the other tools, add the following to your
3391 <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
3392 <code class="varname">PASSIVE_FETCH=1</code>.</p>
3393 <p>Having that option present will prevent
3394 <code class="filename">/usr/bin/ftp</code> from falling back to active
3395 transfers.</p>
3396 </div>
3397 <div class="sect1" title="9.9. How to fetch all distfiles at once">
3398 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3399 <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
3400 <p>You would like to download all the distfiles in a single batch
3401 from work or university, where you can't run a <span class="command"><strong>make
3402 fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
3403 but downloading the entire directory may not be appropriate.</p>
3404 <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
3405 <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
3406 resulting list to your machine at work/school and use it there.  If you
3407 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
3408 forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
3409 URL:</p>
3410 <p>At home:</p>
3411 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
3412 <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
3413 <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
3414 <p>At work:</p>
3415 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
3416 <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
3417 home.</p>
3418 <p>If you have a machine running NetBSD, and you want to get
3419 <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
3420 machine architecture), you can do so by using the above-mentioned
3421 <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
3422 directly by running:</p>
3423 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
3424 <p>If you even decide to ignore
3425 <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
3426 by running:</p>
3427 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
3428 </div>
3429 <div class="sect1" title="9.10. What does &#8220;Don't know how to make /usr/share/tmac/tmac.andoc&#8221; mean?">
3430 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3431 <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
3432 /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
3433 <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>
3434 package, you get the error from make that it doesn't know how to make
3435 <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
3436 you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
3437 the NetBSD base distribution on your machine.  It is recommended to do
3438 that to format man pages.</p>
3439 <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
3440 can get away with setting <code class="varname">NOMAN=YES</code> either in the
3441 environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
3442 </div>
3443 <div class="sect1" title="9.11. What does &#8220;Could not find bsd.own.mk&#8221; mean?">
3444 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3445 <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>
3446 <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
3447 when you installed your NetBSD machine.  Please get and install it, by
3448 extracting it in <code class="filename">/</code>:</p>
3449 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
3450 <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
3451 <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
3452 the one that corresponds to your release (determine via <span class="command"><strong>uname
3453 -r</strong></span>).</p>
3454 </div>
3455 <div class="sect1" title="9.12. Using 'sudo' with pkgsrc">
3456 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3457 <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
3458 <p>When installing packages as non-root user and using the just-in-time
3459 <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
3460 password for each required package installed.  To avoid this, the sudo
3461 package can be used, which does password caching over a limited time.  To
3462 use it, install sudo (either as binary package or from
3463 <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
3464 following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
3465 <span class="emphasis"><em>after</em></span> the definition of the
3466 <code class="varname">LOCALBASE</code> variable:</p>
3467 <pre class="programlisting">
3468 .if exists(${LOCALBASE}/bin/sudo)
3469 SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
3470 .endif
3471 </pre>
3472 </div>
3473 <div class="sect1" title="9.13. How do I change the location of configuration files?">
3474 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3475 <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
3476 <p>As the system administrator, you can choose where configuration files
3477 are installed.  The default settings make all these files go into
3478 <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
3479 be suboptimal depending on your expectations (e.g., a read-only,
3480 NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
3481 configuration of the provided packages).</p>
3482 <p>In order to change the defaults, you can modify the
3483 <code class="varname">PKG_SYSCONFBASE</code> variable (in
3484 <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
3485 directory; some common examples include <code class="filename">/etc</code> or
3486 <code class="filename">/etc/pkg</code>.</p>
3487 <p>Furthermore, you can change this value on a per-package basis by
3488 setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
3489 <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
3490 package you would like to modify, that is, the contents of
3491 <code class="varname">PKGBASE</code>.</p>
3492 <p>Note that after changing these settings, you must rebuild and
3493 reinstall any affected packages.</p>
3494 </div>
3495 <div class="sect1" title="9.14. Automated security checks">
3496 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3497 <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
3498 <p>Please be aware that there can often be bugs in third-party software,
3499 and some of these bugs can leave a machine vulnerable to exploitation by
3500 attackers.  In an effort to lessen the exposure, the NetBSD packages team
3501 maintains a database of known-exploits to packages which have at one time
3502 been included in pkgsrc.  The database can be downloaded automatically, and
3503 a security audit of all packages installed on a system can take place.  To
3504 do this, refer to the following two tools (installed as part of the
3505 <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>
3506 <div class="orderedlist"><ol class="orderedlist" type="1">
3507 <li class="listitem">
3508 <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
3509     download a list of the security vulnerabilities information.  This list
3510     is kept up to date by the pkgsrc security team, and is distributed
3511     from the NetBSD ftp server:</p>
3512 <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
3513 </li>
3514 <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
3515     current machine, checking each known vulnerability.  If a
3516     vulnerable package is installed, it will be shown by output to stdout,
3517     including a description of the type of vulnerability, and a URL
3518     containing more information.</p></li>
3519 </ol></div>
3520 <p>Use of these tools is strongly recommended!  After
3521 <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
3522 the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
3523 pkg_install</code></strong>.</p>
3524 <p>If this package is installed, pkgsrc builds will use it to
3525 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
3526 check.</p>
3527 </div>
3528 <div class="sect1" title="9.15. Why do some packages ignore my CFLAGS?">
3529 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3530 <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
3531 <p>When you add your own preferences to the
3532         <code class="varname">CFLAGS</code> variable in your
3533         <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
3534         environment variables to the <code class="filename">./configure</code>
3535         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
3536         <code class="varname">CFLAGS</code> from the environment variable by
3537         overriding them in the <code class="filename">Makefile</code>s of their
3538         package.</p>
3539 <p>Currently there is no solution to this problem. If you
3540         really need the package to use your <code class="varname">CFLAGS</code>
3541         you should run <span class="command"><strong>make patch</strong></span> in the package
3542         directory and then inspect any <code class="filename">Makefile</code> and
3543         <code class="filename">Makefile.in</code> for whether they define
3544         <code class="varname">CFLAGS</code> explicitly. Usually you can remove
3545         these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
3546         programmers write so bad code that it only works for the
3547         specific combination of <code class="varname">CFLAGS</code> they have
3548         chosen.</p>
3549 </div>
3550 <div class="sect1" title="9.16. A package does not build. What shall I do?">
3551 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3552 <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
3553 <div class="procedure"><ol class="procedure" type="1">
3554 <li class="step" title="Step 1"><p>Make sure that your copy of pkgsrc is consistent. A
3555         case that occurs often is that people only update pkgsrc in
3556         parts, because of performance reasons. Since pkgsrc is one large
3557         system, not a collection of many small systems, there are
3558         sometimes changes that only work when the whole pkgsrc tree is
3559         updated.</p></li>
3560 <li class="step" title="Step 2"><p>Make sure that you don't have any CVS conflicts.
3561         Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
3562         <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
3563         files.</p></li>
3564 <li class="step" title="Step 3"><p>Make sure that you don't have old copies of the packages
3565         extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
3566         verify this.</p></li>
3567 <li class="step" title="Step 4"><p>If the problem still exists, write a mail to the
3568         <code class="literal">pkgsrc-users</code> mailing list.</p></li>
3569 </ol></div>
3570 </div>
3571 <div class="sect1" title="9.17. What does &#8220;Makefile appears to contain unresolved cvs/rcs/??? merge conflicts&#8221; mean?">
3572 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3573 <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>
3574 <p>You have modified a file from pkgsrc, and someone else has
3575 modified that same file afterwards in the CVS repository. Both changes
3576 are in the same region of the file, so when you updated pkgsrc, the
3577 <code class="literal">cvs</code> command marked the conflicting changes in the
3578 file. Because of these markers, the file is no longer a valid
3579 <code class="filename">Makefile</code>.</p>
3580 <p>Have a look at that file, and if you don't need your local changes
3581 anymore, you can remove that file and run <span class="command"><strong>cvs -q update
3582 -dP</strong></span> in that directory to download the current version.</p>
3583 </div>
3584 </div>
3585 </div>
3586 <div class="part" title="Part II. The pkgsrc developer's guide">
3587 <div class="titlepage"><div><div><h1 class="title">
3588 <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
3589 <div class="partintro" title="The pkgsrc developer's guide">
3590 <div></div>
3591 <p>This part of the book deals with creating and
3592         modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
3593         guide on creating a new package. The remaining chapters are more
3594         like a reference manual for pkgsrc.</p>
3595 <div class="toc">
3596 <p><b>Table of Contents</b></p>
3597 <dl>
3598 <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
3599 <dd><dl>
3600 <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
3601 <dd><dl>
3602 <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3603 <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
3604 <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
3605 </dl></dd>
3606 <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3607 <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>
3608 </dl></dd>
3609 <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
3610 <dd><dl>
3611 <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
3612 <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
3613 <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
3614 <dd><dl>
3615 <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
3616 <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
3617 <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
3618 <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
3619 <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
3620 </dl></dd>
3621 <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
3622 <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
3623 <dd><dl>
3624 <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
3625 <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
3626 <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
3627 </dl></dd>
3628 <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
3629 <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
3630 </dl></dd>
3631 <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
3632 <dd><dl>
3633 <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
3634 <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
3635 <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
3636 <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
3637 <dd><dl>
3638 <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
3639 <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
3640 <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
3641 <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
3642 <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
3643 </dl></dd>
3644 </dl></dd>
3645 <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
3646 <dd><dl>
3647 <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
3648 <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
3649 <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>
3650 <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
3651 <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
3652 <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
3653 <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
3654 <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
3655 </dl></dd>
3656 <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
3657 <dd><dl>
3658 <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
3659 <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
3660 <dd><dl>
3661 <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
3662 <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
3663       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3664       and
3665       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
3666       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
3667 </dl></dd>
3668 <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
3669 <dd><dl>
3670 <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>
3671 <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
3672 </dl></dd>
3673 </dl></dd>
3674 <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
3675 <dd><dl>
3676 <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
3677 <dd><dl>
3678 <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
3679 <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
3680 </dl></dd>
3681 <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
3682 <dd><dl>
3683 <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
3684 <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
3685 <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
3686 <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
3687 </dl></dd>
3688 <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
3689 <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>
3690 <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
3691 <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
3692 <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
3693 <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
3694 <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>
3695 </dl></dd>
3696 <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
3697 <dd><dl>
3698 <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
3699 <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>
3700 <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
3701 <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
3702 </dl></dd>
3703 <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
3704 <dd><dl>
3705 <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
3706 <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
3707 <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
3708 <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
3709 <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
3710 <dd><dl>
3711 <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
3712 <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
3713 </dl></dd>
3714 <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
3715 <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
3716 <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
3717 <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
3718 <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
3719 <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
3720 <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
3721 <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
3722 <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
3723 <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
3724 <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
3725 <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
3726 </dl></dd>
3727 <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
3728 <dd><dl>
3729 <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
3730 <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
3731 <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
3732 <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
3733 </dl></dd>
3734 <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
3735 <dd><dl>
3736 <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
3737 <dd><dl>
3738 <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
3739 <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>
3740 <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
3741 <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
3742 <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
3743 <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
3744 <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
3745 <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
3746 <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
3747 <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
3748 <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
3749 <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
3750 </dl></dd>
3751 <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>
3752 <dd><dl>
3753 <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
3754 <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>
3755 </dl></dd>
3756 <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>
3757 <dd><dl>
3758 <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
3759 <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
3760 <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
3761 </dl></dd>
3762 <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
3763 <dd><dl>
3764 <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
3765 <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
3766 <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
3767 <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
3768 </dl></dd>
3769 <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>
3770 <dd><dl>
3771 <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
3772 <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
3773 <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>
3774 <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
3775 </dl></dd>
3776 <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>
3777 <dd><dl>
3778 <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
3779 <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
3780 <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
3781 <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
3782 <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
3783 <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
3784 <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
3785 <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
3786 <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
3787 <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
3788 <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
3789 <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
3790 <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
3791 <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
3792 <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
3793 <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
3794 <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
3795 <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
3796     emulation</a></span></dt>
3797 <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
3798 <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
3799 </dl></dd>
3800 <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
3801 </dl></dd>
3802 <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
3803 <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
3804 <dd><dl>
3805 <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
3806 <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
3807 <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
3808 <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
3809 <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
3810 <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
3811 <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
3812 </dl></dd>
3813 <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
3814 <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
3815 <dd><dl>
3816 <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
3817 <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
3818 <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
3819 <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
3820 </dl></dd>
3821 </dl>
3822 </div>
3823 </div>
3824 <div class="chapter" title="Chapter 10. Creating a new pkgsrc package from scratch">
3825 <div class="titlepage"><div><div><h2 class="title">
3826 <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
3827 <div class="toc">
3828 <p><b>Table of Contents</b></p>
3829 <dl>
3830 <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
3831 <dd><dl>
3832 <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
3833 <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE applications</a></span></dt>
3834 <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
3835 </dl></dd>
3836 <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
3837 <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>
3838 </dl>
3839 </div>
3840 <p>When you find a package that is not yet in pkgsrc, you
3841 most likely have a URL from where you can download the source
3842 code. Starting with this URL, creating a package involves only a
3843 few steps.</p>
3844 <div class="procedure"><ol class="procedure" type="1">
3845 <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>
3846 <li class="step" title="Step 2"><p>Then, choose one of the top-level directories as the
3847 category in which you want to place your package. You can also create a
3848 directory of your own (maybe called <code class="filename">local</code>). In that
3849 category directory, create another directory for your package and change
3850 into it.</p></li>
3851 <li class="step" title="Step 3"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
3852 you for a URL. Enter the URL of the distribution file (in most cases a
3853 <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
3854 of your package are created automatically. The distribution file is
3855 extracted automatically to fill in some details in the
3856 <code class="filename">Makefile</code> that would otherwise have to be done
3857 manually.</p></li>
3858 <li class="step" title="Step 4">
3859 <p>Examine the extracted files to determine the dependencies of
3860 your package. Ideally, this is mentioned in some
3861 <code class="filename">README</code> file, but things may differ. For each of
3862 these dependencies, look where it exists in pkgsrc, and if there is a
3863 file called <code class="filename">buildlink3.mk</code> in that directory, add a
3864 line to your package <code class="filename">Makefile</code> which includes that
3865 file just before the last line. If the
3866 <code class="filename">buildlink3.mk</code> file does not exist, it must be
3867 created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
3868 <p>If you just need binaries from a package, add a
3869 <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
3870 version of the dependency and where it can be found in pkgsrc. This line
3871 should be placed in the third paragraph. If the dependency is only
3872 needed for building the package, but not when using it, use
3873 <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
3874 Your package may then look like this:</p>
3875 <pre class="programlisting">
3876 [...]
3877
3878 BUILD_DEPENDS+= lua&gt;=5.0:../../lang/lua
3879 DEPENDS+=       screen-[0-9]*:../../misc/screen
3880 DEPENDS+=       screen&gt;=4.0:../../misc/screen
3881
3882 [...]
3883
3884 .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
3885 .include "../../devel/glib2/buildlink3.mk"
3886 .include "../../mk/bsd.pkg.mk"
3887 </pre>
3888 </li>
3889 <li class="step" title="Step 5"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
3890 to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
3891 know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
3892 --explain</strong></span> or <span class="command"><strong>pkglint
3893 -e</strong></span>, which outputs additional
3894 explanations.</p></li>
3895 <li class="step" title="Step 6"><p>In many cases the package is not yet ready to build. You can
3896 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
3897 over there, you can hopefully continue here.</p></li>
3898 <li class="step" title="Step 7"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
3899 directory from the extracted files. Besides these files, a lot of cache
3900 files and other system information has been saved in the working
3901 directory, which may become wrong after you edited the
3902 <code class="filename">Makefile</code>.</p></li>
3903 <li class="step" title="Step 8"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
3904 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>
3905 <li class="step" title="Step 9"><p>When the package builds fine, the next step is to install
3906 the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
3907 everything works.</p></li>
3908 <li class="step" title="Step 10"><p>Up to now, the file <code class="filename">PLIST</code>, which
3909 contains a list of the files that are installed by the package, is
3910 nearly empty. Run <span class="command"><strong>bmake print-PLIST
3911 &gt;PLIST</strong></span> to generate a probably correct list. Check
3912 the file using your preferred text editor to see if the list of
3913 files looks plausible.</p></li>
3914 <li class="step" title="Step 11"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
3915 <code class="filename">PLIST</code> contains garbage or not.</p></li>
3916 <li class="step" title="Step 12"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
3917 has been registered in the database of installed files, but with an
3918 empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
3919 and <span class="command"><strong>bmake install</strong></span> again. Now the package is
3920 registered with the list of files from
3921 <code class="filename">PLIST</code>.</p></li>
3922 <li class="step" title="Step 13"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
3923 package from the set of installed files.</p></li>
3924 </ol></div>
3925 <div class="sect1" title="10.1. Common types of packages">
3926 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3927 <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
3928 <div class="sect2" title="10.1.1. Perl modules">
3929 <div class="titlepage"><div><div><h3 class="title">
3930 <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
3931 <p>Simple Perl modules are handled automatically by
3932 <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
3933 </div>
3934 <div class="sect2" title="10.1.2. KDE applications">
3935 <div class="titlepage"><div><div><h3 class="title">
3936 <a name="creating.kde-app"></a>10.1.2. KDE applications</h3></div></div></div>
3937 <p>KDE applications should always include
3938 <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
3939 settings that are typical of KDE packages.</p>
3940 </div>
3941 <div class="sect2" title="10.1.3. Python modules and programs">
3942 <div class="titlepage"><div><div><h3 class="title">
3943 <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
3944 <p>Python modules and programs packages are easily created using a
3945 set of predefined variables.</p>
3946 <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
3947 easy-setup (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
3948 If the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, set the
3949 <code class="varname">PYDISTUTILSPKG</code> variable to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> so
3950 pkgsrc will make use of this framework.
3951 <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
3952 if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
3953 <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
3954 to the name of the script.</p>
3955 <p>
3956 If the default Python versions are not supported by the software, set the
3957 <code class="varname">PYTHON_VERSIONS_ACCEPTED</code> variable to the Python versions
3958 the software is known to work with, from the most recent to the older
3959 one, e.g.
3960 </p>
3961 <pre class="programlisting">
3962 PYTHON_VERSIONS_ACCEPTED=       25 24
3963 </pre>
3964 <p>
3965 If the packaged software is a Python module, include
3966 <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/extension.mk</code></span>&#8221;</span>.
3967 In this case, the package directory should be called
3968 <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
3969 <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
3970 </p>
3971 <pre class="programlisting">
3972 DISTNAME=   foopymodule-1.2.10
3973 PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
3974 </pre>
3975 <p>If it is an application, also include
3976 <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>
3977 before <span class="quote">&#8220;<span class="quote">extension.mk</span>&#8221;</span>.</p>
3978 <p>If the packaged software, either it is an application or a module, is
3979 egg-aware, you only need to include
3980 <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.</p>
3981 <p>In order to correctly set the path to the Python interpreter, use the
3982 <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
3983 that must be corrected. For example :
3984 </p>
3985 <pre class="programlisting">
3986 REPLACE_PYTHON=   ${WRKSRC}/*.py
3987 </pre>
3988 </div>
3989 </div>
3990 <div class="sect1" title="10.2. Examples">
3991 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
3992 <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
3993 <div class="sect2" title="10.2.1. How the www/nvu package came into pkgsrc">
3994 <div class="titlepage"><div><div><h3 class="title">
3995 <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
3996 <div class="sect3" title="10.2.1.1. The initial package">
3997 <div class="titlepage"><div><div><h4 class="title">
3998 <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
3999 <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
4000 that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
4001 pkgsrc. As the description says it has to do with the web, the obvious
4002 choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
4003 <pre class="programlisting">
4004 <code class="prompt">$</code> mkdir www/nvu
4005 <code class="prompt">$</code> cd www/nvu
4006 </pre>
4007 <p>The web site says that the sources are available as a tar file, so
4008 I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
4009 <pre class="programlisting">
4010 <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4011 </pre>
4012 <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
4013 below the <code class="varname">DISTNAME</code> line, as the package name should
4014 not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
4015 <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
4016 <code class="varname">COMMENT</code> fields. Then the package
4017 <code class="filename">Makefile</code> looked like that:</p>
4018 <pre class="programlisting">
4019 # $NetBSD$
4020 #
4021
4022 DISTNAME=       nvu-1.0-sources
4023 PKGNAME=        nvu-1.0
4024 CATEGORIES=     www
4025 MASTER_SITES=   http://cvs.nvu.com/download/
4026 EXTRACT_SUFX=   .tar.bz2
4027
4028 MAINTAINER=     rillig@NetBSD.org
4029 HOMEPAGE=       http://cvs.nvu.com/
4030 COMMENT=        Web Authoring System
4031
4032 # url2pkg-marker (please do not remove this line.)
4033 .include "../../mk/bsd.pkg.mk"
4034 </pre>
4035 <p>Then, I quit the editor and watched pkgsrc downloading a large
4036 source archive:</p>
4037 <pre class="programlisting">
4038 url2pkg&gt; Running "make makesum" ...
4039 =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
4040 =&gt; Fetching nvu-1.0-sources.tar.bz2
4041 Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
4042 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
4043 29687976 bytes retrieved in 03:12 (150.77 KB/s)
4044 url2pkg&gt; Running "make extract" ...
4045 =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
4046 =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4047 =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4048 work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
4049 ===&gt; Installing dependencies for nvu-1.0
4050 ===&gt; Overriding tools for nvu-1.0
4051 ===&gt; Extracting for nvu-1.0
4052 url2pkg&gt; Adjusting the Makefile.
4053
4054 Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
4055
4056 Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
4057 </pre>
4058 </div>
4059 <div class="sect3" title="10.2.1.2. Fixing all kinds of problems to make the package work">
4060 <div class="titlepage"><div><div><h4 class="title">
4061 <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
4062 <p>Now that the package has been extracted, let's see what's inside
4063 it. The package has a <code class="filename">README.txt</code>, but that only
4064 says something about mozilla, so it's probably useless for seeing what
4065 dependencies this package has. But since there is a GNU configure script
4066 in the package, let's hope that it will complain about everything it
4067 needs.</p>
4068 <pre class="programlisting">
4069 <code class="prompt">$</code> bmake
4070 =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
4071 =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
4072 =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
4073 ===&gt; Patching for nvu-1.0
4074 ===&gt; Creating toolchain wrappers for nvu-1.0
4075 ===&gt; Configuring for nvu-1.0
4076 [...]
4077 configure: error: Perl 5.004 or higher is required.
4078 [...]
4079 WARNING: Please add USE_TOOLS+=perl to the package Makefile.
4080 [...]
4081 </pre>
4082 <p>That worked quite well. So I opened the package Makefile in my
4083 editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
4084 just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
4085 package have changed now, and since a perl wrapper is automatically
4086 installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
4087 from scratch.</p>
4088 <pre class="programlisting">
4089 <code class="prompt">$</code> bmake clean
4090 ===&gt; Cleaning for nvu-1.0
4091 <code class="prompt">$</code> bmake
4092 [...]
4093 *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
4094 GNU Make.  You will not be able to build Mozilla without GNU Make.
4095 [...]
4096 </pre>
4097 <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
4098 <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
4099 <pre class="programlisting">
4100 [...]
4101 checking for GTK - version &gt;= 1.2.0... no
4102 *** Could not run GTK test program, checking why...
4103 [...]
4104 </pre>
4105 <p>Now to the other dependencies. The first question is: Where is the
4106 GTK package hidden in pkgsrc?</p>
4107 <pre class="programlisting">
4108 <code class="prompt">$</code> echo ../../*/gtk*
4109 [many packages ...]
4110 <code class="prompt">$</code> echo ../../*/gtk
4111 ../../x11/gtk
4112 <code class="prompt">$</code> echo ../../*/gtk2
4113 ../../x11/gtk2
4114 <code class="prompt">$</code> echo ../../*/gtk2/bui*
4115 ../../x11/gtk2/buildlink3.mk
4116 </pre>
4117 <p>The first try was definitely too broad. The second one had exactly
4118 one result, which is very good. But there is one pitfall with GNOME
4119 packages. Before GNOME 2 had been released, there were already many
4120 GNOME 1 packages in pkgsrc. To be able to continue to use these
4121 packages, the GNOME 2 packages were imported as separate packages, and
4122 their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
4123 whether this was the case here, and indeed it was.</p>
4124 <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
4125 file, adding the dependency is very easy. I just inserted an
4126 <code class="literal">.include</code> line before the last line of the package
4127 <code class="filename">Makefile</code>, so that it now looks like this:</p>
4128 <pre class="programlisting">
4129 [...]
4130 .include "../../x11/gtk2/buildlink3.mk"
4131 .include "../../mk/bsd.pkg.mk
4132 </pre>
4133 <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
4134 was:</p>
4135 <pre class="programlisting">
4136 [...]
4137 checking for gtk-config... /home/roland/pkg/bin/gtk-config
4138 checking for GTK - version &gt;= 1.2.0... no
4139 *** Could not run GTK test program, checking why...
4140 *** The test program failed to compile or link. See the file config.log for the
4141 *** exact error that occured. This usually means GTK was incorrectly installed
4142 *** or that you have moved GTK since it was installed. In the latter case, you
4143 *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
4144 configure: error: Test for GTK failed.
4145 [...]
4146 </pre>
4147 <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
4148 prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
4149 told me that this package really wanted to have the GNOME 1 version of
4150 GTK. If the package had looked for GTK2, it would have looked for
4151 <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
4152 So I changed the <code class="literal">x11/gtk2</code> to
4153 <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
4154 and tried again.</p>
4155 <pre class="programlisting">
4156 [...]
4157 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
4158 In file included from xpidl.c:42:
4159 xpidl.h:53:24: libIDL/IDL.h: No such file or directory
4160 In file included from xpidl.c:42:
4161 xpidl.h:132: error: parse error before "IDL_ns"
4162 [...]
4163 </pre>
4164 <p>The package still does not find all of its dependencies. Now the
4165 question is: Which package provides the
4166 <code class="filename">libIDL/IDL.h</code> header file?</p>
4167 <pre class="programlisting">
4168 <code class="prompt">$</code> echo ../../*/*idl*
4169 ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
4170 <code class="prompt">$</code> echo ../../*/*IDL*
4171 ../../net/libIDL
4172 </pre>
4173 <p>Let's take the one from the second try. So I included the
4174 <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
4175 again. But the error didn't change. After digging through some of the
4176 code, I concluded that the build process of the package was broken and
4177 couldn't have ever worked, but since the Mozilla source tree is quite
4178 large, I didn't want to fix it. So I added the following to the package
4179 <code class="filename">Makefile</code> and tried again:</p>
4180 <pre class="programlisting">
4181 CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
4182 BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
4183 </pre>
4184 <p>The latter line is needed because the package expects the library
4185 <code class="filename">libIDL.so</code>, but only
4186 <code class="filename">libIDL-2.so</code> is available. So I told the compiler
4187 wrapper to rewrite that on the fly.</p>
4188 <p>The next problem was related to a recent change of the FreeType
4189 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>
4190 which patch files were relevant for this issue and copied them to the
4191 <code class="filename">patches</code> directory. Then I retried, fixed the
4192 patches so that they applied cleanly and retried again. This time,
4193 everything worked.</p>
4194 </div>
4195 <div class="sect3" title="10.2.1.3. Installing the package">
4196 <div class="titlepage"><div><div><h4 class="title">
4197 <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
4198 <pre class="programlisting">
4199 <code class="prompt">$</code> bmake CHECK_FILES=no install
4200 [...]
4201 <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
4202 <code class="prompt">$</code> bmake deinstall
4203 <code class="prompt">$</code> bmake install
4204 </pre>
4205 </div>
4206 </div>
4207 </div>
4208 </div>
4209 <div class="chapter" title="Chapter 11. Package components - files, directories and contents">
4210 <div class="titlepage"><div><div><h2 class="title">
4211 <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
4212 <div class="toc">
4213 <p><b>Table of Contents</b></p>
4214 <dl>
4215 <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
4216 <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
4217 <dt><span class="sect1"><a href="#components.patches">11.3. patches/*</a></span></dt>
4218 <dd><dl>
4219 <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
4220 <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
4221 <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
4222 <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
4223 <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
4224 </dl></dd>
4225 <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
4226 <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
4227 <dd><dl>
4228 <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
4229 <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
4230 <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
4231 </dl></dd>
4232 <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
4233 <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
4234 </dl>
4235 </div>
4236 <p>Whenever you're preparing a package, there are a number of
4237 files involved which are described in the following
4238 sections.</p>
4239 <div class="sect1" title="11.1. Makefile">
4240 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4241 <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
4242 </h2></div></div></div>
4243 <p>Building, installation and creation of a binary package are all
4244   controlled by the package's <code class="filename">Makefile</code>.
4245   The <code class="filename">Makefile</code> describes various things about
4246   a package, for example from where to get it, how to configure,
4247   build, and install it.</p>
4248 <p>A package <code class="filename">Makefile</code> contains several
4249   sections that describe the package.</p>
4250 <p>In the first section there are the following variables, which
4251   should appear exactly in the order given here.  The order and
4252   grouping of the variables is mostly historical and has no further
4253   meaning.</p>
4254 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4255 <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
4256     distribution file to be downloaded from the package's
4257     website.</p></li>
4258 <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
4259     package, as used by pkgsrc. You only need to provide it if
4260     <code class="varname">DISTNAME</code> (which is the default) is not a good
4261     name for the package in pkgsrc.  Usually it is the pkgsrc
4262     directory name together with the version number. It must match the
4263     regular expression
4264     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
4265     starts with a letter or digit, and contains only letters, digits,
4266     dashes, underscores, dots and plus signs.</p></li>
4267 <li class="listitem"><p><code class="varname">SVR4_PKGNAME</code> is the name of
4268     the package file to create if the <code class="varname">PKGNAME</code>
4269     isn't unique on a SVR4 system. The default is
4270     <code class="varname">PKGNAME</code>, which may be shortened when you use
4271     <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
4272     <code class="varname">SVR4_PKGNAME</code> if <code class="varname">PKGNAME</code>
4273     does not produce an unique package name on a SVR4 system.
4274     The length of <code class="varname">SVR4_PKGNAME</code> is limited to 5
4275     characters.</p></li>
4276 <li class="listitem">
4277 <p><code class="varname">CATEGORIES</code> is a list of categories
4278     which the package fits in. You can choose any of the top-level
4279     directories of pkgsrc for it.</p>
4280 <p>Currently the following values are available for
4281     <code class="varname">CATEGORIES</code>. If more than
4282     one is used, they need to be separated by spaces:</p>
4283 <pre class="programlisting">
4284 archivers     cross         geography     meta-pkgs     security
4285 audio         databases     graphics      misc          shells
4286 benchmarks    devel         ham           multimedia    sysutils
4287 biology       editors       inputmethod   net           textproc
4288 cad           emulators     lang          news          time
4289 chat          finance       mail          parallel      wm
4290 comms         fonts         math          pkgtools      www
4291 converters    games         mbone         print         x11
4292 </pre>
4293 </li>
4294 <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
4295     <code class="varname">DYNAMIC_MASTER_SITES</code>,
4296     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
4297     and <code class="varname">DISTFILES</code> are discussed in detail in
4298     <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>
4299 </ul></div>
4300 <p>The second section contains information about separately
4301   downloaded patches, if any.
4302   </p>
4303 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4304 <li class="listitem"><p><code class="varname">PATCHFILES:</code>
4305     Name(s) of additional files that contain distribution patches.
4306     There is no default. pkgsrc will look for them at
4307     <code class="varname">PATCH_SITES</code>.
4308     They will automatically be uncompressed before patching if
4309     the names end with <code class="filename">.gz</code> or
4310     <code class="filename">.Z</code>.</p></li>
4311 <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
4312     Primary location(s) for distribution patch files (see
4313     <code class="varname">PATCHFILES</code> below) if not found locally.</p></li>
4314 </ul></div>
4315 <p>The third section contains the following variables.
4316   </p>
4317 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4318 <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
4319     address of the person who feels responsible for this package,
4320     and who is most likely to look at problems or questions regarding
4321     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>.
4322     Other developers may contact the <code class="varname">MAINTAINER</code>
4323     before making changes to the package, but are not required to
4324     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
4325     to yourself. If you really can't maintain the package for future
4326     updates, set it to
4327     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
4328 <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
4329     of <code class="varname">MAINTAINER</code> when you do not want other
4330     developers to update or change the package without contacting
4331     you first. A package Makefile should contain one of
4332     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
4333     not both.  </p></li>
4334 <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
4335     find more information about the package.</p></li>
4336 <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
4337     description of the package (should not include the package
4338     name).</p></li>
4339 </ul></div>
4340 <p>Other variables that affect the build:
4341   </p>
4342 <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
4343 <p><code class="varname">WRKSRC</code>: The directory where the
4344       interesting distribution files of the package are found. The
4345       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
4346       works for most packages.</p>
4347 <p>If a package doesn't create a subdirectory for itself
4348       (most GNU software does, for instance), but extracts itself in
4349       the current directory, you should set
4350       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
4351 <p>If a package doesn't create a subdirectory with the
4352       name of <code class="varname">DISTNAME</code> but some different name,
4353       set <code class="varname">WRKSRC</code> to point to the proper name in
4354       <code class="filename">${WRKDIR}</code>, for example
4355       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
4356       <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>
4357 <p>The name of the working directory created by pkgsrc is
4358       taken from the <code class="varname">WRKDIR_BASENAME</code>
4359       variable. By default, its value is
4360       <code class="filename">work</code>. If you want to use the same
4361       pkgsrc tree for building different kinds of binary packages,
4362       you can change the variable according to your needs. Two
4363       other variables handle common cases of setting
4364       <code class="varname">WRKDIR_BASENAME</code> individually. If
4365       <code class="varname">OBJHOSTNAME</code> is defined in
4366       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
4367       the host's name is attached to the directory name. If
4368       <code class="varname">OBJMACHINE</code> is defined, the platform name
4369       is attached, which might look like
4370       <code class="filename">work.i386</code> or
4371       <code class="filename">work.sparc</code>.</p>
4372 </li></ul></div>
4373 <p>Please pay attention to the following gotchas:</p>
4374 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4375 <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
4376       installed in compressed form by the package.  For packages using
4377       BSD-style makefiles which honor MANZ, there is
4378       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
4379 <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
4380       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
4381       below).</p></li>
4382 <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>
4383 </ul></div>
4384 </div>
4385 <div class="sect1" title="11.2. distinfo">
4386 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4387 <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
4388 </h2></div></div></div>
4389 <p>The <code class="filename">distinfo</code> file contains the message
4390   digest, or checksum, of each distfile needed for the package. This
4391   ensures that the distfiles retrieved from the Internet have not been
4392   corrupted during transfer or altered by a malign force to introduce
4393   a security hole. Due to recent rumor about weaknesses of digest
4394   algorithms, all distfiles are protected using both SHA1 and RMD160
4395   message digests, as well as the file size.</p>
4396 <p>The <code class="filename">distinfo</code> file also contains the
4397   checksums for all the patches found in the
4398   <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>
4399 <p>To regenerate the <code class="filename">distinfo</code> file, use the
4400   <span class="command"><strong>make makedistinfo</strong></span> or <span class="command"><strong>make mdi</strong></span>
4401   command.</p>
4402 <p>Some packages have different sets of distfiles depending on
4403   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
4404   <code class="filename">distinfo</code> file and care should be taken when
4405   upgrading such a package to ensure distfile information is not
4406   lost.</p>
4407 </div>
4408 <div class="sect1" title="11.3. patches/*">
4409 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4410 <a name="components.patches"></a>11.3. patches/*</h2></div></div></div>
4411 <p>Many packages still don't work out-of-the box on the various
4412   platforms that are supported by pkgsrc. Therefore, a number of custom
4413   patch files are needed to make the package work. These patch files are
4414   found in the <code class="filename">patches/</code> directory.</p>
4415 <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
4416   applied to the files in <code class="varname">WRKSRC</code> directory after
4417   extracting them, in <a class="ulink" href="http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13_03" target="_top">alphabetic
4418   order</a>.</p>
4419 <div class="sect2" title="11.3.1. Structure of a single patch file">
4420 <div class="titlepage"><div><div><h3 class="title">
4421 <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
4422 <p>The <code class="filename">patch-*</code> files should be in
4423   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
4424   problems. (To force patches to apply with fuzz you can set
4425   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
4426   should contain only changes for a single file, and no file should be
4427   patched by more than one patch file. This helps to keep future
4428   modifications simple.</p>
4429 <p>Each patch file is structured as follows: In the first line,
4430   there is the RCS Id of the patch itself. The second line should be
4431   empty for aesthetic reasons. After that, there should be a comment for
4432   each change that the patch does. There are a number of standard
4433   cases:</p>
4434 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4435 <li class="listitem"><p>Patches for commonly known vulnerabilities should
4436   mention the vulnerability ID (CAN, CVE).</p></li>
4437 <li class="listitem"><p>Patches that change source code should mention the
4438   platform and other environment (for example, the compiler) that the
4439   patch is needed for.</p></li>
4440 </ul></div>
4441 <p>In all, the patch should be commented so that any
4442   developer who knows the code of the application can make some use of
4443   the patch. Special care should be taken for the upstream developers,
4444   since we generally want that they accept our patches, so we have less
4445   work in the future.</p>
4446 </div>
4447 <div class="sect2" title="11.3.2. Creating patch files">
4448 <div class="titlepage"><div><div><h3 class="title">
4449 <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
4450 <p>One important thing to mention is to pay attention that no RCS
4451   IDs get stored in the patch files, as these will cause problems when
4452   later checked into the NetBSD CVS tree. Use the
4453   <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
4454   problems.</p>
4455 <p>For even more automation, we recommend using
4456   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
4457   whole set of patches. You just have to backup files before you
4458   edit them to <code class="filename">filename.orig</code>, e.g. with
4459   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
4460   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
4461   you upgrade a package this way, you can easily compare the new
4462   set of patches with the previously existing one with
4463   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
4464   are replaced by new files, so carefully check if you want to take all
4465   the changes.</p>
4466 <p>When you have finished a package, remember to generate
4467   the checksums for the patch files by using the <span class="command"><strong>make
4468   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>
4469 <p>When adding a patch that corrects a problem in the
4470   distfile (rather than e.g. enforcing pkgsrc's view of where
4471   man pages should go), send the patch as a bug report to the
4472   maintainer.  This benefits non-pkgsrc users of the package,
4473   and usually makes it possible to remove the patch in future
4474   version.</p>
4475 <p>The file names of the patch files are usually of the form
4476   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
4477   Many packages still use the previous convention
4478   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
4479   but new patches should be of the form containing the filename.
4480   <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
4481   automatically.</p>
4482 </div>
4483 <div class="sect2" title="11.3.3. Sources where the patch files come from">
4484 <div class="titlepage"><div><div><h3 class="title">
4485 <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
4486 <p>If you want to share patches between multiple packages
4487   in pkgsrc, e.g. because they use the same distfiles, set
4488   <code class="varname">PATCHDIR</code> to the path where the patch files
4489   can be found, e.g.:</p>
4490 <pre class="programlisting">
4491 PATCHDIR= ${.CURDIR}/../xemacs/patches
4492 </pre>
4493 <p>Patch files that are distributed by the author or other
4494     maintainers can be listed in
4495     <code class="varname">PATCHFILES</code>.</p>
4496 <p>If it is desired to store any patches that should not be
4497     committed into pkgsrc, they can be kept outside the pkgsrc
4498     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
4499     directory tree there is expected to have the same
4500     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
4501     patches are expected to be stored inside these dirs (also
4502     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
4503     example, if you want to keep a private patch for
4504     <code class="filename">pkgsrc/graphics/png</code>, keep it in
4505     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
4506     files in the named directory are expected to be patch files,
4507     and <span class="emphasis"><em>they are applied after pkgsrc patches are
4508     applied</em></span>.</p>
4509 </div>
4510 <div class="sect2" title="11.3.4. Patching guidelines">
4511 <div class="titlepage"><div><div><h3 class="title">
4512 <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
4513 <p>When fixing a portability issue in the code do not use
4514       preprocessor magic to check for the current operating system nor
4515       platform.  Doing so hurts portability to other platforms because
4516       the OS-specific details are not abstracted appropriately.</p>
4517 <p>The general rule to follow is: instead of checking for the
4518       operating system the application is being built on, check for the
4519       specific <span class="emphasis"><em>features</em></span> you need.  For example,
4520       instead of assuming that kqueue is available under NetBSD and
4521       using the <code class="varname">__NetBSD__</code> macro to conditionalize
4522       kqueue support, add a check that detects kqueue itself &mdash;
4523       yes, this generally involves patching the
4524       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
4525       that prevents some OSes from adopting interfaces from other OSes
4526       (e.g. Linux implementing kqueue), something that the above checks
4527       cannot take into account.</p>
4528 <p>Of course, checking for features generally involves more
4529       work on the developer's side, but the resulting changes are
4530       cleaner and there are chances they will work on many other
4531       platforms.  Not to mention that there are higher chances of being
4532       later integrated into the mainstream sources.  Remember:
4533       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
4534 <p>Some typical examples:</p>
4535 <div class="table">
4536 <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
4537 <div class="table-contents"><table summary="Patching examples" border="1">
4538 <colgroup>
4539 <col>
4540 <col>
4541 <col>
4542 </colgroup>
4543 <thead><tr>
4544 <th>Where</th>
4545 <th>Incorrect</th>
4546 <th>Correct</th>
4547 </tr></thead>
4548 <tbody>
4549 <tr>
4550 <td>configure script</td>
4551 <td>
4552 <pre class="programlisting">
4553 case ${target_os} in
4554 netbsd*) have_kvm=yes ;;
4555 *)       have_kvm=no  ;;
4556 esac
4557 </pre>
4558               </td>
4559 <td>
4560 <pre class="programlisting">
4561 AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
4562 </pre>
4563               </td>
4564 </tr>
4565 <tr>
4566 <td>C source file</td>
4567 <td>
4568 <pre class="programlisting">
4569 #if defined(__NetBSD__)
4570 #  include &lt;sys/event.h&gt;
4571 #endif
4572 </pre>
4573               </td>
4574 <td>
4575 <pre class="programlisting">
4576 #if defined(HAVE_SYS_EVENT_H)
4577 #  include &lt;sys/event.h&gt;
4578 #endif
4579 </pre>
4580               </td>
4581 </tr>
4582 <tr>
4583 <td>C source file</td>
4584 <td>
4585 <pre class="programlisting">
4586 int
4587 monitor_file(...)
4588 {
4589 #if defined(__NetBSD__)
4590         int fd = kqueue();
4591         ...
4592 #else
4593         ...
4594 #endif
4595 }
4596 </pre>
4597               </td>
4598 <td>
4599 <pre class="programlisting">
4600 int
4601 monitor_file(...)
4602 {
4603 #if defined(HAVE_KQUEUE)
4604         int fd = kqueue();
4605         ...
4606 #else
4607         ...
4608 #endif
4609 }
4610 </pre>
4611               </td>
4612 </tr>
4613 </tbody>
4614 </table></div>
4615 </div>
4616 <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
4617       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
4618       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
4619       2</a>).  It summarizes multiple details on how to make
4620       software easier to package; all the suggestions in it were
4621       collected from our experience in pkgsrc work, so they are possibly
4622       helpful when creating patches too.</p>
4623 </div>
4624 <div class="sect2" title="11.3.5. Feedback to the author">
4625 <div class="titlepage"><div><div><h3 class="title">
4626 <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
4627 <p>Always, always, <span class="strong"><strong>always</strong></span>
4628       feed back any <span class="emphasis"><em>portability fixes</em></span> or
4629       improvements you do to a package to the mainstream developers.
4630       This is the only way to get their attention on portability issues
4631       and to ensure that future versions can be built out-of-the box on
4632       NetBSD.  Furthermore, any user that gets newer distfiles will get
4633       the fixes straight from the packaged code.</p>
4634 <p>This generally involves cleaning up the patches
4635       (because sometimes the patches that are
4636       added to pkgsrc are quick hacks), filling bug reports in the
4637       appropriate trackers for the projects and working with the
4638       mainstream authors to accept your changes.  It is
4639       <span class="emphasis"><em>extremely important</em></span> that you do it so that
4640       the packages in pkgsrc are kept simple and thus further changes
4641       can be done without much hassle.</p>
4642 <p>When you have done this, please add a URL to the upstream
4643       bug report to the patch comment.</p>
4644 <p>Support the idea of free software!</p>
4645 </div>
4646 </div>
4647 <div class="sect1" title="11.4. Other mandatory files">
4648 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4649 <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
4650 <div class="variablelist"><dl>
4651 <dt><span class="term"><code class="filename">DESCR</code></span></dt>
4652 <dd><p>A multi-line description of the piece of software.  This should include
4653           any credits where they are due.  Please bear in mind that others do not
4654           share your sense of humour (or spelling idiosyncrasies), and that others
4655           will read everything that you write here.</p></dd>
4656 <dt><span class="term"><code class="filename">PLIST</code></span></dt>
4657 <dd><p>This file governs the files that are installed on your
4658           system: all the binaries, manual pages, etc. There are other
4659           directives which may be entered in this file, to control the
4660           creation and deletion of directories, and the location of
4661           inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
4662           information.</p></dd>
4663 </dl></div>
4664 </div>
4665 <div class="sect1" title="11.5. Optional files">
4666 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4667 <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
4668 <div class="sect2" title="11.5.1. Files affecting the binary package">
4669 <div class="titlepage"><div><div><h3 class="title">
4670 <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
4671 <div class="variablelist"><dl>
4672 <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
4673 <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>.
4674             First time after package extraction and before files are
4675             moved in place, the second time after the files to install
4676             are moved in place. This can be used to do any custom
4677             procedures not possible with @exec commands in
4678             <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
4679             <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>
4680 <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
4681 <dd><p>This script is executed before and after any files are removed.  It is
4682             this script's responsibility to clean up any additional messy details
4683             around the package's installation, since all pkg_delete knows is how to
4684             delete the files created in the original distribution.
4685             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>
4686             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>
4687 <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
4688 <dd>
4689 <p>This file is displayed after installation of the package.
4690             Useful for things like legal notices on almost-free
4691             software and hints for updating config files after
4692             installing modules for apache, PHP etc.
4693             Please note that you can modify variables in it easily by using
4694             <code class="varname">MESSAGE_SUBST</code> in the package's
4695             <code class="filename">Makefile</code>:</p>
4696 <pre class="programlisting">
4697 MESSAGE_SUBST+=  SOMEVAR="somevalue"
4698 </pre>
4699 <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
4700             <code class="filename">MESSAGE</code>.  By default, substitution is
4701             performed for <code class="varname">PKGNAME</code>,
4702             <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
4703             <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
4704             <code class="varname">X11BASE</code>,
4705             <code class="varname">PKG_SYSCONFDIR</code>,
4706             <code class="varname">ROOT_GROUP</code>, and
4707             <code class="varname">ROOT_USER</code>.</p>
4708 <p>You can display a different or additional files by
4709             setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
4710             default is <code class="filename">MESSAGE</code>, if the file
4711             exists.</p>
4712 </dd>
4713 <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
4714 <dd><p>FIXME: There is no documentation on the
4715         alternatives framework.</p></dd>
4716 </dl></div>
4717 </div>
4718 <div class="sect2" title="11.5.2. Files affecting the build process">
4719 <div class="titlepage"><div><div><h3 class="title">
4720 <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
4721 <div class="variablelist"><dl>
4722 <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
4723 <dd><p>This file contains arbitrary things that could
4724         also go into a <code class="filename">Makefile</code>, but its purpose is
4725         to be used by more than one package. This file should only be
4726         used when the packages that will use the file are known in
4727         advance. For other purposes it is often better to write a
4728         <code class="filename">*.mk</code> file and give it a good name that
4729         describes what it does.</p></dd>
4730 <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
4731 <dd><p>This file contains the dependency information
4732         for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
4733 <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
4734 <dd><p>This file contains workarounds for compiler bugs
4735         and similar things. It is included automatically by the pkgsrc
4736         infrastructure, so you don't need an extra
4737         <code class="literal">.include</code> line for
4738         it.</p></dd>
4739 <dt><span class="term"><code class="filename">options.mk</code></span></dt>
4740 <dd><p>This file contains the code for the
4741         package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
4742         selected by the user. If a package has only one or two options,
4743         it is equally acceptable to put the code directly into the
4744         <code class="filename">Makefile</code>.</p></dd>
4745 </dl></div>
4746 </div>
4747 <div class="sect2" title="11.5.3. Files affecting nothing at all">
4748 <div class="titlepage"><div><div><h3 class="title">
4749 <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
4750 <div class="variablelist"><dl>
4751 <dt><span class="term"><code class="filename">README*</code></span></dt>
4752 <dd><p>These files do not take place in the creation of
4753         a package and thus are purely informative to the package
4754         developer.</p></dd>
4755 <dt><span class="term"><code class="filename">TODO</code></span></dt>
4756 <dd><p>This file contains things that need to be done
4757         to make the package even
4758         better.</p></dd>
4759 </dl></div>
4760 </div>
4761 </div>
4762 <div class="sect1" title="11.6. work*">
4763 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4764 <a name="work-dir"></a>11.6. <code class="filename">work*</code>
4765 </h2></div></div></div>
4766 <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
4767     unpacked into the directory denoted by
4768     <code class="varname">WRKDIR</code>. It can be removed by running
4769     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
4770     directory is also used to keep various timestamp files.
4771     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
4772     The default is <code class="filename">${.CURDIR}/work</code>
4773     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
4774     if <code class="varname">OBJMACHINE</code> is set.</p>
4775 </div>
4776 <div class="sect1" title="11.7. files/*">
4777 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4778 <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
4779 </h2></div></div></div>
4780 <p>If you have any files that you wish to be placed in the package prior
4781     to configuration or building, you could place these files here and use
4782     a <span class="command"><strong>${CP}</strong></span> command in the
4783     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
4784     this. Alternatively, you could simply diff the file against
4785     <code class="filename">/dev/null</code> and use the patch mechanism to manage
4786     the creation of this file.</p>
4787 <p>If you want to share files in this way with other
4788     packages, set the <code class="varname">FILESDIR</code> variable to point
4789     to the other package's <code class="filename">files</code> directory,
4790     e.g.:</p>
4791 <pre class="programlisting">
4792 FILESDIR=${.CURDIR}/../xemacs/files
4793 </pre>
4794 </div>
4795 </div>
4796 <div class="chapter" title="Chapter 12. Programming in Makefiles">
4797 <div class="titlepage"><div><div><h2 class="title">
4798 <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
4799 <div class="toc">
4800 <p><b>Table of Contents</b></p>
4801 <dl>
4802 <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
4803 <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
4804 <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
4805 <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
4806 <dd><dl>
4807 <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
4808 <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
4809 <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
4810 <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
4811 <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
4812 </dl></dd>
4813 </dl>
4814 </div>
4815 <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
4816   each of which forms a well-defined part of the pkgsrc system. Using
4817   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
4818   like pkgsrc requires some discipline to keep the code correct and
4819   understandable.</p>
4820 <p>The basic ingredients for <code class="filename">Makefile</code>
4821   programming are variables (which are actually macros) and shell
4822   commands. Among these shell commands may even be more complex ones
4823   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
4824   as intended it is necessary to quote all variables correctly when they
4825   are used.</p>
4826 <p>This chapter describes some patterns, that appear quite often in
4827   <code class="filename">Makefile</code>s, including the pitfalls that come along
4828   with them.</p>
4829 <div class="sect1" title="12.1. Caveats">
4830 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4831 <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
4832 <div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
4833 <p>When you are creating a file as a
4834     target of a rule, always write the data to a temporary file first
4835     and finally rename that file. Otherwise there might occur an error
4836     in the middle of generating the file, and when the user runs
4837     <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
4838     regenerated properly. Example:</p>
4839 <pre class="programlisting">
4840 wrong:
4841         @echo "line 1" &gt; ${.TARGET}
4842         @echo "line 2" &gt;&gt; ${.TARGET}
4843         @false
4844
4845 correct:
4846         @echo "line 1" &gt; ${.TARGET}.tmp
4847         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
4848         @false
4849         @mv ${.TARGET}.tmp ${.TARGET}
4850 </pre>
4851 <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
4852     <code class="filename">wrong</code> will exist, although there was an error
4853     message in the first run. On the other hand, running <span class="command"><strong>make
4854     correct</strong></span> gives an error message twice, as expected.</p>
4855 <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
4856     <code class="literal">${.TARGET}</code> in case of error, but this only
4857     happens when it is interrupted, for example by pressing
4858     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
4859     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>
4860 </li></ul></div>
4861 </div>
4862 <div class="sect1" title="12.2. Makefile variables">
4863 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4864 <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
4865 <p><code class="filename">Makefile</code> variables contain strings that
4866     can be processed using the five operators ``='', ``+='', ``?='',
4867     ``:='', 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
4868     page.</p>
4869 <p>When a variable's value is parsed from a
4870     <code class="filename">Makefile</code>, the hash character ``#'' and the
4871     backslash character ``\'' are handled specially. If a backslash is
4872     followed by a newline, any whitespace immediately in front of the
4873     backslash, the backslash, the newline, and any whitespace
4874     immediately behind the newline are replaced with a single space. A
4875     backslash character and an immediately following hash character are
4876     replaced with a single hash character. Otherwise, the backslash is
4877     passed as is. In a variable assignment, any hash character that is
4878     not preceded by a backslash starts a comment that continues upto the
4879     end of the logical line.</p>
4880 <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
4881     the only way to create a variable consisting of a single backslash
4882     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
4883 <p>So far for defining variables. The other thing you can do with
4884     variables is evaluating them. A variable is evaluated when it is
4885     part of the right side of the ``:='' or the ``!='' operator, or
4886     directly before executing a shell command which the variable is part
4887     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
4888     is, variables are not evaluated until there's no other way. The
4889     ``modifiers'' mentioned in the man page also evaluate the
4890     variable.</p>
4891 <p>Some of the modifiers split the string into words and then
4892     operate on the words, others operate on the string as a whole. When
4893     a string is split into words, it is split as you would expect
4894     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>
4895 <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
4896     loop does not follow the shell quoting rules but splits at sequences
4897     of whitespace.</p>
4898 <p>There are several types of variables that should be handled
4899     differently. Strings and two types of lists.</p>
4900 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4901 <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
4902       characters. Nevertheless, you should restrict yourself to only
4903       using printable characters. Examples are
4904       <code class="varname">PREFIX</code> and
4905       <code class="varname">COMMENT</code>.</p></li>
4906 <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
4907       are never exported to any shell command. Their elements are
4908       separated by whitespace. Therefore, the elements themselves cannot
4909       have embedded whitespace. Any other characters are allowed.
4910       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
4911       Examples are <code class="varname">DEPENDS</code> and
4912       <code class="varname">BUILD_DEPENDS</code>.</p></li>
4913 <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
4914       may be exported to a shell command. Their elements can contain any
4915       characters, including whitespace. That's why they cannot be used
4916       in <span class="command"><strong>.for</strong></span> loops. Examples are
4917       <code class="varname">DISTFILES</code> and
4918       <code class="varname">MASTER_SITES</code>.</p></li>
4919 </ul></div>
4920 <div class="sect2" title="12.2.1. Naming conventions">
4921 <div class="titlepage"><div><div><h3 class="title">
4922 <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
4923 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
4924 <li class="listitem"><p>All variable names starting with an underscore
4925         are reserved for use by the pkgsrc infrastructure. They shall
4926         not be used by package
4927         <code class="filename">Makefile</code>s.</p></li>
4928 <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
4929         lowercase variable names for the iteration
4930         variables.</p></li>
4931 <li class="listitem"><p>All list variables should have a ``plural''
4932         name, e.g. <code class="varname">PKG_OPTIONS</code> or
4933         <code class="varname">DISTFILES</code>.</p></li>
4934 </ul></div>
4935 </div>
4936 </div>
4937 <div class="sect1" title="12.3. Code snippets">
4938 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
4939 <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
4940 <p>This section presents you with some code snippets you should
4941     use in your own code. If you don't find anything appropriate here,
4942     you should test your code and add it here.</p>
4943 <div class="sect2" title="12.3.1. Adding things to a list">
4944 <div class="titlepage"><div><div><h3 class="title">
4945 <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
4946 <pre class="programlisting">
4947 STRING=                 foo * bar `date`
4948 INT_LIST=               # empty
4949 ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
4950 EXT_LIST=               # empty
4951 ANOTHER_EXT_LIST=       a=b c=d
4952
4953 INT_LIST+=              ${STRING}               # 1
4954 INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
4955 EXT_LIST+=              ${STRING:Q}             # 3
4956 EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
4957 </pre>
4958 <p>When you add a string to an external list (example 3), it
4959       must be quoted. In all other cases, you must not add a quoting
4960       level. You must not merge internal and external lists, unless you
4961       are sure that all entries are correctly interpreted in both
4962       lists.</p>
4963 </div>
4964 <div class="sect2" title="12.3.2. Converting an internal list into an external list">
4965 <div class="titlepage"><div><div><h3 class="title">
4966 <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
4967 <pre class="programlisting">
4968 EXT_LIST=       # empty
4969 .for i in ${INT_LIST}
4970 EXT_LIST+=      ${i:Q}""
4971 .endfor
4972 </pre>
4973 <p>This code converts the internal list
4974       <code class="varname">INT_LIST</code> into the external list
4975       <code class="varname">EXT_LIST</code>. As the elements of an internal list
4976       are unquoted they must be quoted here. The reason for appending
4977       <code class="varname">""</code> is explained below.</p>
4978 </div>
4979 <div class="sect2" title="12.3.3. Passing variables to a shell command">
4980 <div class="titlepage"><div><div><h3 class="title">
4981 <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
4982 <p>Sometimes you may want to print an arbitrary string. There
4983         are many ways to get it wrong and only few that can handle every
4984         nastiness.</p>
4985 <pre class="programlisting">
4986 STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
4987 EXT_LIST=       string=${STRING:Q} x=second\ item
4988
4989 all:
4990         echo ${STRING}                  # 1
4991         echo "${STRING}"                # 2
4992         echo "${STRING:Q}"              # 3
4993         echo ${STRING:Q}                # 4
4994         echo x${STRING:Q} | sed 1s,.,,  # 5
4995         printf "%s\\n" ${STRING:Q}""    # 6
4996         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
4997 </pre>
4998 <p>Example 1 leads to a syntax error in the shell, as the
4999       characters are just copied.</p>
5000 <p>Example 2 leads to a syntax error too, and if you leave out
5001       the last " character from <code class="varname">${STRING}</code>,
5002       <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
5003       variable would be evaluated, too.</p>
5004 <p>Example 3 outputs each space character preceded by a
5005       backslash (or not), depending on the implementation of the
5006       <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>
5007 <p>Example 4 handles correctly every string that does not start
5008       with a dash. In that case, the result depends on the
5009       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
5010       guarantee that your input does not start with a dash, this form is
5011       appropriate.</p>
5012 <p>Example 5 handles even the case of a leading dash
5013       correctly.</p>
5014 <p>Example 6 also works with every string and is the
5015       light-weight solution, since it does not involve a pipe, which has
5016       its own problems.</p>
5017 <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
5018       because the quoting has already been done when adding elements to
5019       the list.</p>
5020 <p>As internal lists shall not be passed to the shell, there is
5021       no example for it.</p>
5022 </div>
5023 <div class="sect2" title="12.3.4. Quoting guideline">
5024 <div class="titlepage"><div><div><h3 class="title">
5025 <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
5026 <p>There are many possible sources of wrongly quoted variables.
5027       This section lists some of the commonly known ones.</p>
5028 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5029 <li class="listitem">
5030 <p>Whenever you use the value of a list, think
5031         about what happens to leading or trailing whitespace. If the
5032         list is a well-formed shell expression, you can apply the
5033         <code class="varname">:M*</code> modifier to strip leading and trailing
5034         whitespace from each word. The <code class="varname">:M</code> operator
5035         first splits its argument according to the rules of the shell,
5036         and then creates a new list consisting of all words that match
5037         the shell glob expression <code class="varname">*</code>, that is: all.
5038         One class of situations where this is needed is when adding a
5039         variable like <code class="varname">CPPFLAGS</code> to
5040         <code class="varname">CONFIGURE_ARGS</code>. If the configure script
5041         invokes other configure scripts, it strips the leading and
5042         trailing whitespace from the variable and then passes it to the
5043         other configure scripts. But these configure scripts expect the
5044         (child) <code class="varname">CPPFLAGS</code> variable to be the same as
5045         the parent <code class="varname">CPPFLAGS</code>. That's why we better
5046         pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
5047         here is how we do it:</p>
5048 <pre class="programlisting">
5049 CPPFLAGS=               # empty
5050 CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
5051 CPPFLAGS+=              ${MY_CPPFLAGS}
5052
5053 CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
5054
5055 all:
5056         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
5057         echo x${CONFIGURE_ARGS}x        # properly trimmed
5058 </pre>
5059 </li>
5060 <li class="listitem"><p>The example above contains one bug: The
5061         <code class="varname">${PREFIX}</code> is a properly quoted shell
5062         expression, but there is the C compiler after it, which also
5063         expects a properly quoted string (this time in C syntax). The
5064         version above is therefore only correct if
5065         <code class="varname">${PREFIX}</code> does not have embedded backslashes
5066         or double quotes. If you want to allow these, you have to add
5067         another layer of quoting to each variable that is used as a C
5068         string literal. You cannot use the <code class="varname">:Q</code>
5069         operator for it, as this operator only works for the
5070         shell.</p></li>
5071 <li class="listitem">
5072 <p>Whenever a variable can be empty, the
5073         <code class="varname">:Q</code> operator can have surprising results. Here
5074         are two completely different cases which can be solved with the
5075         same trick.</p>
5076 <pre class="programlisting">
5077 EMPTY=                  # empty
5078 empty_test:
5079         for i in a ${EMPTY:Q} c; do \
5080             echo "$$i"; \
5081         done
5082
5083 for_test:
5084 .for i in a:\ a:\test.txt
5085         echo ${i:Q}
5086         echo "foo"
5087 .endfor
5088 </pre>
5089 <p>The first example will only print two of the three lines
5090         we might have expected. This is because
5091         <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
5092         the shell cannot see. The workaround is to write
5093         <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
5094         as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
5095         -f ${FNAME:Q}</code> (both of these are wrong).</p>
5096 <p>The second example will only print three lines instead of
5097         four. The first line looks like <code class="varname">a:\ echo foo</code>.
5098         This is because the backslash of the value
5099         <code class="varname">a:\</code> is interpreted as a line-continuation by
5100         <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
5101         <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
5102         <code class="varname">${i:Q}""</code>.</p>
5103 </li>
5104 </ul></div>
5105 </div>
5106 <div class="sect2" title="12.3.5. Workaround for a bug in BSD Make">
5107 <div class="titlepage"><div><div><h3 class="title">
5108 <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
5109 <p>The pkgsrc bmake program does not handle the following
5110       assignment correctly. In case <code class="varname">_othervar_</code>
5111       contains a ``-'' character, one of the closing braces is included
5112       in <code class="varname">${VAR}</code> after this code executes.</p>
5113 <pre class="programlisting">
5114 VAR:=   ${VAR:N${_othervar_:C/-//}}
5115 </pre>
5116 <p>For a more complex code snippet and a workaround, see the
5117       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
5118       <code class="varname">bug1</code>.</p>
5119 </div>
5120 </div>
5121 </div>
5122 <div class="chapter" title="Chapter 13. PLIST issues">
5123 <div class="titlepage"><div><div><h2 class="title">
5124 <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
5125 <div class="toc">
5126 <p><b>Table of Contents</b></p>
5127 <dl>
5128 <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
5129 <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
5130 <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>
5131 <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
5132 <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
5133 <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
5134 <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
5135 <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
5136 </dl>
5137 </div>
5138 <p>The <code class="filename">PLIST</code> file contains a package's
5139   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
5140   the package (relative to the <code class="filename">${PREFIX}</code>
5141   directory it's been installed in) plus some additional statements
5142   - 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.
5143   This chapter addresses some issues that need attention when
5144   dealing with the <code class="filename">PLIST</code> file (or files, see
5145   below!).</p>
5146 <div class="sect1" title="13.1. RCS ID">
5147 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5148 <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
5149 <p>Be sure to add a RCS ID line as the first thing in any
5150     <code class="filename">PLIST</code> file you write:</p>
5151 <pre class="programlisting">
5152 @comment $NetBSD$
5153     </pre>
5154 </div>
5155 <div class="sect1" title="13.2. Semi-automatic PLIST generation">
5156 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5157 <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
5158 <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
5159     to output a PLIST that matches any new files since the package
5160     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
5161     more information on this target.</p>
5162 </div>
5163 <div class="sect1" title="13.3. Tweaking output of make print-PLIST">
5164 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5165 <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
5166 </h2></div></div></div>
5167 <p>If you have used any of the *-dirs packages, as explained in
5168     <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
5169     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
5170     <code class="varname">@comment</code>s instead of real
5171     <code class="varname">@dirrm</code> lines.  You can also do this for
5172     specific directories and files, so that the results of that
5173     command are very close to reality. This helps <span class="emphasis"><em>a
5174     lot</em></span> during the update of packages.</p>
5175 <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
5176     of AWK patterns and actions that are used to filter the output of
5177     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
5178     scripting you like to it, but be careful with quoting.</p>
5179 <p>For example, to get all files inside the
5180     <code class="filename">libdata/foo</code> directory removed from the
5181     resulting PLIST:</p>
5182 <pre class="programlisting">
5183 PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
5184     </pre>
5185 <p>And to get all the <code class="varname">@dirrm</code> lines referring
5186     to a specific (shared) directory converted to
5187     <code class="varname">@comment</code>s:</p>
5188 <pre class="programlisting">
5189 PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
5190     </pre>
5191 </div>
5192 <div class="sect1" title="13.4. Variable substitution in PLIST">
5193 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5194 <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
5195 <p>A number of variables are substituted automatically in
5196     PLISTs when a package is installed on a system. This includes the
5197     following variables:</p>
5198 <div class="variablelist"><dl>
5199 <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
5200 <dd>
5201 <p>Some packages like emacs and perl embed information
5202           about which architecture they were built on into the
5203           pathnames where they install their files. To handle this
5204           case, PLIST will be preprocessed before actually used, and
5205           the symbol
5206           <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
5207           replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
5208           same is done if the string
5209           <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
5210           PLIST somewhere - use this on packages that have GNU
5211           autoconf-created configure scripts.</p>
5212 <div class="note" title="Legacy note" style="margin-left: 0.5in; margin-right: 0.5in;">
5213 <h3 class="title">Legacy note</h3>
5214 <p>There used to be a symbol
5215             <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
5216             was replaced by the output of <span class="command"><strong>uname
5217             -m</strong></span>, but that's no longer supported and has
5218             been removed.</p>
5219 </div>
5220 </dd>
5221 <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
5222 <dd>
5223 <p>Some packages want to embed the OS name and version
5224           into some paths.  To do this, use these variables in the
5225           <code class="filename">PLIST</code>:
5226           </p>
5227 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5228 <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>
5229 <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>
5230 <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>
5231 </ul></div>
5232 </dd>
5233 </dl></div>
5234 <p>For a complete list of values which are replaced by
5235     default, please look in <code class="filename">bsd.pkg.mk</code> (and
5236     search for <code class="varname">PLIST_SUBST</code>).</p>
5237 <p>If you want to change other variables not listed above, you
5238     can add variables and their expansions to this variable in the
5239     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>
5240 <pre class="programlisting">
5241 PLIST_SUBST+=   SOMEVAR="somevalue"
5242     </pre>
5243 <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
5244     in the <code class="filename">PLIST</code> with
5245     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
5246 <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
5247     the common case of conditionally including some
5248     <code class="filename">PLIST</code> entries. It can be done by adding
5249     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
5250     setting the corresponding <code class="varname">PLIST.foo</code> variable
5251     to <code class="literal">yes</code> if the entry should be included.
5252     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
5253     in the <code class="filename">PLIST</code> with either
5254     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
5255     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
5256     For example, in <code class="filename">Makefile</code>:</p>
5257 <pre class="programlisting">
5258 PLIST_VARS+=    foo
5259 .if <em class="replaceable"><code>condition</code></em>
5260 PLIST.foo=      yes
5261 .else
5262     </pre>
5263 <p>And then in <code class="filename">PLIST</code>:</p>
5264 <pre class="programlisting">
5265 @comment $NetBSD$
5266 bin/bar
5267 man/man1/bar.1
5268 ${PLIST.foo}bin/foo
5269 ${PLIST.foo}man/man1/foo.1
5270 ${PLIST.foo}share/bar/foo.data
5271 ${PLIST.foo}@dirrm share/bar
5272     </pre>
5273 </div>
5274 <div class="sect1" title="13.5. Man page compression">
5275 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5276 <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
5277 <p>Man pages should be installed in compressed form if
5278     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
5279     and uncompressed otherwise. To handle this in the
5280     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
5281     appended/removed automatically for man pages according to
5282     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
5283     or not, see above for details. This modification of the
5284     <code class="filename">PLIST</code> file is done on a copy of it, not
5285     <code class="filename">PLIST</code> itself.</p>
5286 </div>
5287 <div class="sect1" title="13.6. Changing PLIST source with PLIST_SRC">
5288 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5289 <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
5290 </h2></div></div></div>
5291 <p>To use one or more files as source for the <code class="filename">PLIST</code> used
5292     in generating the binary package, set the variable
5293     <code class="varname">PLIST_SRC</code> to the names of that file(s).
5294     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
5295     important. The default for <code class="varname">PLIST_SRC</code> is
5296     <code class="filename">${PKGDIR}/PLIST</code>.</p>
5297 </div>
5298 <div class="sect1" title="13.7. Platform-specific and differing PLISTs">
5299 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5300 <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
5301 <p>Some packages decide to install a different set of files based on
5302     the operating system being used. These differences can be
5303     automatically handled by using the following files:</p>
5304 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5305 <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
5306 <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
5307 <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
5308 <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
5309 <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
5310 </ul></div>
5311 </div>
5312 <div class="sect1" title="13.8. Sharing directories between packages">
5313 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5314 <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
5315 <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
5316     multiple (and unrelated) packages install files.  These
5317     directories were problematic because you had to add special
5318     tricks in the PLIST to conditionally remove them, or have some
5319     centralized package handle them.</p>
5320 <p>In pkgsrc, it is now easy: Each package should create
5321     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
5322     will remove any directories left empty after uninstalling a
5323     package.</p>
5324 <p>If a package needs an empty directory to work, create
5325     the directory during installation as usual, and also add an
5326     entry to the PLIST:
5327     </p>
5328 <pre class="programlisting">
5329 @pkgdir path/to/empty/directory
5330     </pre>
5331 <p>
5332     </p>
5333 </div>
5334 </div>
5335 <div class="chapter" title="Chapter 14. Buildlink methodology">
5336 <div class="titlepage"><div><div><h2 class="title">
5337 <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
5338 <div class="toc">
5339 <p><b>Table of Contents</b></p>
5340 <dl>
5341 <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
5342 <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
5343 <dd><dl>
5344 <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
5345 <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
5346       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5347       and
5348       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5349       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
5350 </dl></dd>
5351 <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
5352 <dd><dl>
5353 <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>
5354 <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
5355 </dl></dd>
5356 </dl>
5357 </div>
5358 <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
5359   are seen by a package's configure and build processes.  This is implemented
5360   in a two step process:</p>
5361 <div class="orderedlist"><ol class="orderedlist" type="1">
5362 <li class="listitem"><p>Symlink headers and libraries for dependencies into
5363       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
5364       of <code class="varname">WRKDIR</code>.</p></li>
5365 <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
5366       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
5367       <code class="option">-L${LOCALBASE}/lib</code> into references to
5368       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
5369       native compiler on some operating systems look like GCC, so that
5370       packages that expect GCC won't require modifications to build with
5371       those native compilers.</p></li>
5372 </ol></div>
5373 <p>This normalizes the environment in which a package is built so that the
5374   package may be built consistently despite what other software may be
5375   installed. Please note that the normal system header and library paths,
5376   e.g. <code class="filename">/usr/include</code>,
5377   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
5378   designed to insulate the package build from non-system-supplied
5379   software.</p>
5380 <div class="sect1" title="14.1. Converting packages to use buildlink3">
5381 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5382 <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
5383 <p>The process of converting packages to use the buildlink3
5384     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
5385     The things to keep in mind are:</p>
5386 <div class="orderedlist"><ol class="orderedlist" type="1">
5387 <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
5388         instead of the actual toolchain.  Some packages are tricky,
5389         and the only way to know for sure is the check
5390         <code class="filename">${WRKDIR}/.work.log</code> to see if the
5391         wrappers are being invoked.</p></li>
5392 <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
5393         the package Makefile, e.g. Java VMs, standalone shells,
5394         etc., because the code to symlink files into
5395         <code class="filename">${BUILDLINK_DIR}</code> looks for files
5396         relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
5397         </p></li>
5398 <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
5399         <code class="filename">buildlink3.mk</code> files that you list in a
5400         package's Makefile are added as dependencies for that package.
5401         </p></li>
5402 </ol></div>
5403 <p>If a dependency on a particular package is required for its libraries and
5404     headers, then we replace:</p>
5405 <pre class="programlisting">
5406 DEPENDS+=       foo&gt;=1.1.0:../../category/foo
5407 </pre>
5408 <p>with</p>
5409 <pre class="programlisting">
5410 .include "../../category/foo/buildlink3.mk"
5411 </pre>
5412 <p>The buildlink3.mk files usually define the required dependencies.
5413     If you need a newer version of the dependency when using buildlink3.mk
5414     files, then you can define it in your Makefile; for example:</p>
5415 <pre class="programlisting">
5416 BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
5417 .include "../../category/foo/buildlink3.mk"
5418 </pre>
5419 <p>There are several <code class="filename">buildlink3.mk</code>
5420     files in <code class="filename">pkgsrc/mk</code>
5421     that handle special package issues:</p>
5422 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5423 <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
5424         the native or a pkgsrc Berkeley DB implementation based on
5425         the values of <code class="varname">BDB_ACCEPTED</code> and
5426         <code class="varname">BDB_DEFAULT</code>.</p></li>
5427 <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
5428         comes with neither Curses nor NCurses, this will take care
5429         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>
5430 <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
5431         of <code class="varname">KRB5_ACCEPTED</code> to choose between
5432         adding a dependency on Heimdal or MIT-krb5 for packages that
5433         require a Kerberos 5 implementation.</p></li>
5434 <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
5435         system-provided Motif installation or adds a dependency on
5436         <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
5437         <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
5438         <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
5439         which Motif version will be used.</p></li>
5440 <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
5441         variables that may be used by packages that use the
5442         Open Sound System (OSS) API.</p></li>
5443 <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
5444         either Postgres 8.0, 8.1, or 8.2, whichever is found installed. See
5445         the file for more information.</p></li>
5446 <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
5447         <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
5448         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>
5449 <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
5450         <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
5451         library.</p></li>
5452 </ul></div>
5453 <p>The comments in those <code class="filename">buildlink3.mk</code>
5454     files provide a more complete
5455     description of how to use them properly.</p>
5456 </div>
5457 <div class="sect1" title="14.2. Writing buildlink3.mk files">
5458 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5459 <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
5460 <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
5461     included by Makefiles to indicate the need to compile and link
5462     against header files and libraries provided by the package.  A
5463     <code class="filename">buildlink3.mk</code> file should always provide
5464     enough information to add the correct type of dependency
5465     relationship and include any other
5466     <code class="filename">buildlink3.mk</code> files that it needs to find
5467     headers and libraries that it needs in turn.</p>
5468 <p>To generate an initial <code class="filename">buildlink3.mk</code>
5469     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>
5470     package is highly recommended.  For most packages, the following
5471     command will generate a good starting point for
5472     <code class="filename">buildlink3.mk</code> files:</p>
5473 <pre class="screen">
5474 <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
5475 <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
5476     </pre>
5477 <div class="sect2" title="14.2.1. Anatomy of a buildlink3.mk file">
5478 <div class="titlepage"><div><div><h3 class="title">
5479 <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
5480 <p>The following real-life example
5481       <code class="filename">buildlink3.mk</code> is taken
5482       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
5483 <pre class="programlisting">
5484 # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
5485
5486 BUILDLINK_TREE+=        tiff
5487
5488 .if !defined(TIFF_BUILDLINK3_MK)
5489 TIFF_BUILDLINK3_MK:=
5490
5491 BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
5492 BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
5493 BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
5494
5495 .include "../../devel/zlib/buildlink3.mk"
5496 .include "../../graphics/jpeg/buildlink3.mk"
5497 .endif # TIFF_BUILDLINK3_MK
5498
5499 BUILDLINK_TREE+=        -tiff
5500 </pre>
5501 <p>The header and footer manipulate
5502       <code class="varname">BUILDLINK_TREE</code>, which is common across all
5503       <code class="filename">buildlink3.mk</code> files and is used to track
5504       the dependency tree.</p>
5505 <p>The main section is protected from multiple inclusion
5506       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
5507       added.  Several important variables are set in the section:</p>
5508 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5509 <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5510           is the actual dependency recorded in the installed
5511           package; this should always be set using
5512           <span class="command"><strong>+=</strong></span> to ensure that
5513           we're appending to any pre-existing list of values.  This
5514           variable should be set to the first version of the
5515           package that had an backwards-incompatible API change.
5516           </p></li>
5517 <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
5518           is the location of the <em class="replaceable"><code>pkg</code></em>
5519           pkgsrc directory.</p></li>
5520 <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5521           (not shown above) controls whether we use
5522           <code class="varname">BUILD_DEPENDS</code> or
5523           <code class="varname">DEPENDS</code> to add the dependency on
5524           <em class="replaceable"><code>pkg</code></em>.  The build dependency is
5525           selected by setting
5526           <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
5527           to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
5528           used.</p></li>
5529 <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
5530             and
5531             <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
5532             (not shown above) are lists of subdirectories of
5533             <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5534             to add to the header and library search paths.  These
5535             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>
5536           respectively.</p></li>
5537 <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
5538             (not shown above) is the list of preprocessor flags to add
5539             to <code class="varname">CPPFLAGS</code>, which are passed on to the
5540             configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
5541             should be avoided and instead be handled using
5542             <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
5543           above.</p></li>
5544 </ul></div>
5545 <p>The following variables are all optionally defined within
5546       this second section (protected against multiple inclusion) and
5547       control which package files are symlinked into
5548       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
5549       transformed during the symlinking:</p>
5550 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5551 <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
5552             (not shown above) is a shell glob pattern relative to
5553             <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5554             to be symlinked into
5555             <code class="filename">${BUILDLINK_DIR}</code>,
5556           e.g. <code class="filename">include/*.h</code>.</p></li>
5557 <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
5558             (not shown above) is a shell pipeline that
5559             outputs to stdout a list of files relative to
5560             <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
5561             The resulting files are to be symlinked
5562             into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
5563             this takes the <code class="filename">+CONTENTS</code> of a
5564             <em class="replaceable"><code>pkg</code></em> and filters it through
5565             <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
5566 <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5567             (not shown above) is a filter command that filters
5568             <code class="filename">+CONTENTS</code> input into a list of files
5569             relative to
5570             <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
5571             on stdout.  By default for overwrite packages,
5572             <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
5573             outputs the contents of the <code class="filename">include</code>
5574             and <code class="filename">lib</code> directories in the package
5575             <code class="filename">+CONTENTS</code>, and for pkgviews packages,
5576             it outputs any libtool archives in
5577             <code class="filename">lib</code> directories.</p></li>
5578 <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
5579             (not shown above) is a list of sed arguments used to
5580             transform the name of the source filename into a
5581             destination filename, e.g. <span class="command"><strong>-e
5582             "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
5583 </ul></div>
5584 <p>This section can additionally include any
5585       <code class="filename">buildlink3.mk</code> needed for
5586       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
5587       Including these <code class="filename">buildlink3.mk</code> files
5588       means that the headers and libraries for these
5589       dependencies are also symlinked into
5590       <code class="filename">${BUILDLINK_DIR}</code>
5591       whenever the <em class="replaceable"><code>pkg</code></em>
5592       <code class="filename">buildlink3.mk</code>
5593       file is included. Dependencies are only added for directly
5594       include <code class="filename">buildlink3.mk</code> files.</p>
5595 </div>
5596 <div class="sect2" title="14.2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in buildlink3.mk files">
5597 <div class="titlepage"><div><div><h3 class="title">
5598 <a name="updating-buildlink-depends"></a>14.2.2. Updating
5599       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5600       and
5601       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5602       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
5603 <p>These two variables differ in that one describes source
5604       compatibility (API) and the other binary compatibility (ABI).
5605       The difference is that a change in the API breaks compilation of
5606       programs while changes in the ABI stop compiled programs from
5607       running.</p>
5608 <p>Changes to the
5609       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5610       variable in a <code class="filename">buildlink3.mk</code> file happen
5611       very rarely. One possible reason is that all packages depending
5612       on this already need a newer version. In case it is bumped see
5613       the description below.</p>
5614 <p>The most common example of an ABI change is that the major
5615       version of a shared library is increased. In this case,
5616       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5617       should be adjusted to require at least the new package version.
5618       Then the packages that depend on this package need their
5619       <code class="varname">PKGREVISION</code>s increased and, if they have
5620       <code class="filename">buildlink3.mk</code> files, their
5621       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5622       adjusted, too. This is needed so pkgsrc will require the correct
5623       package dependency and not settle for an older one when building
5624       the source.</p>
5625 <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
5626       more information about dependencies on other packages,
5627       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
5628       <code class="varname">ABI_DEPENDS</code> definitions.</p>
5629 <p>Please take careful consideration before adjusting
5630       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5631       or
5632       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5633       as we don't want to cause unneeded package deletions and
5634       rebuilds.  In many cases, new versions of packages work just
5635       fine with older dependencies.</p>
5636 <p>Also it is not needed to set
5637       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
5638       when it is identical to
5639       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>. </p>
5640 </div>
5641 </div>
5642 <div class="sect1" title="14.3. Writing builtin.mk files">
5643 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5644 <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
5645 <p>Some packages in pkgsrc install headers and libraries that
5646       coincide with headers and libraries present in the base system.
5647       Aside from a <code class="filename">buildlink3.mk</code> file, these
5648       packages should also include a <code class="filename">builtin.mk</code>
5649       file that includes the necessary checks to decide whether using
5650       the built-in software or the pkgsrc software is
5651     appropriate.</p>
5652 <p>The only requirements of a builtin.mk file for
5653     <em class="replaceable"><code>pkg</code></em> are:</p>
5654 <div class="orderedlist"><ol class="orderedlist" type="1">
5655 <li class="listitem"><p>It should set
5656         <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5657         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>
5658         after it is included.</p></li>
5659 <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
5660         <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5661         which is already set before the
5662         <code class="filename">builtin.mk</code> file is included.</p></li>
5663 <li class="listitem"><p>It should be written to allow multiple inclusion.  This
5664         is <span class="emphasis"><em>very</em></span> important and takes careful
5665         attention to <code class="filename">Makefile</code> coding.</p></li>
5666 </ol></div>
5667 <div class="sect2" title="14.3.1. Anatomy of a builtin.mk file">
5668 <div class="titlepage"><div><div><h3 class="title">
5669 <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
5670 <p>The following is the recommended template for builtin.mk
5671       files:</p>
5672 <pre class="programlisting">
5673 .if !defined(IS_BUILTIN.foo)
5674 #
5675 # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
5676 # genuinely exists in the system or not.
5677 #
5678 IS_BUILTIN.foo?=        no
5679
5680 # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
5681 # version can be determined.
5682 #
5683 .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
5684 BUILTIN_PKG.foo?=       foo-1.0
5685 .  endif
5686 .endif  # IS_BUILTIN.foo
5687
5688 .if !defined(USE_BUILTIN.foo)
5689 USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
5690 .  if defined(BUILTIN_PKG.foo)
5691 .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
5692 .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
5693 USE_BUILTIN.foo!=                                                       \
5694         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
5695         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
5696 .      endif
5697 .    endfor
5698 .  endif
5699 .endif  # USE_BUILTIN.foo
5700
5701 CHECK_BUILTIN.foo?=     no
5702 .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
5703 #
5704 # Here we place code that depends on whether USE_BUILTIN.foo is set to
5705 # "yes" or "no".
5706 #
5707 .endif  # CHECK_BUILTIN.foo
5708 </pre>
5709 <p>The first section sets
5710       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5711       depending on if <em class="replaceable"><code>pkg</code></em> really exists
5712       in the base system.  This should not be a base system software
5713       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
5714       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
5715       included as part of the base system.  This variable is only
5716       used internally within the <code class="filename">builtin.mk</code>
5717       file.</p>
5718 <p>The second section sets
5719       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5720       to the version of <em class="replaceable"><code>pkg</code></em> in the base
5721       system if it exists (if
5722       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5723       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
5724       within the <code class="filename">builtin.mk</code> file.</p>
5725 <p>The third section sets
5726       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5727       and is <span class="emphasis"><em>required</em></span> in all
5728       <code class="filename">builtin.mk</code> files.  The code in this
5729       section must make the determination whether the built-in
5730       software is adequate to satisfy the dependencies listed in
5731       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5732       This is typically done by comparing
5733       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
5734       against each of the dependencies in
5735       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
5736       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5737       <span class="emphasis"><em>must</em></span> be set to the correct value by the
5738       end of the <code class="filename">builtin.mk</code> file.  Note that
5739       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5740       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
5741       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5742       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
5743       that the built-in version of the software is similar enough to
5744       be used as a replacement.</p>
5745 <p>The last section is guarded by
5746       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
5747       and includes code that uses the value of
5748       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
5749       set in the previous section.  This typically includes, e.g.,
5750       adding additional dependency restrictions and listing additional
5751       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
5752       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
5753 </div>
5754 <div class="sect2" title="14.3.2. Global preferences for native or pkgsrc software">
5755 <div class="titlepage"><div><div><h3 class="title">
5756 <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
5757 <p>When building packages, it's possible to choose whether to set
5758         a global preference for using either the built-in (native)
5759         version or the pkgsrc version of software to satisfy a
5760         dependency.  This is controlled by setting
5761         <code class="varname">PREFER_PKGSRC</code> and
5762         <code class="varname">PREFER_NATIVE</code>.  These variables take values
5763         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
5764         packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
5765         use the pkgsrc versions of software, while
5766         <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
5767         built-in versions.  Preferences are determined by the most
5768         specific instance of the package in either
5769         <code class="varname">PREFER_PKGSRC</code> or
5770         <code class="varname">PREFER_NATIVE</code>.  If a package is specified
5771         in neither or in both variables, then
5772         <code class="varname">PREFER_PKGSRC</code> has precedence over
5773         <code class="varname">PREFER_NATIVE</code>.  For example, to require
5774         using pkgsrc versions of software for all but the most basic
5775       bits on a NetBSD system, you can set:</p>
5776 <pre class="programlisting">
5777 PREFER_PKGSRC=  yes
5778 PREFER_NATIVE=  getopt skey tcp_wrappers
5779 </pre>
5780 <p>A package <span class="emphasis"><em>must</em></span> have a
5781       <code class="filename">builtin.mk</code>
5782       file to be listed in <code class="varname">PREFER_NATIVE</code>,
5783       otherwise it is simply ignored in that list.</p>
5784 </div>
5785 </div>
5786 </div>
5787 <div class="chapter" title="Chapter 15. The pkginstall framework">
5788 <div class="titlepage"><div><div><h2 class="title">
5789 <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
5790 <div class="toc">
5791 <p><b>Table of Contents</b></p>
5792 <dl>
5793 <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
5794 <dd><dl>
5795 <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
5796 <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
5797 </dl></dd>
5798 <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
5799 <dd><dl>
5800 <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
5801 <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
5802 <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
5803 <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
5804 </dl></dd>
5805 <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
5806 <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>
5807 <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
5808 <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
5809 <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
5810 <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
5811 <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>
5812 </dl>
5813 </div>
5814 <p>This chapter describes the framework known as
5815 <code class="literal">pkginstall</code>, whose key features are:</p>
5816 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5817 <li class="listitem"><p>Generic installation and manipulation of directories and files
5818     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
5819 <li class="listitem"><p>Automatic handling of configuration files during installation,
5820     provided that packages are correctly designed.</p></li>
5821 <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
5822 <li class="listitem"><p>Registration of system users and groups.</p></li>
5823 <li class="listitem"><p>Registration of system shells.</p></li>
5824 <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
5825 </ul></div>
5826 <p>The following sections inspect each of the above points in detail.</p>
5827 <p>You may be thinking that many of the things described here could be
5828 easily done with simple code in the package's post-installation target
5829 (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
5830 as the code in them is only executed when building from source.  Machines
5831 using binary packages could not benefit from it at all (as the code itself
5832 could be unavailable).  Therefore, the only way to achieve any of the items
5833 described above is by means of the installation scripts, which are
5834 automatically generated by pkginstall.</p>
5835 <div class="sect1" title="15.1. Files and directories outside the installation prefix">
5836 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5837 <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
5838 <p>As you already know, the <code class="filename">PLIST</code> file holds a list
5839 of files and directories that belong to a package.  The names used in it
5840 are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
5841 which means that it cannot register files outside this directory (absolute
5842 path names are not allowed).  Despite this restriction, some packages need
5843 to install files outside this location; e.g., under
5844 <code class="filename">${VARBASE}</code> or
5845 <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
5846 is to create such files during installation time by using
5847 installation scripts.</p>
5848 <p>The generic installation scripts are shell scripts that can
5849 contain arbitrary code.  The list of scripts to execute is taken from
5850 the <code class="varname">INSTALL_FILE</code> variable, which defaults to
5851 <code class="filename">INSTALL</code>.  A similar variable exists for package
5852 removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
5853 <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
5854 commands, so they have the potential to create and manage files
5855 anywhere in the file system.</p>
5856 <p>Using these general installation files is not recommended, but
5857 may be needed in some special cases.  One reason for avoiding them is
5858 that the user has to trust the packager that there is no unwanted or
5859 simply erroneous code included in the installation script. Also,
5860 previously there were many similar scripts for the same functionality,
5861 and fixing a common error involved finding and changing all of
5862 them.</p>
5863 <p>The pkginstall framework offers another, standardized way.  It
5864 provides generic scripts to abstract the manipulation of such files
5865 and directories based on variables set in the package's
5866 <code class="filename">Makefile</code>.  The rest of this section describes
5867 these variables.</p>
5868 <div class="sect2" title="15.1.1. Directory manipulation">
5869 <div class="titlepage"><div><div><h3 class="title">
5870 <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
5871 <p>The following variables can be set to request the creation of
5872 directories anywhere in the file system:</p>
5873 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5874 <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
5875     contain a list of directories that should be created and should attempt
5876     to be destroyed by the installation scripts.  The difference between
5877     the two is that the latter prompts the administrator to remove any
5878     directories that may be left after deinstallation (because they were
5879     not empty), while the former does not.</p></li>
5880 <li class="listitem">
5881 <p><code class="varname">MAKE_DIRS_PERMS</code> and
5882     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
5883     which directories should be created and should attempt to be destroyed
5884     by the installation scripts.  Each tuple holds the following values,
5885     separated by spaces: the directory name, its owner, its group and its
5886     numerical mode.  For example:</p>
5887 <pre class="programlisting">
5888 MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
5889 </pre>
5890 <p>The difference between the two is exactly the same as their
5891     non-<code class="varname">PERMS</code> counterparts.</p>
5892 </li>
5893 </ul></div>
5894 </div>
5895 <div class="sect2" title="15.1.2. File manipulation">
5896 <div class="titlepage"><div><div><h3 class="title">
5897 <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
5898 <p>Creating non-empty files outside the installation prefix is tricky
5899 because the <code class="filename">PLIST</code> forces all files to be inside it.
5900 To overcome this problem, the only solution is to extract the file in the
5901 known place (i.e., inside the installation prefix) and copy it to the
5902 appropriate location during installation (done by the installation scripts
5903 generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
5904 file</em></span> in the following paragraphs, which describe the variables
5905 that can be used to automatically and consistently handle files outside the
5906 installation prefix:</p>
5907 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5908 <li class="listitem">
5909 <p><code class="varname">CONF_FILES</code> and
5910     <code class="varname">SUPPORT_FILES</code> are pairs of master and target files.
5911     During installation time, the master file is copied to the target one
5912     if and only if the latter does not exist.  Upon deinstallation, the
5913     target file is removed provided that it was not modified by the
5914     installation.</p>
5915 <p>The difference between the two is that the latter prompts the
5916     administrator to remove any files that may be left after
5917     deinstallation (because they were not empty), while the former does
5918     not.</p>
5919 </li>
5920 <li class="listitem">
5921 <p><code class="varname">CONF_FILES_PERMS</code> and
5922     <code class="varname">SUPPORT_FILES_PERMS</code> contain tuples describing master
5923     files as well as their target locations.  For each of them, it also
5924     specifies their owner, their group and their numeric permissions, in
5925     this order.  For example:</p>
5926 <pre class="programlisting">
5927 SUPPORT_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
5928 </pre>
5929 <p>The difference between the two is exactly the same as their
5930     non-<code class="varname">PERMS</code> counterparts.</p>
5931 </li>
5932 </ul></div>
5933 </div>
5934 </div>
5935 <div class="sect1" title="15.2. Configuration files">
5936 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
5937 <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
5938 <p>Configuration files are special in the sense that they are installed
5939 in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
5940 need special treatment during installation (most of which is automated by
5941 pkginstall).  The main concept you must bear in mind is that files marked
5942 as configuration files are automatically copied to the right place (somewhere
5943 inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
5944 and only if</em></span> they didn't exist before.  Similarly, they will not
5945 be removed if they have local modifications.  This ensures that
5946 administrators never lose any custom changes they may have made.</p>
5947 <div class="sect2" title="15.2.1. How PKG_SYSCONFDIR is set">
5948 <div class="titlepage"><div><div><h3 class="title">
5949 <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
5950 <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
5951 specifies where configuration files shall be installed.  Its contents are
5952 set based upon the following variables:</p>
5953 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
5954 <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
5955     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
5956     be overridden by the user to point to his preferred location (e.g.,
5957     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
5958     Packages must not use it directly.</p></li>
5959 <li class="listitem">
5960 <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
5961     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
5962     for the package being built shall be installed.  The definition of this
5963     variable only makes sense in the package's
5964     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
5965 <p>As an example, consider the Apache package,
5966     <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
5967     configuration files under the
5968     <code class="filename">httpd/</code> subdirectory of
5969     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
5970     Makefile.</p>
5971 </li>
5972 <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
5973     variable that holds this package's configuration directory (if
5974     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
5975     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
5976     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
5977 <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
5978     directory where the configuration files for the package identified by
5979     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
5980 </ul></div>
5981 <p>Based on the above variables, pkginstall determines the value of
5982 <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
5983 variable that can be used within a package to refer to its configuration
5984 directory.  The algorithm used to set its value is basically the
5985 following:</p>
5986 <div class="orderedlist"><ol class="orderedlist" type="1">
5987 <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
5988     its value is used.</p></li>
5989 <li class="listitem"><p>If the previous variable is not defined but
5990     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
5991     <code class="filename">Makefile</code>, the resulting value is
5992     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
5993 <li class="listitem"><p>Otherwise, it is set to
5994     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
5995 </ol></div>
5996 <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
5997 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
5998 subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
5999 be created with OWN_DIRS or MAKE_DIRS.</p>
6000 </div>
6001 <div class="sect2" title="15.2.2. Telling the software where configuration files are">
6002 <div class="titlepage"><div><div><h3 class="title">
6003 <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
6004 <p>Given that pkgsrc (and users!) expect configuration files to be in a
6005 known place, you need to teach each package where it shall install its
6006 files.  In some cases you will have to patch the package Makefiles to
6007 achieve it.  If you are lucky, though, it may be as easy as passing an
6008 extra flag to the configuration script; this is the case of GNU Autoconf-
6009 generated files:</p>
6010 <pre class="programlisting">
6011 CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
6012 </pre>
6013 <p>Note that this specifies where the package has to <span class="emphasis"><em>look
6014 for</em></span> its configuration files, not where they will be originally
6015 installed (although the difference is never explicit,
6016 unfortunately).</p>
6017 </div>
6018 <div class="sect2" title="15.2.3. Patching installations">
6019 <div class="titlepage"><div><div><h3 class="title">
6020 <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
6021 <p>As said before, pkginstall automatically handles configuration files.
6022 This means that <span class="strong"><strong>the packages themselves must not
6023 touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
6024 directly</strong></span>.  Bad news is that many software installation scripts
6025 will, out of the box, mess with the contents of that directory.  So what is
6026 the correct procedure to fix this issue?</p>
6027 <p>You must teach the package (usually by manually patching it) to
6028 install any configuration files under the examples hierarchy,
6029 <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
6030 <code class="filename">PLIST</code> registers them and the administrator always
6031 has the original copies available.</p>
6032 <p>Once the required configuration files are in place (i.e., under the
6033 examples hierarchy), the pkginstall framework can use them as master copies
6034 during the package installation to update what is in
6035 <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
6036 <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
6037 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
6038 about their syntax and their purpose.  Here is an example, taken from the
6039 <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>
6040 <pre class="programlisting">
6041 EGDIR=        ${PREFIX}/share/doc/mutt/samples
6042 CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
6043 </pre>
6044 <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
6045 package and has no meaning outside it.</p>
6046 </div>
6047 <div class="sect2" title="15.2.4. Disabling handling of configuration files">
6048 <div class="titlepage"><div><div><h3 class="title">
6049 <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
6050 <p>The automatic copying of config files can be toggled by setting the
6051 environment variable <code class="varname">PKG_CONFIG</code> prior to package
6052 installation.</p>
6053 </div>
6054 </div>
6055 <div class="sect1" title="15.3. System startup scripts">
6056 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6057 <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
6058 <p>System startup scripts are special files because they must be
6059 installed in a place known by the underlying OS, usually outside the
6060 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
6061 can be used.  However, pkginstall provides a special mechanism to handle
6062 these files.</p>
6063 <p>In order to provide system startup scripts, the package has
6064 to:</p>
6065 <div class="orderedlist"><ol class="orderedlist" type="1">
6066 <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
6067     the <code class="literal">.sh</code> suffix appended.  Considering the
6068     <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
6069     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
6070 <li class="listitem">
6071 <p>Tell pkginstall to handle it, appending the name of the script,
6072     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
6073     Continuing the previous example:</p>
6074 <pre class="programlisting">
6075 RCD_SCRIPTS+=   cupsd
6076 </pre>
6077 </li>
6078 </ol></div>
6079 <p>Once this is done, pkginstall will do the following steps for each
6080 script in an automated fashion:</p>
6081 <div class="orderedlist"><ol class="orderedlist" type="1">
6082 <li class="listitem"><p>Process the file found in the files directory applying all the
6083     substitutions described in the <code class="filename">FILES_SUBST</code>
6084     variable.</p></li>
6085 <li class="listitem"><p>Copy the script from the files directory to the examples
6086     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
6087     that this master file must be explicitly registered in the
6088     <code class="filename">PLIST</code>.</p></li>
6089 <li class="listitem"><p>Add code to the installation scripts to copy the startup script
6090     from the examples hierarchy into the system-wide startup scripts
6091     directory.</p></li>
6092 </ol></div>
6093 <div class="sect2" title="15.3.1. Disabling handling of system startup scripts">
6094 <div class="titlepage"><div><div><h3 class="title">
6095 <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
6096 <p>The automatic copying of config files can be toggled by setting the
6097 environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
6098 installation.  Note that the scripts will be always copied inside the
6099 examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
6100 matter what the value of this variable is.</p>
6101 </div>
6102 </div>
6103 <div class="sect1" title="15.4. System users and groups">
6104 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6105 <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
6106 <p>If a package needs to create special users and/or groups during
6107 installation, it can do so by using the pkginstall framework.</p>
6108 <p>Users can be created by adding entries to the
6109 <code class="varname">PKG_USERS</code> variable.  Each entry has the following
6110 syntax:</p>
6111 <pre class="programlisting">
6112 user:group
6113 </pre>
6114 <p>Further specification of user details may be done by setting
6115 per-user variables.
6116 <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
6117 numeric UID for the user.
6118 <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
6119 user's description or comment.
6120 <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
6121 user's home directory, and defaults to
6122 <code class="filename">/nonexistent</code> if not specified.
6123 <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
6124 user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
6125 not specified.</p>
6126 <p>Similarly, groups can be created by adding entries to the
6127 <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
6128 <pre class="programlisting">
6129 group
6130 </pre>
6131 <p>The numeric GID of the group may be set by defining
6132 <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
6133 <p>If a package needs to create the users and groups at an earlier
6134 stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
6135 either <code class="literal">configure</code> or <code class="literal">build</code> to
6136 indicate the phase before which the users and groups are created.  In
6137 this case, the numeric UIDs and GIDs of the created users and groups
6138 are automatically hardcoded into the final installation scripts.</p>
6139 </div>
6140 <div class="sect1" title="15.5. System shells">
6141 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6142 <a name="shells"></a>15.5. System shells</h2></div></div></div>
6143 <p>Packages that install system shells should register them in the shell
6144 database, <code class="filename">/etc/shells</code>, to make things easier to the
6145 administrator.  This must be done from the installation scripts to keep
6146 binary packages working on any system.  pkginstall provides an easy way to
6147 accomplish this task.</p>
6148 <p>When a package provides a shell interpreter, it has to set the
6149 <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
6150 add some hooks to the installation scripts to handle it.  Consider the
6151 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>
6152 <pre class="programlisting">
6153 PKG_SHELL=      ${PREFIX}/bin/zsh
6154 </pre>
6155 <div class="sect2" title="15.5.1. Disabling shell registration">
6156 <div class="titlepage"><div><div><h3 class="title">
6157 <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
6158 <p>The automatic registration of shell interpreters can be disabled by
6159 the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
6160 environment variable to <code class="literal">NO</code>.</p>
6161 </div>
6162 </div>
6163 <div class="sect1" title="15.6. Fonts">
6164 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6165 <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
6166 <p>Packages that install X11 fonts should update the database files
6167 that index the fonts within each fonts directory.  This can easily be
6168 accomplished within the pkginstall framework.</p>
6169 <p>When a package installs X11 fonts, it must list the directories in
6170 which fonts are installed in the
6171 <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
6172 where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
6173 <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
6174 installation scripts to run the appropriate commands to update the fonts
6175 database files within each of those directories.  For convenience, if the
6176 directory path is relative, it is taken to be relative to the package's
6177 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>
6178 <pre class="programlisting">
6179 FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
6180 </pre>
6181 <div class="sect2" title="15.6.1. Disabling automatic update of the fonts databases">
6182 <div class="titlepage"><div><div><h3 class="title">
6183 <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
6184 <p>The automatic update of fonts databases can be disabled by
6185 the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
6186 environment variable to <code class="literal">NO</code>.</p>
6187 </div>
6188 </div>
6189 </div>
6190 <div class="chapter" title="Chapter 16. Options handling">
6191 <div class="titlepage"><div><div><h2 class="title">
6192 <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
6193 <div class="toc">
6194 <p><b>Table of Contents</b></p>
6195 <dl>
6196 <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
6197 <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>
6198 <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
6199 <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
6200 </dl>
6201 </div>
6202 <p>Many packages have the ability to be built to support different
6203 sets of features.  <code class="filename">bsd.options.mk</code> is a framework
6204 in pkgsrc that provides generic handling of those options that
6205 determine different ways in which the packages can be built.  It's
6206 possible for the user to specify exactly which sets of options will be
6207 built into a package or to allow a set of global default options
6208 apply.</p>
6209 <p>There are two broad classes of behaviors that one might want to
6210 control via options.  One is whether some particular feature is
6211 enabled in a program that will be built anyway, often by including or
6212 not including a dependency on some other package.  The other is
6213 whether or not an additional program will be built as part of the
6214 package.  Generally, it is better to make a split package for such
6215 additional programs instead of using options, because it enables
6216 binary packages to be built which can then be added separately.  For
6217 example, the foo package might have minimal dependencies (those
6218 packages without which foo doesn't make sense), and then the foo-gfoo
6219 package might include the GTK frontend program gfoo.  This is better
6220 than including a gtk option to foo that adds gfoo, because either that
6221 option is default, in which case binary users can't get foo without
6222 gfoo, or not default, in which case they can't get gfoo.  With split
6223 packages, they can install foo without having GTK, and later decide to
6224 install gfoo (pulling in GTK at that time).  This is an advantage to
6225 source users too, avoiding the need for rebuilds.</p>
6226 <p>Plugins with widely varying dependencies should usually be split
6227 instead of options.</p>
6228 <p>It is often more work to maintain split packages, especially if
6229 the upstream package does not support this.  The decision of split
6230 vs. option should be made based on the likelihood that users will want
6231 or object to the various pieces, the size of the dependencies that are
6232 included, and the amount of work.</p>
6233 <p>A further consideration is licensing.  Non-free parts, or parts
6234 that depend on non-free dependencies (especially plugins) should
6235 almost always be split if feasible.</p>
6236 <div class="sect1" title="16.1. Global default options">
6237 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6238 <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
6239 <p>Global default options are listed in
6240 <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
6241 that should be built into every package if that option is supported.
6242 This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
6243 </div>
6244 <div class="sect1" title="16.2. Converting packages to use bsd.options.mk">
6245 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6246 <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
6247 </h2></div></div></div>
6248 <p>The following example shows how
6249 <code class="filename">bsd.options.mk</code> should be used
6250 by the hypothetical ``wibble'' package, either in the package
6251 <code class="filename">Makefile</code>, or in a file,
6252 e.g. <code class="filename">options.mk</code>, that is included by the
6253 main package <code class="filename">Makefile</code>.</p>
6254 <pre class="programlisting">
6255 PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
6256 PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
6257 PKG_OPTIONS_OPTIONAL_GROUPS=    database
6258 PKG_OPTIONS_GROUP.database=     mysql pgsql
6259 PKG_SUGGESTED_OPTIONS=          wibble-foo
6260 PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
6261 PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
6262
6263 .include "../../mk/bsd.prefs.mk"
6264
6265 # this package was previously named wibble2
6266 .if defined(PKG_OPTIONS.wibble2)
6267 PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
6268 PKG_OPTIONS_DEPRECATED_WARNINGS+= \
6269         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
6270 .endif
6271
6272 .include "../../mk/bsd.options.mk"
6273
6274 # Package-specific option-handling
6275
6276 ###
6277 ### FOO support
6278 ###
6279 .if !empty(PKG_OPTIONS:Mwibble-foo)
6280 CONFIGURE_ARGS+=    --enable-foo
6281 .endif
6282
6283 ###
6284 ### LDAP support
6285 ###
6286 .if !empty(PKG_OPTIONS:Mldap)
6287 .  include "../../databases/openldap-client/buildlink3.mk"
6288 CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
6289 .endif
6290
6291 ###
6292 ### database support
6293 ###
6294 .if !empty(PKG_OPTIONS:Mmysql)
6295 .  include "../../mk/mysql.buildlink3.mk"
6296 .endif
6297 .if !empty(PKG_OPTIONS:Mpgsql)
6298 .  include "../../mk/pgsql.buildlink3.mk"
6299 .endif
6300 </pre>
6301 <p>The first section contains the information about which build
6302 options are supported by the package, and any default options settings
6303 if needed.</p>
6304 <div class="orderedlist"><ol class="orderedlist" type="1">
6305 <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
6306 <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
6307 options.  It should be set to
6308 PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
6309 PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
6310 at the point where the options are processed.</p></li>
6311 <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
6312 build options supported by the package.</p></li>
6313 <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
6314 list of names of groups of mutually exclusive options.  The options in
6315 each group are listed in
6316 <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
6317 The most specific setting of any option from the group takes
6318 precedence over all other options in the group.  Options from the
6319 groups will be automatically added to
6320 <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
6321 <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
6322 <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
6323 packages will fail if no option from the group is
6324 selected.</p></li>
6325 <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
6326 of names of sets of options.  At least one option from each set must
6327 be selected.  The options in each set are listed in
6328 <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
6329 Options from the sets will be automatically added to
6330 <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
6331 fail if no option from the set is selected.</p></li>
6332 <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
6333 build options which are enabled by default.</p></li>
6334 <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
6335 of
6336 <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>
6337 pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
6338 their option counterparts.  Pairs should be added with
6339 <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
6340 warning will be issued if the user uses a legacy
6341 variable.</p></li>
6342 <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
6343 of
6344 <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>
6345 pairs that map options that have been renamed to their new
6346 counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
6347 the listing of global legacy options.  A warning will be issued if
6348 the user uses a legacy option.</p></li>
6349 <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
6350 options implied by deprecated variables used.  This can be used for
6351 cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
6352 <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
6353 <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
6354 <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
6355 a list of warnings about deprecated variables or options used, and
6356 what to use instead.</p></li>
6357 </ol></div>
6358 <p>A package should never modify
6359 <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
6360 <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
6361 To suggest a default set of options, use
6362 <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
6363 <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
6364 including <code class="filename">bsd.options.mk</code>.  If none of
6365 <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
6366 <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
6367 <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
6368 happen with platform-specific options if none of them is supported on
6369 the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
6370 empty list and the package is otherwise treated as not using the
6371 options framework.</p>
6372 <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
6373 variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
6374 build options, properly filtered to remove unsupported and duplicate
6375 options.</p>
6376 <p>The remaining sections contain the logic that is specific to
6377 each option.  The correct way to check for an option is to check
6378 whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
6379 <pre class="programlisting">
6380 .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
6381 </pre>
6382 </div>
6383 <div class="sect1" title="16.3. Option Names">
6384 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6385 <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
6386 <p>Options that enable similar features in different packages (like
6387 optional support for a library) should use a common name in all
6388 packages that support it (like the name of the library).  If another
6389 package already has an option with the same meaning, use the same
6390 name.</p>
6391 <p>Options that enable features specific to one package, where it's
6392 unlikely that another (unrelated) package has the same (or a similar)
6393 optional feature, should use a name prefixed with
6394 <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
6395 <p>If a group of related packages share an optional feature
6396 specific to that group, prefix it with the name of the
6397 <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
6398 (e. g. <code class="varname">djbware-errno-hack</code>).</p>
6399 <p>For new options, add a line to
6400 <code class="filename">mk/defaults/options.description</code>.  Lines have two
6401 fields, separated by tab.  The first field is the option name, the
6402 second its description.  The description should be a whole sentence
6403 (starting with an uppercase letter and ending with a period) that
6404 describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
6405 support.</span>&#8221;</span> The file is sorted by option names.</p>
6406 </div>
6407 <div class="sect1" title="16.4. Determining the options of dependencies">
6408 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6409 <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
6410 <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
6411 different dependencies based on the options with which the package was
6412 built. For querying these options, the file
6413 <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
6414 typical example looks like this:</p>
6415 <pre class="programlisting">
6416 pkgbase := libpurple
6417 .include "../../mk/pkg-build-options.mk"
6418
6419 .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
6420 ...
6421 .endif
6422 </pre>
6423 <p>Including <code class="filename">pkg-build-options.mk</code> here will set
6424 the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
6425 options of the libpurple package, which can then be queried like
6426 <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
6427 file. See the file <code class="filename">pkg-build-options.mk</code> for more
6428 details.</p>
6429 </div>
6430 </div>
6431 <div class="chapter" title="Chapter 17. The build process">
6432 <div class="titlepage"><div><div><h2 class="title">
6433 <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
6434 <div class="toc">
6435 <p><b>Table of Contents</b></p>
6436 <dl>
6437 <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
6438 <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
6439 <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
6440 <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
6441 <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
6442 <dd><dl>
6443 <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
6444 <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
6445 </dl></dd>
6446 <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
6447 <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
6448 <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
6449 <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
6450 <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
6451 <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
6452 <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
6453 <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
6454 <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
6455 <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
6456 <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
6457 <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
6458 </dl>
6459 </div>
6460 <div class="sect1" title="17.1. Introduction">
6461 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6462 <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
6463 <p>This chapter gives a detailed description on how a package is
6464     built. Building a package is separated into different
6465     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
6466     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
6467     described in the following sections. Each phase is split into
6468     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
6469     containing phase, prefixed by one of <code class="varname">pre-</code>,
6470     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
6471     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
6472     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
6473 <p>Never override the regular targets (like
6474     <code class="varname">fetch</code>), if you have to, override the
6475     <code class="varname">do-*</code> ones instead.</p>
6476 <p>The basic steps for building a program are always the same.  First
6477     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
6478     the local system and then extracted. After any pkgsrc-specific patches
6479     to compile properly are applied, the software can be configured, then
6480     built (usually by compiling), and finally the generated binaries, etc.
6481     can be put into place on the system.</p>
6482 <p>To get more details about what is happening at each step,
6483     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
6484     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
6485     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
6486 </div>
6487 <div class="sect1" title="17.2. Program location">
6488 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6489 <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
6490 <p>Before outlining the process performed by the NetBSD package system in
6491     the next section, here's a brief discussion on where programs are
6492     installed, and which variables influence this.</p>
6493 <p>The automatic variable <code class="varname">PREFIX</code> indicates
6494     where all files of the final program shall be installed. It is
6495     usually set to <code class="varname">LOCALBASE</code>
6496     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
6497     for pkgs in the <code class="filename">cross</code> category.  The value of
6498     <code class="varname">PREFIX</code> needs to be put
6499     into the various places in the program's source where paths to
6500     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>
6501 <p>When choosing which of these variables to use,
6502     follow the following rules:</p>
6503 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
6504 <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
6505         where the current pkg will be installed.  When referring to a
6506         pkg's own installation path, use
6507         <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
6508 <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
6509         are installed.  If you need to construct a -I or -L argument
6510         to the compiler to find includes and libraries installed by
6511         another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
6512         <code class="varname">LOCALBASE</code> stems from FreeBSD, which
6513         installed all packages in <code class="filename">/usr/local</code>. As
6514         pkgsrc leaves <code class="filename">/usr/local</code> for the system
6515         administrator, this variable is a misnomer.</p></li>
6516 <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
6517         distribution (from xsrc, etc.) is installed. When looking for
6518         <span class="emphasis"><em>standard</em></span> X11 includes (not those
6519         installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
6520 <li class="listitem">
6521 <p>X11-based packages are special in that they may be
6522         installed in either <code class="varname">X11BASE</code> or
6523         <code class="varname">LOCALBASE</code>.</p>
6524 <p>Usually, X11 packages should be installed under
6525         <code class="varname">LOCALBASE</code> whenever possible.  Note that you
6526         will need to include
6527         <code class="filename">../../mk/x11.buildlink3.mk</code> in them to
6528         request the presence of X11 and to get the right compilation
6529         flags.</p>
6530 <p>Even though, there are some packages that cannot be installed
6531         under <code class="varname">LOCALBASE</code>: those that come with app-defaults
6532         files. These packages are special and they must be placed under
6533         <code class="varname">X11BASE</code>. To accomplish this, set either
6534         <code class="varname">USE_X11BASE</code> or <code class="varname">USE_IMAKE</code> in
6535         your package.</p>
6536 <p>Some notes: If you need
6537         to find includes or libraries installed by a pkg that has
6538         <code class="varname">USE_IMAKE</code> or <code class="varname">USE_X11BASE</code> in
6539         its pkg <code class="filename">Makefile</code>, you need to look in
6540         <span class="emphasis"><em>both</em></span> <code class="filename">${X11BASE}</code> and
6541         <code class="filename">${LOCALBASE}</code>. To force installation of
6542         all X11 packages in <code class="varname">LOCALBASE</code>, the
6543         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/xpkgwedge/README.html" target="_top"><code class="filename">pkgtools/xpkgwedge</code></a> package
6544         is enabled by default.</p>
6545 </li>
6546 <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
6547         the installed location of an X11
6548         package. <code class="varname">X11PREFIX</code> will be set to
6549         <code class="varname">X11BASE</code> if xpkgwedge is not installed, and
6550         to <code class="varname">LOCALBASE</code> if xpkgwedge is
6551         installed.</p></li>
6552 <li class="listitem">
6553 <p>If xpkgwedge is installed, it is possible to have some
6554         packages installed in <code class="varname">X11BASE</code> and some in
6555         <code class="varname">LOCALBASE</code>.  To determine the prefix of an
6556         installed package, the <code class="varname">EVAL_PREFIX</code>
6557         definition can be used. It takes pairs in the format
6558         <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>
6559         variable <code class="varname">DIRNAME</code> will be set to the prefix
6560         of the installed package &lt;package&gt;, or
6561         <span class="quote">&#8220;<span class="quote">${X11PREFIX}</span>&#8221;</span> if the package is not
6562         installed.</p>
6563 <p>This is best illustrated by example.</p>
6564 <p>The following lines are taken from
6565         <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
6566 <pre class="programlisting">
6567 EVAL_PREFIX+=           GTKDIR=gtk+
6568 CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
6569 CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
6570 CONFIGURE_ARGS+=        --enable-multibyte
6571 </pre>
6572 <p>Specific defaults can be defined for the packages
6573         evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
6574         definition of the form:</p>
6575 <pre class="programlisting">
6576 GTKDIR_DEFAULT= ${LOCALBASE}
6577 </pre>
6578 <p>where <code class="varname">GTKDIR</code> corresponds
6579         to the first definition in
6580         the <code class="varname">EVAL_PREFIX</code> pair.</p>
6581 </li>
6582 <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
6583         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
6584         manual pages go into <code class="filename">${PREFIX}/man</code>, not
6585         <code class="filename">${PREFIX}/share/man</code>.</p></li>
6586 </ul></div>
6587 </div>
6588 <div class="sect1" title="17.3. Directories used during the build process">
6589 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6590 <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
6591 <p>When building a package, various directories are used to store
6592     source files, temporary files, pkgsrc-internal files, and so on. These
6593     directories are explained here.</p>
6594 <p>Some of the directory variables contain relative pathnames. There
6595     are two common base directories for these relative directories:
6596     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
6597     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
6598     inside the package itself.</p>
6599 <div class="variablelist"><dl>
6600 <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
6601 <dd><p>This is an absolute pathname that points to the pkgsrc
6602       root directory. Generally, you don't need
6603       it.</p></dd>
6604 <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
6605 <dd><p>This is an absolute pathname that points to the
6606       current package.</p></dd>
6607 <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
6608 <dd><p>This is a pathname relative to
6609       <code class="varname">PKGSRCDIR</code> that points to the current
6610       package.</p></dd>
6611 <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
6612 <dd><p>This is an absolute pathname pointing to the directory
6613       where all work takes place. The distfiles are extracted to this
6614       directory. It also contains temporary directories and log files used by
6615       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
6616       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
6617 <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
6618 <dd><p>This is an absolute pathname pointing to the directory
6619       where the distfiles are extracted. It is usually a direct subdirectory
6620       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
6621       that isn't hidden. This variable may be changed by a package
6622       <code class="filename">Makefile</code>.</p></dd>
6623 </dl></div>
6624 <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
6625     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
6626     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
6627     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
6628     If users would like to have their pkgsrc trees behave in a
6629     read-only manner, then the value of
6630     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
6631     <span class="emphasis"><em>no</em></span>.</p>
6632 </div>
6633 <div class="sect1" title="17.4. Running a phase">
6634 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6635 <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
6636 <p>You can run a particular phase by typing <span class="command"><strong>make
6637     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
6638     phase. This will automatically run all phases that are required for this
6639     phase. The default phase is <code class="varname">build</code>, that is, when you
6640     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
6641     the package will be built, but not installed.</p>
6642 </div>
6643 <div class="sect1" title="17.5. The fetch phase">
6644 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6645 <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
6646 <p>The first step in building a package is to fetch the
6647     distribution files (distfiles) from the sites that are providing
6648     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
6649     phase.</p>
6650 <div class="sect2" title="17.5.1. What to fetch and where to get it from">
6651 <div class="titlepage"><div><div><h3 class="title">
6652 <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
6653 <p>In simple cases, <code class="varname">MASTER_SITES</code>
6654       defines all URLs from where the distfile, whose name is
6655       derived from the <code class="varname">DISTNAME</code> variable, is
6656       fetched. The more complicated cases are described
6657       below.</p>
6658 <p>The variable <code class="varname">DISTFILES</code> specifies
6659       the list of distfiles that have to be fetched. Its value
6660       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
6661       so that most packages don't need to define it at all.
6662       <code class="varname">EXTRACT_SUFX</code> is
6663       <code class="literal">.tar.gz</code> by default, but can be changed
6664       freely. Note that if your package requires additional
6665       distfiles to the default one, you cannot just append the
6666       additional filenames using the <code class="literal">+=</code>
6667       operator, but you have write for example:</p>
6668 <pre class="programlisting">
6669 DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
6670 </pre>
6671 <p>Each distfile is fetched from a list of sites, usually
6672       <code class="varname">MASTER_SITES</code>. If the package has multiple
6673       <code class="varname">DISTFILES</code> or multiple
6674       <code class="varname">PATCHFILES</code> from different sites, you can
6675       set
6676       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
6677       to the list of URLs where the file
6678       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
6679       (including the suffix) can be found.</p>
6680 <pre class="programlisting">
6681 DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
6682 DISTFILES+=     foo-file.tar.gz
6683 SITES.foo-file.tar.gz= \
6684 http://www.somewhere.com/somehow/ \
6685 http://www.somewhereelse.com/mirror/somehow/
6686 </pre>
6687 <p>When actually fetching the distfiles, each item from
6688       <code class="varname">MASTER_SITES</code> or
6689       <code class="varname">SITES.*</code> gets the name of each distfile
6690       appended to it, without an intermediate slash. Therefore,
6691       all site values have to end with a slash or other separator
6692       character. This allows for example to set
6693       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
6694       that gets the name of the distfile as a parameter. In this
6695       case, the definition would look like:</p>
6696 <pre class="programlisting">
6697 MASTER_SITES=   http://www.example.com/download.cgi?file=
6698 </pre>
6699 <p> The exception to this rule are URLs starting with a dash.
6700       In that case the URL is taken as is, fetched and the result stored
6701       under the name of the distfile.</p>
6702 <p>There are some predefined values for
6703       <code class="varname">MASTER_SITES</code>, which can be used in
6704       packages.  The names of the variables should speak for
6705       themselves.</p>
6706 <pre class="programlisting">
6707 ${MASTER_SITE_APACHE}
6708 ${MASTER_SITE_BACKUP}
6709 ${MASTER_SITE_CYGWIN}
6710 ${MASTER_SITE_DEBIAN}
6711 ${MASTER_SITE_FREEBSD}
6712 ${MASTER_SITE_FREEBSD_LOCAL}
6713 ${MASTER_SITE_GENTOO}
6714 ${MASTER_SITE_GNOME}
6715 ${MASTER_SITE_GNU}
6716 ${MASTER_SITE_GNUSTEP}
6717 ${MASTER_SITE_IFARCHIVE}
6718 ${MASTER_SITE_KDE}
6719 ${MASTER_SITE_MOZILLA}
6720 ${MASTER_SITE_MYSQL}
6721 ${MASTER_SITE_OPENOFFICE}
6722 ${MASTER_SITE_PERL_CPAN}
6723 ${MASTER_SITE_PGSQL}
6724 ${MASTER_SITE_R_CRAN}
6725 ${MASTER_SITE_SOURCEFORGE}
6726 ${MASTER_SITE_SOURCEFORGE_JP}
6727 ${MASTER_SITE_SUNSITE}
6728 ${MASTER_SITE_SUSE}
6729 ${MASTER_SITE_TEX_CTAN}
6730 ${MASTER_SITE_XCONTRIB}
6731 ${MASTER_SITE_XEMACS}
6732 </pre>
6733 <p>Some explanations for the less self-explaining ones:
6734       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
6735       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
6736       package source distributions that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/LOCAL_PORTS/</a>.</p>
6737 <p>If you choose one of these predefined sites, you may
6738       want to specify a subdirectory of that site. Since these
6739       macros may expand to more than one actual site, you
6740       <span class="emphasis"><em>must</em></span> use the following construct to
6741       specify a subdirectory:</p>
6742 <pre class="programlisting">
6743 MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
6744 MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
6745 </pre>
6746 <p>Note the trailing slash after the subdirectory
6747       name.</p>
6748 </div>
6749 <div class="sect2" title="17.5.2. How are the files fetched?">
6750 <div class="titlepage"><div><div><h3 class="title">
6751 <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
6752 <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
6753       all the distfiles exist in a local directory
6754       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
6755       user). If the files do not exist, they are fetched using
6756       commands of the form</p>
6757 <pre class="programlisting">
6758 ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
6759 </pre>
6760 <p>where <code class="literal">${site}</code> varies through
6761       several possibilities in turn: first,
6762       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
6763       sites specified in either <code class="varname">SITES.file</code> if
6764       defined, else <code class="varname">MASTER_SITES</code> or
6765       <code class="varname">PATCH_SITES</code>, as applies, then finally the
6766       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
6767       all except the first and the last can be optionally sorted
6768       by the user, via setting either
6769       <code class="varname">MASTER_SORT_RANDOM</code>, and
6770       <code class="varname">MASTER_SORT_AWK</code> or
6771       <code class="varname">MASTER_SORT_REGEX</code>.</p>
6772 <p> The specific command and arguments used depend on the
6773       <code class="varname">FETCH_USING</code> parameter. The example above is
6774       for <code class="literal">FETCH_USING=custom</code>.</p>
6775 <p>The distfiles mirror run by the NetBSD Foundation uses the
6776       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
6777       distfiles, if they are freely distributable.  Packages setting
6778       <code class="varname">NO_SRC_ON_FTP</code> (usually to
6779       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
6780       mirrored.</p>
6781 </div>
6782 </div>
6783 <div class="sect1" title="17.6. The checksum phase">
6784 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6785 <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
6786 <p>After the distfile(s) are fetched, their checksum is
6787     generated and compared with the checksums stored in the
6788     distinfo file. If the checksums don't match, the build is
6789     aborted. This is to ensure the same distfile is used for
6790     building, and that the distfile wasn't changed, e.g. by some
6791     malign force, deliberately changed distfiles on the master
6792     distribution site or network lossage.</p>
6793 </div>
6794 <div class="sect1" title="17.7. The extract phase">
6795 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6796 <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
6797 <p>When the distfiles are present on the local system, they
6798     need to be extracted, as they usually come in the form of some
6799     compressed archive format.</p>
6800 <p>By default, all <code class="varname">DISTFILES</code> are
6801     extracted. If you only need some of them, you can set the
6802     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
6803     files.</p>
6804 <p>Extracting the files is usually done by a little
6805     program, <code class="filename">mk/extract/extract</code>, which
6806     already knows how to extract various archive formats, so most
6807     likely you will not need to change anything here. But if you
6808     need, the following variables may help you:</p>
6809 <div class="variablelist"><dl>
6810 <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
6811 <dd><p>Use these variables to override the default
6812       options for an extract command, which are defined in
6813       <code class="filename">mk/extract/extract</code>.</p></dd>
6814 <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
6815 <dd><p>This variable can be set to
6816       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
6817       (which is the default value), <code class="literal">pax</code>, or an
6818       absolute pathname pointing to the command with which tar
6819       archives should be extracted.  It is preferred to choose bsdtar over gtar
6820       if NetBSD's pax-as-tar is not good enough.</p></dd>
6821 </dl></div>
6822 <p>If the <code class="filename">extract</code> program doesn't
6823     serve your needs, you can also override the
6824     <code class="varname">EXTRACT_CMD</code> variable, which holds the
6825     command used for extracting the files. This command is
6826     executed in the <code class="filename">${WRKSRC}</code>
6827     directory. During execution of this command, the shell
6828     variable <code class="varname">extract_file</code> holds the absolute
6829     pathname of the file that is going to be extracted.</p>
6830 <p>And if that still does not suffice, you can override the
6831     <code class="varname">do-extract</code> target in the package
6832     Makefile.</p>
6833 </div>
6834 <div class="sect1" title="17.8. The patch phase">
6835 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6836 <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
6837 <p>After extraction, all the patches named by the
6838     <code class="varname">PATCHFILES</code>, those present in the patches
6839     subdirectory of the package as well as in
6840     $LOCALPATCHES/$PKGPATH (e.g.
6841     <code class="filename">/usr/local/patches/graphics/png</code>) are
6842     applied.  Patchfiles ending in <code class="filename">.Z</code> or
6843     <code class="filename">.gz</code> are uncompressed before they are
6844     applied, files ending in <code class="filename">.orig</code> or
6845     <code class="filename">.rej</code> are ignored. Any special options to
6846     <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
6847     <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>
6848 <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
6849     it fail if the patches apply with some lines of fuzz. Please
6850     fix (regen) the patches so that they apply cleanly. The
6851     rationale behind this is that patches that don't apply cleanly
6852     may end up being applied in the wrong place, and cause severe
6853     harm there.</p>
6854 </div>
6855 <div class="sect1" title="17.9. The tools phase">
6856 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6857 <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
6858 <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>.
6859     </p>
6860 </div>
6861 <div class="sect1" title="17.10. The wrapper phase">
6862 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6863 <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
6864 <p>This phase creates wrapper programs for the compilers and
6865     linkers. The following variables can be used to tweak the
6866     wrappers.</p>
6867 <div class="variablelist"><dl>
6868 <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
6869 <dd><p>The command used to print progress
6870       messages. Does nothing by default. Set to
6871       <code class="literal">${ECHO}</code> to see the progress
6872       messages.</p></dd>
6873 <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
6874 <dd><p>This variable can be set to
6875       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
6876       depending on whether you want additional information in the
6877       wrapper log file.</p></dd>
6878 <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
6879 <dd><p>This variable can be set to
6880       <code class="literal">yes</code> or <code class="literal">no</code>, depending
6881       on whether the wrapper should use its cache, which will
6882       improve the speed. The default value is
6883       <code class="literal">yes</code>, but is forced to
6884       <code class="literal">no</code> if the platform does not support
6885       it.</p></dd>
6886 <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
6887 <dd><p>A list of reordering commands. A reordering
6888       command has the form
6889       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
6890       It ensures that that
6891       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
6892       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
6893       </p></dd>
6894 <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
6895 <dd><p>A list of transformation commands. [TODO:
6896       investigate further]</p></dd>
6897 </dl></div>
6898 </div>
6899 <div class="sect1" title="17.11. The configure phase">
6900 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6901 <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
6902 <p>Most pieces of software need information on the header
6903     files, system calls, and library routines which are available
6904     on the platform they run on. The process of determining this
6905     information is known as configuration, and is usually
6906     automated. In most cases, a script is supplied with the
6907     distfiles, and its invocation results in generation of header
6908     files, Makefiles, etc.</p>
6909 <p>If the package contains a configure script, this can be
6910     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
6911     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
6912     script, you should set <code class="varname">GNU_CONFIGURE</code> to
6913     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
6914     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
6915 <pre class="programlisting">
6916 .for d in ${CONFIGURE_DIRS}
6917         cd ${WRKSRC} \
6918         &amp;&amp; cd ${d} \
6919         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
6920 .endfor
6921 </pre>
6922 <p><code class="varname">CONFIGURE_DIRS</code> (default:
6923     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
6924     <code class="varname">WRKSRC</code>. In each of these directories, the
6925     configure script is run with the environment
6926     <code class="varname">CONFIGURE_ENV</code> and arguments
6927     <code class="varname">CONFIGURE_ARGS</code>. The variables
6928     <code class="varname">CONFIGURE_ENV</code>,
6929     <code class="varname">CONFIGURE_SCRIPT</code> (default:
6930     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
6931     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
6932     package.</p>
6933 <p>If the program uses an <code class="filename">Imakefile</code>
6934     for configuration, the appropriate steps can be invoked by
6935     setting <code class="varname">USE_IMAKE</code> to
6936     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. (If you only want the package installed in
6937     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
6938     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
6939     xmkmf's environment by adding them to the
6940     <code class="varname">SCRIPTS_ENV</code> variable.</p>
6941 <p>If the program uses <code class="filename">cmake</code>
6942     for configuration, the appropriate steps can be invoked by
6943     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
6944     You can add variables to cmake's environment by adding them to the
6945     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
6946     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
6947     The top directory argument is given by the
6948     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
6949     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
6950 <p>If there is no configure step at all, set
6951     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
6952 </div>
6953 <div class="sect1" title="17.12. The build phase">
6954 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6955 <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
6956 <p>For building a package, a rough equivalent of the
6957     following code is executed.</p>
6958 <pre class="programlisting">
6959 .for d in ${BUILD_DIRS}
6960         cd ${WRKSRC} \
6961         &amp;&amp; cd ${d} \
6962         &amp;&amp; env ${MAKE_ENV} \
6963             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
6964                 -f ${MAKE_FILE} \
6965                 ${BUILD_TARGET}
6966 .endfor
6967 </pre>
6968 <p><code class="varname">BUILD_DIRS</code> (default:
6969     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
6970     <code class="varname">WRKSRC</code>. In each of these directories,
6971     <code class="varname">MAKE_PROGRAM</code> is run with the environment
6972     <code class="varname">MAKE_ENV</code> and arguments
6973     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
6974     <code class="varname">MAKE_ENV</code>,
6975     <code class="varname">BUILD_MAKE_FLAGS</code>,
6976     <code class="varname">MAKE_FILE</code> and
6977     <code class="varname">BUILD_TARGET</code> may all be changed by the
6978     package.</p>
6979 <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
6980     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
6981     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
6982     default value of <code class="varname">MAKE_FILE</code> is
6983     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
6984     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
6985 <p>If there is no build step at all, set
6986     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
6987 </div>
6988 <div class="sect1" title="17.13. The test phase">
6989 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6990 <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
6991 <p>[TODO]</p>
6992 </div>
6993 <div class="sect1" title="17.14. The install phase">
6994 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
6995 <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
6996 <p>Once the build stage has completed, the final step is to
6997     install the software in public directories, so users can
6998     access the programs and files.</p>
6999 <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
7000     equivalent of the following code is executed. Additionally,
7001     before and after this code, much magic is performed to do
7002     consistency checks, registering the package, and so on.</p>
7003 <pre class="programlisting">
7004 .for d in ${INSTALL_DIRS}
7005         cd ${WRKSRC} \
7006         &amp;&amp; cd ${d} \
7007         &amp;&amp; env ${MAKE_ENV} \
7008             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
7009                 -f ${MAKE_FILE} \
7010                 ${INSTALL_TARGET}
7011 .endfor
7012 </pre>
7013 <p>The variable's meanings are analogous to the ones in the
7014     <span class="emphasis"><em>build</em></span> phase.
7015     <code class="varname">INSTALL_DIRS</code> defaults to
7016     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
7017     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
7018     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
7019     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
7020     defined.</p>
7021 <p>In the <span class="emphasis"><em>install</em></span> phase, the following
7022     variables are useful. They are all variations of the
7023     <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
7024     permissions preset. <code class="varname">INSTALL</code> is the plain
7025     install command. The specialized variants, together with their
7026     intended use, are:</p>
7027 <div class="variablelist"><dl>
7028 <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
7029 <dd><p>directories that contain
7030       binaries</p></dd>
7031 <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
7032 <dd><p>directories that contain
7033       scripts</p></dd>
7034 <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
7035 <dd><p>directories that contain shared and static
7036       libraries</p></dd>
7037 <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
7038 <dd><p>directories that contain data
7039       files</p></dd>
7040 <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
7041 <dd><p>directories that contain man
7042       pages</p></dd>
7043 <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
7044 <dd><p>binaries that can be stripped from debugging
7045       symbols</p></dd>
7046 <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
7047 <dd><p>binaries that cannot be
7048       stripped</p></dd>
7049 <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
7050 <dd><p>game
7051       binaries</p></dd>
7052 <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
7053 <dd><p>shared and static
7054       libraries</p></dd>
7055 <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
7056 <dd><p>data files</p></dd>
7057 <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
7058 <dd><p>data files for
7059       games</p></dd>
7060 <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
7061 <dd><p>man pages</p></dd>
7062 </dl></div>
7063 <p>Some other variables are:</p>
7064 <div class="variablelist"><dl>
7065 <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
7066 <dd><p>A list of directories relative to
7067       <code class="varname">PREFIX</code> that are created by pkgsrc at the
7068       beginning of the <span class="emphasis"><em>install</em></span> phase.
7069       The package is supposed to create all needed directories itself
7070       before installing files to it and list all other directories here.
7071       </p></dd>
7072 </dl></div>
7073 <p>In the rare cases that a package shouldn't install anything,
7074     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
7075     mostly relevant for packages in the <code class="filename">regress</code>
7076     category.</p>
7077 </div>
7078 <div class="sect1" title="17.15. The package phase">
7079 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7080 <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
7081 <p>Once the install stage has completed, a binary package of
7082     the installed files can be built.  These binary packages can be
7083     used for quick installation without previous compilation, e.g. by
7084     the <span class="command"><strong>make bin-install</strong></span> or by using
7085     <span class="command"><strong>pkg_add</strong></span>.</p>
7086 <p>By default, the binary packages are created in
7087     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
7088     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
7089     one for each category in the <code class="varname">CATEGORIES</code>
7090     variable.  <code class="varname">PACKAGES</code> defaults to
7091     <code class="filename">pkgsrc/packages</code>.</p>
7092 </div>
7093 <div class="sect1" title="17.16. Cleaning up">
7094 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7095 <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
7096 <p>Once you're finished with a package, you can clean the work
7097     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
7098     to clean the work directories of all dependencies too, use
7099     <span class="command"><strong>make clean-depends</strong></span>.</p>
7100 </div>
7101 <div class="sect1" title="17.17. Other helpful targets">
7102 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7103 <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
7104 <div class="variablelist"><dl>
7105 <dt><span class="term">pre/post-*</span></dt>
7106 <dd><p>For any of the main targets described in the
7107           previous section, two auxiliary targets exist with
7108           <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
7109           prefix for the main target's name.  These targets are
7110           invoked before and after the main target is called,
7111           allowing extra configuration or installation steps be
7112           performed from a package's Makefile, for example, which
7113           a program's configure script or install target
7114           omitted.</p></dd>
7115 <dt><span class="term">do-*</span></dt>
7116 <dd><p>Should one of the main targets do the wrong thing,
7117           and should there be no variable to fix this, you can
7118           redefine it with the do-* target.  (Note that redefining
7119           the target itself instead of the do-* target is a bad
7120           idea, as the pre-* and post-* targets won't be called
7121           anymore, etc.) You will not usually need to do
7122           this.</p></dd>
7123 <dt><span class="term">reinstall</span></dt>
7124 <dd>
7125 <p>If you did a <span class="command"><strong>make install</strong></span> and
7126           you noticed some file was not installed properly, you
7127           can repeat the installation with this target, which will
7128           ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
7129 <p>This is the default value of
7130           <code class="varname">DEPENDS_TARGET</code> except in the case of
7131           <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
7132           package</strong></span>, where the defaults are
7133           <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
7134           respectively.</p>
7135 </dd>
7136 <dt><span class="term">deinstall</span></dt>
7137 <dd>
7138 <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
7139           current directory, effectively de-installing the
7140           package. The following variables can be used to tune the
7141           behaviour:</p>
7142 <div class="variablelist"><dl>
7143 <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
7144 <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>
7145 <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
7146 <dd><p>Remove all packages that require (depend on)
7147                 the given package.  This can be used to remove any
7148                 packages that may have been pulled in by a given
7149                 package, e.g. if <span class="command"><strong>make deinstall
7150                 DEINSTALLDEPENDS=1</strong></span> is done in
7151                 <code class="filename">pkgsrc/x11/kde</code>, this is
7152                 likely to remove whole KDE. Works by adding
7153                 <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>
7154                 command line.</p></dd>
7155 </dl></div>
7156 </dd>
7157 <dt><span class="term">bin-install</span></dt>
7158 <dd><p>Install a binary package from local disk and via FTP
7159           from a list of sites (see the
7160           <code class="varname">BINPKG_SITES</code> variable), and do a
7161           <span class="command"><strong>make package</strong></span> if no binary package is
7162           available anywhere.  The arguments given to
7163           <span class="command"><strong>pkg_add</strong></span> can be set via
7164           <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
7165           operation, etc.</p></dd>
7166 <dt><span class="term">update</span></dt>
7167 <dd>
7168 <p>This target causes the current package to be
7169           updated to the latest version.  The package and all
7170           depending packages first get de-installed, then current
7171           versions of the corresponding packages get compiled and
7172           installed.  This is similar to manually noting which
7173           packages are currently installed, then performing a
7174           series of <span class="command"><strong>make deinstall</strong></span> and
7175           <span class="command"><strong>make install</strong></span> (or whatever
7176           <code class="varname">UPDATE_TARGET</code> is set to) for these
7177           packages.</p>
7178 <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
7179           resume package updating in case a previous <span class="command"><strong>make
7180           update</strong></span> was interrupted for some reason.
7181           However, in this case, make sure you don't call
7182           <span class="command"><strong>make clean</strong></span> or otherwise remove the
7183           list of dependent packages in <code class="varname">WRKDIR</code>.
7184           Otherwise, you lose the ability to automatically update
7185           the current package along with the dependent packages
7186           you have installed.</p>
7187 <p>Resuming an interrupted <span class="command"><strong>make
7188           update</strong></span> will only work as long as the package
7189           tree remains unchanged.  If the source code for one of
7190           the packages to be updated has been changed, resuming
7191           <span class="command"><strong>make update</strong></span> will most certainly
7192           fail!</p>
7193 <p>The following variables can be used either on the
7194           command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7195           alter the behaviour of <span class="command"><strong>make
7196           update</strong></span>:</p>
7197 <div class="variablelist"><dl>
7198 <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
7199 <dd><p>Install target to recursively use for the
7200                 updated package and the dependent packages.
7201                 Defaults to <code class="varname">DEPENDS_TARGET</code> if
7202                 set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
7203                 <span class="command"><strong>make update</strong></span>.  Other good
7204                 targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
7205                 <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
7206                 <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
7207                 endless loop!</p></dd>
7208 <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
7209 <dd><p>Don't clean up after updating.  Useful if
7210                 you want to leave the work sources of the updated
7211                 packages around for inspection or other purposes.
7212                 Be sure you eventually clean up the source tree
7213                 (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
7214                 or you may run into troubles with old source code
7215                 still lying around on your next
7216                 <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
7217                 update</strong></span>.</p></dd>
7218 <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
7219 <dd><p>Deinstall each package before installing
7220                 (making <code class="varname">DEPENDS_TARGET</code>). This
7221                 may be necessary if the
7222                 <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
7223                 called after interrupting a running <span class="command"><strong>make
7224                 update</strong></span>.</p></dd>
7225 <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
7226 <dd><p>Allows you to disable recursion and hardcode
7227                 the target for packages.  The default is
7228                 <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
7229                 facilitating a recursive update of prerequisite
7230                 packages.  Only set
7231                 <code class="varname">DEPENDS_TARGET</code> if you want to
7232                 disable recursive updates. Use
7233                 <code class="varname">UPDATE_TARGET</code> instead to just
7234                 set a specific target for each package to be
7235                 installed during <span class="command"><strong>make update</strong></span>
7236                 (see above).</p></dd>
7237 </dl></div>
7238 </dd>
7239 <dt><span class="term">clean-update</span></dt>
7240 <dd>
7241 <p>Clean the source tree for all packages that would
7242           get updated if <span class="command"><strong>make update</strong></span> was called
7243           from the current directory.  This target should not be
7244           used if the current package (or any of its depending
7245           packages) have already been de-installed (e.g., after
7246           calling <span class="command"><strong>make update</strong></span>) or you may lose
7247           some packages you intended to update. As a rule of
7248           thumb: only use this target <span class="emphasis"><em>before</em></span>
7249           the first time you run <span class="command"><strong>make update</strong></span>
7250           and only if you have a dirty package tree (e.g., if you
7251           used <code class="varname">NOCLEAN</code>).</p>
7252 <p>If you are unsure about whether your tree is
7253           clean, you can either perform a <span class="command"><strong>make
7254           clean</strong></span> at the top of the tree, or use the
7255           following sequence of commands from the directory of the
7256           package you want to update (<span class="emphasis"><em>before</em></span>
7257           running <span class="command"><strong>make update</strong></span> for the first
7258           time, otherwise you lose all the packages you wanted to
7259           update!):</p>
7260 <pre class="screen">
7261 <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
7262 <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
7263 <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
7264           </pre>
7265 <p>The following variables can be used either on the
7266           command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
7267           <span class="command"><strong>make clean-update</strong></span>:</p>
7268 <div class="variablelist"><dl>
7269 <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
7270 <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
7271                 reconstruct the list of directories to update for
7272                 this package.  Only use this if <span class="command"><strong>make
7273                 update</strong></span> successfully installed all
7274                 packages you wanted to update.  Normally, this is
7275                 done automatically on <span class="command"><strong>make
7276                 update</strong></span>, but may have been suppressed by
7277                 the <code class="varname">NOCLEAN</code> variable (see
7278                 above).</p></dd>
7279 </dl></div>
7280 </dd>
7281 <dt><span class="term">replace</span></dt>
7282 <dd>
7283 <p>Update the installation of the current package.  This
7284           differs from update in that it does not replace dependent
7285           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
7286           target to work.</p>
7287 <p><span class="emphasis"><em>Be careful when using this
7288           target!</em></span> There are no guarantees that dependent
7289           packages will still work, in particular they will most
7290           certainly break if you <span class="command"><strong>make replace</strong></span> a
7291           library package whose shared library major version changed
7292           between your installed version and the new one.  For this
7293           reason, this target is not officially supported and only
7294           recommended for advanced users.</p>
7295 </dd>
7296 <dt><span class="term">info</span></dt>
7297 <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
7298           package. You can use this to check which version of a
7299           package is installed.</p></dd>
7300 <dt><span class="term">index</span></dt>
7301 <dd>
7302 <p>This is a top-level command, i.e. it should be used in
7303           the <code class="filename">pkgsrc</code> directory.  It creates a
7304           database of all packages in the local pkgsrc tree, including
7305           dependencies, comment, maintainer, and some other useful
7306           information.  Individual entries are created by running
7307           <span class="command"><strong>make describe</strong></span> in the packages'
7308           directories.  This index file is saved as
7309           <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
7310           verbose format by running <span class="command"><strong>make
7311           print-index</strong></span>.  You can search in it with
7312           <span class="command"><strong>make search
7313           key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
7314           extract a list of all packages that depend on a particular
7315           one by running <span class="command"><strong>make show-deps
7316           PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
7317 <p>Running this command takes a very long time, some
7318           hours even on fast machines!</p>
7319 </dd>
7320 <dt><span class="term">readme</span></dt>
7321 <dd>
7322 <p>This target generates a
7323           <code class="filename">README.html</code> file, which can be
7324           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
7325           contain references to any packages which are in the
7326           <code class="varname">PACKAGES</code> directory on the local
7327           host. The generated files can be made to refer to URLs
7328           based on <code class="varname">FTP_PKG_URL_HOST</code> and
7329           <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
7330           wanted to generate <code class="filename">README.html</code>
7331           files which pointed to binary packages on the local
7332           machine, in the directory
7333           <code class="filename">/usr/packages</code>, set
7334           <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
7335           <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
7336           <code class="varname">${PACKAGES}</code> directory and its
7337           subdirectories will be searched for all the binary
7338           packages.</p>
7339 <p>The target can be run at the toplevel or in category
7340           directories, in which case it descends recursively.</p>
7341 </dd>
7342 <dt><span class="term">readme-all</span></dt>
7343 <dd><p>This is a top-level command, run it in
7344           <code class="filename">pkgsrc</code>.  Use this target to create a
7345           file <code class="filename">README-all.html</code> which contains a
7346           list of all packages currently available in the NetBSD
7347           Packages Collection, together with the category they belong
7348           to and a short description. This file is compiled from the
7349           <code class="filename">pkgsrc/*/README.html</code> files, so be sure
7350           to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
7351           readme</strong></span>.</p></dd>
7352 <dt><span class="term">cdrom-readme</span></dt>
7353 <dd><p>This is very much the same as the
7354           <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
7355           used when generating a pkgsrc tree to be written to a
7356           CD-ROM.  This target also produces
7357           <code class="filename">README.html</code> files, and can be made
7358           to refer to URLs based on
7359           <code class="varname">CDROM_PKG_URL_HOST</code> and
7360           <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
7361 <dt><span class="term">show-distfiles</span></dt>
7362 <dd><p>This target shows which distfiles and patchfiles
7363           are needed to build the package
7364           (<code class="varname">ALLFILES</code>, which contains all
7365           <code class="varname">DISTFILES</code> and
7366           <code class="varname">PATCHFILES</code>, but not
7367           <code class="filename">patches/*</code>).</p></dd>
7368 <dt><span class="term">show-downlevel</span></dt>
7369 <dd><p>This target shows nothing if the package is not
7370           installed. If a version of this package is installed,
7371           but is not the version provided in this version of
7372           pkgsrc, then a warning message is displayed. This target
7373           can be used to show which of your installed packages are
7374           downlevel, and so the old versions can be deleted, and
7375           the current ones added.</p></dd>
7376 <dt><span class="term">show-pkgsrc-dir</span></dt>
7377 <dd><p>This target shows the directory in the pkgsrc
7378           hierarchy from which the package can be built and
7379           installed. This may not be the same directory as the one
7380           from which the package was installed. This target is
7381           intended to be used by people who may wish to upgrade
7382           many packages on a single host, and can be invoked from
7383           the top-level pkgsrc Makefile by using the
7384           <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
7385 <dt><span class="term">show-installed-depends</span></dt>
7386 <dd><p>This target shows which installed packages match
7387           the current package's <code class="varname">DEPENDS</code>. Useful
7388           if out of date dependencies are causing build
7389           problems.</p></dd>
7390 <dt><span class="term">check-shlibs</span></dt>
7391 <dd><p>After a package is installed, check all its
7392           binaries and (on ELF platforms) shared libraries to see
7393           if they find the shared libs they need.  Run by default
7394           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>
7395 <dt><span class="term">print-PLIST</span></dt>
7396 <dd>
7397 <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
7398           upgraded pkg, this prints out an attempt to generate a
7399           new <code class="filename">PLIST</code> from a <span class="command"><strong>find
7400           -newer work/.extract_done</strong></span>.  An attempt is made
7401           to care for shared libs etc., but it is
7402           <span class="emphasis"><em>strongly</em></span> recommended to review the
7403           result before putting it into
7404           <code class="filename">PLIST</code>. On upgrades, it's useful to
7405           diff the output of this command against an already
7406           existing <code class="filename">PLIST</code> file.</p>
7407 <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
7408           other methods that don't update file access times, be
7409           sure to add these files manually to your
7410           <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
7411           -newer</span>&#8221;</span> command used by this target won't catch
7412           them!</p>
7413 <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
7414           information on this target.</p>
7415 </dd>
7416 <dt><span class="term">bulk-package</span></dt>
7417 <dd>
7418 <p>Used to do bulk builds. If an appropriate binary
7419           package already exists, no action is taken. If not, this
7420           target will compile, install and package it (and its
7421           depends, if <code class="varname">PKG_DEPENDS</code> is set
7422           properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
7423           After creating the binary package, the sources, the
7424           just-installed package and its required packages are
7425           removed, preserving free disk space.</p>
7426 <p><span class="emphasis"><em>Beware that this target may deinstall
7427           all packages installed on a system!</em></span></p>
7428 </dd>
7429 <dt><span class="term">bulk-install</span></dt>
7430 <dd>
7431 <p>Used during bulk-installs to install required
7432           packages. If an up-to-date binary package is available,
7433           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,
7434           <span class="command"><strong>make bulk-package</strong></span> will be executed,
7435           but the installed binary won't be removed.</p>
7436 <p>A binary package is considered
7437           <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
7438           <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>
7439 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
7440 <li class="listitem"><p>None of the package's files
7441               (<code class="filename">Makefile</code>, ...) were modified
7442               since it was built.</p></li>
7443 <li class="listitem"><p>None of the package's required (binary)
7444               packages were modified since it was built.</p></li>
7445 </ul></div>
7446 <p><span class="emphasis"><em>Beware that this target may deinstall
7447           all packages installed on a system!</em></span></p>
7448 </dd>
7449 </dl></div>
7450 </div>
7451 </div>
7452 <div class="chapter" title="Chapter 18. Tools needed for building or running">
7453 <div class="titlepage"><div><div><h2 class="title">
7454 <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
7455 <div class="toc">
7456 <p><b>Table of Contents</b></p>
7457 <dl>
7458 <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
7459 <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
7460 <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
7461 <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
7462 </dl>
7463 </div>
7464 <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
7465 by pkgsrc and also for individual packages to define what commands
7466 are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
7467 or for later run-time of an installed packaged (such as
7468 <code class="varname">DEPENDS</code>).
7469 If the native system provides an adequate tool, then in many cases, a pkgsrc
7470 package will not be used.</p>
7471 <p>When building a package, the replacement tools are
7472 made available in a directory (as symlinks or wrapper scripts)
7473 that is early in the executable search path. Just like the buildlink
7474 system, this helps with consistent builds.</p>
7475 <p>A tool may be needed to help build a specific package. For example,
7476 perl, GNU make (gmake) or yacc may be needed.</p>
7477 <p>Also a tool may be needed, for example, because the native system's supplied
7478 tool may be inefficient for building a package with pkgsrc.
7479 For example, a package may need GNU awk, bison (instead of
7480 yacc) or a better sed.</p>
7481 <p>The tools used by a package can be listed by running
7482 <span class="command"><strong>make show-tools</strong></span>.</p>
7483 <div class="sect1" title="18.1. Tools for pkgsrc builds">
7484 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7485 <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
7486 <p>The default set of tools used by pkgsrc is defined in
7487 <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
7488 such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
7489 <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
7490 These can be seen by running:
7491 <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
7492 <p>If a package needs a specific program to build
7493 then the <code class="varname">USE_TOOLS</code> variable can be used
7494 to define the tools needed.</p>
7495 </div>
7496 <div class="sect1" title="18.2. Tools needed by packages">
7497 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7498 <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
7499 <p>In the following examples, the :pkgsrc means to use the pkgsrc version
7500 and not the native version for a build dependency.
7501 And the :run means that it is used for a
7502 run-time dependencies also (and becomes a DEPENDS).
7503 The default is a build dependency which can be set with
7504 :build. (So in this example, it is the same as gmake:build
7505 and pkg-config:build.)</p>
7506 <pre class="programlisting">
7507 USE_TOOLS+=     mktemp:pkgsrc
7508 USE_TOOLS+=     gmake perl:run pkg-config
7509 </pre>
7510 <p>When using the tools framework, a
7511 <code class="varname">TOOLS_PATH.foo</code> variable is defined
7512 which contains the full path to the appropriate tool. For example,
7513 <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
7514 on Linux systems.</p>
7515 <p>If you always need a pkgsrc version of the
7516 tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
7517 </p>
7518 </div>
7519 <div class="sect1" title="18.3. Tools provided by platforms">
7520 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7521 <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
7522 <p>When improving or porting pkgsrc to a new platform, have a look
7523 at (or create) the corresponding platform specific make file fragment under
7524 <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
7525 the name of the common tools. For example:</p>
7526 <pre class="programlisting">
7527 .if exists(/usr/bin/bzcat)
7528 TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
7529 .elif exists(/usr/bin/bzip2)
7530 TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
7531 .endif
7532
7533 TOOLS_PLATFORM.true?=           true                    # shell builtin
7534 </pre>
7535 </div>
7536 <div class="sect1" title="18.4. Questions regarding the tools">
7537 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7538 <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
7539 <div class="qandaset" title="Frequently Asked Questions">
7540 <a name="id1168229333723"></a><dl>
7541 <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
7542 </dt>
7543 <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
7544         tools?</a>
7545 </dt>
7546 <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
7547         package is using while being built? I want to know whether it
7548         uses sed or not.</a>
7549 </dt>
7550 </dl>
7551 <table border="0" width="100%" summary="Q and A Set">
7552 <col align="left" width="1%">
7553 <col>
7554 <tbody>
7555 <tr class="question" title="18.4.1.">
7556 <td align="left" valign="top">
7557 <a name="tools.new"></a><a name="id1168229333726"></a><p><b>18.4.1.</b></p>
7558 </td>
7559 <td align="left" valign="top"><p>How do I add a new tool?</p></td>
7560 </tr>
7561 <tr class="answer">
7562 <td align="left" valign="top"></td>
7563 <td align="left" valign="top"><p>TODO</p></td>
7564 </tr>
7565 <tr class="question" title="18.4.2.">
7566 <td align="left" valign="top">
7567 <a name="tools.listall"></a><a name="id1168229333735"></a><p><b>18.4.2.</b></p>
7568 </td>
7569 <td align="left" valign="top"><p>How do I get a list of all available
7570         tools?</p></td>
7571 </tr>
7572 <tr class="answer">
7573 <td align="left" valign="top"></td>
7574 <td align="left" valign="top"><p>TODO</p></td>
7575 </tr>
7576 <tr class="question" title="18.4.3.">
7577 <td align="left" valign="top">
7578 <a name="tools.used"></a><a name="id1168229333744"></a><p><b>18.4.3.</b></p>
7579 </td>
7580 <td align="left" valign="top"><p>How can I get a list of all the tools that a
7581         package is using while being built? I want to know whether it
7582         uses sed or not.</p></td>
7583 </tr>
7584 <tr class="answer">
7585 <td align="left" valign="top"></td>
7586 <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
7587         to do it.)</p></td>
7588 </tr>
7589 </tbody>
7590 </table>
7591 </div>
7592 </div>
7593 </div>
7594 <div class="chapter" title="Chapter 19. Making your package work">
7595 <div class="titlepage"><div><div><h2 class="title">
7596 <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
7597 <div class="toc">
7598 <p><b>Table of Contents</b></p>
7599 <dl>
7600 <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
7601 <dd><dl>
7602 <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
7603 <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>
7604 <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
7605 <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
7606 <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
7607 <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
7608 <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
7609 <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
7610 <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
7611 <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
7612 <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
7613 <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
7614 </dl></dd>
7615 <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>
7616 <dd><dl>
7617 <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
7618 <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>
7619 </dl></dd>
7620 <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>
7621 <dd><dl>
7622 <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
7623 <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
7624 <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
7625 </dl></dd>
7626 <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
7627 <dd><dl>
7628 <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
7629 <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
7630 <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
7631 <dt><span class="sect2"><a href="#other-programming-languages">19.4.4. Other programming languages</a></span></dt>
7632 </dl></dd>
7633 <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>
7634 <dd><dl>
7635 <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
7636 <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
7637 <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>
7638 <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
7639 </dl></dd>
7640 <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>
7641 <dd><dl>
7642 <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
7643 <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
7644 <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
7645 <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
7646 <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
7647 <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
7648 <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
7649 <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
7650 <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
7651 <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
7652 <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
7653 <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
7654 <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
7655 <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
7656 <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
7657 <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
7658 <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
7659 <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
7660     emulation</a></span></dt>
7661 <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
7662 <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
7663 </dl></dd>
7664 <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
7665 </dl>
7666 </div>
7667 <div class="sect1" title="19.1. General operation">
7668 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
7669 <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
7670 <div class="sect2" title="19.1.1. Portability of packages">
7671 <div class="titlepage"><div><div><h3 class="title">
7672 <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
7673 <p>One appealing feature of pkgsrc is that it runs on many
7674     different platforms. As a result, it is important to ensure,
7675     where possible, that packages in pkgsrc are portable. This
7676     chapter mentions some particular details you should pay
7677     attention to while working on pkgsrc.</p>
7678 </div>
7679 <div class="sect2" title="19.1.2. How to pull in user-settable variables from mk.conf">
7680 <div class="titlepage"><div><div><h3 class="title">
7681 <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>
7682 </h3></div></div></div>
7683 <p>The pkgsrc user can configure pkgsrc by overriding several
7684     variables in the file pointed to by <code class="varname">MAKECONF</code>,
7685     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
7686     want to use those variables in the preprocessor directives of
7687     <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
7688     <code class="literal">.for</code>), you need to include the file
7689     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
7690     loads the user preferences.</p>
7691 <p>But note that some variables may not be completely defined
7692     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
7693     included, as they may contain references to variables that are
7694     not yet defined. In shell commands this is no problem, since
7695     variables are actually macros, which are only expanded when they
7696     are used. But in the preprocessor directives mentioned above and
7697     in dependency lines (of the form <code class="literal">target:
7698     dependencies</code>) the variables are expanded at load
7699     time.</p>
7700 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
7701 <h3 class="title">Note</h3>
7702 <p>Currently there is no exhaustive list of all
7703     variables that tells you whether they can be used at load time
7704     or only at run time, but it is in preparation.</p>
7705 </div>
7706 </div>
7707 <div class="sect2" title="19.1.3. User interaction">
7708 <div class="titlepage"><div><div><h3 class="title">
7709 <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
7710 <p>Occasionally, packages require interaction from the user,
7711     and this can be in a number of ways:</p>
7712 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
7713 <li class="listitem"><p>When fetching the distfiles, some packages require user
7714         interaction such as entering username/password or accepting a
7715         license on a web page.</p></li>
7716 <li class="listitem"><p>When extracting the distfiles, some packages may ask for
7717         passwords.</p></li>
7718 <li class="listitem"><p>help to configure the package before it is built</p></li>
7719 <li class="listitem"><p>help during the build process</p></li>
7720 <li class="listitem"><p>help during the installation of a package</p></li>
7721 </ul></div>
7722 <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
7723     provided to notify the pkgsrc mechanism of an interactive stage
7724     which will be needed, and this should be set in the package's
7725     <code class="filename">Makefile</code>, e.g.:</p>
7726 <pre class="programlisting">
7727 INTERACTIVE_STAGE=      build
7728     </pre>
7729 <p>Multiple interactive stages can be specified:</p>
7730 <pre class="programlisting">
7731 INTERACTIVE_STAGE=      configure install
7732     </pre>
7733 <p>The user can then decide to skip this package by setting the
7734     <code class="varname">BATCH</code> variable.</p>
7735 </div>
7736 <div class="sect2" title="19.1.4. Handling licenses">
7737 <div class="titlepage"><div><div><h3 class="title">
7738 <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
7739 <p>Authors of software can choose the licence under which
7740     software can be copied.  This is due to copyright law, and reasons
7741     for license choices are outside the scope of pkgsrc.  The pkgsrc
7742     system recognizes that there are a number of licenses which some
7743     users may find objectionable or difficult or impossible to comply
7744     with.  The Free Software Foundation has declared some licenses
7745     "Free", and the Open Source Initiative has a definition of "Open
7746     Source".  The pkgsrc system, as a policy choice, does not label
7747     packages which have licenses that are Free or Open Source.
7748     However, packages without a license meeting either of those tests
7749     are labeled with a license tag denoting the license.  Note that a
7750     package with no license to copy trivially does not meet either the
7751     Free or Open Source test.</p>
7752 <p>For packages which are not Free or Open Source, pkgsrc will
7753     not build the package unless the user has indicated to pkgsrc that
7754     packages with that particular license may be built.  Note that
7755     this documentation avoids the term "accepted the license".  The
7756     pkgsrc system is merely providing a mechanism to avoid
7757     accidentally building a package with a non-free license;
7758     judgement and responsibility remain with the user.  (Installation
7759     of binary packages are not currently subject to this mechanism;
7760     this is a bug.)</p>
7761 <p>One might want to only install packages with a BSD license,
7762     or the GPL, and not the other.  The free licenses are added to the
7763     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
7764     user can override the default by setting the
7765     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
7766     of "+=".  The licenses accepted by default are:
7767     </p>
7768 <pre class="programlisting">
7769     public-domain
7770     gnu-gpl-v2 gnu-lgpl-v2
7771     gnu-gpl-v3 gnu-lgpl-v3
7772     original-bsd modified-bsd
7773     x11
7774     apache-2.0
7775     cddl-1.0
7776     open-font-license
7777     </pre>
7778 <p>
7779     </p>
7780 <p>The license tag mechanism is intended to address
7781     copyright-related issues surrounding building, installing and
7782     using a package, and not to address redistribution issues (see
7783     <code class="varname">RESTRICTED</code> and
7784     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
7785     Packages with redistribution restrictions should set these
7786     tags.</p>
7787 <p>Denoting that a package may be copied according to a
7788     particular license is done by placing the license in
7789     <code class="filename">pkgsrc/licenses</code> and setting the
7790     <code class="varname">LICENSE</code> variable to a string identifying the
7791     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>
7792 <pre class="programlisting">
7793 LICENSE=        xv-license
7794     </pre>
7795 <p>When trying to build, the user will get a notice that the
7796     package is covered by a license which has not been placed in the
7797     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
7798 <pre class="programlisting">
7799 <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
7800 ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
7801 ===&gt;     To view the license, enter "/usr/bin/make show-license".
7802 ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
7803 ===&gt;     ACCEPTABLE_LICENSES+=xv-license
7804 *** Error code 1
7805     </pre>
7806 <p>The license can be viewed with <span class="command"><strong>make
7807     show-license</strong></span>, and if the user so chooses, the line
7808     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
7809     convey to pkgsrc that it should not in the future fail because of
7810     that license:</p>
7811 <pre class="programlisting">
7812 ACCEPTABLE_LICENSES+=xv-license
7813     </pre>
7814 <p>When adding a package with a new license, the license text
7815     should be added to <code class="filename">pkgsrc/licenses</code> for
7816     displaying.  A list of known licenses can be seen in this
7817     directory.</p>
7818 <p>When the license changes (in a way other than formatting),
7819     please make sure that the new license has a different name (e.g.,
7820     append the version number if it exists, or the date).  Just
7821     because a user told pkgsrc to build programs under a previous
7822     version of a license does not mean that pkgsrc should build
7823     programs under the new licenses.  The higher-level point is that
7824     pkgsrc does not evaluate licenses for reasonableness; the only
7825     test is a mechanistic test of whether a particular text has been
7826     approved by either of two bodies.</p>
7827 <p>The use of <code class="varname">LICENSE=shareware</code>,
7828     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
7829     is deprecated because it does not crisply refer to a particular
7830     license text.  Another problem with such usage is that it does not
7831     enable a user to tell pkgsrc to proceed for a single package
7832     without also telling pkgsrc to proceed for all packages with that
7833     tag.</p>
7834 </div>
7835 <div class="sect2" title="19.1.5. Restricted packages">
7836 <div class="titlepage"><div><div><h3 class="title">
7837 <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
7838 <p>Some licenses restrict how software may be re-distributed.
7839     Because a license tag is required unless the package is Free or
7840     Open Source, all packages with restrictions should have license
7841     tags.  By declaring the restrictions, package tools can
7842     automatically refrain from e.g. placing binary packages on FTP
7843     sites.</p>
7844 <p>There are four restrictions that may be encoded, which are
7845     the cross product of sources (distfiles) and binaries not being
7846     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
7847     language in any license, and because non-Free licenses tend to be
7848     different from each other, pkgsrc adopts a definition of FTP and
7849     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
7850     should not be made available over the Internet at no charge.
7851     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
7852     made available on some kind of media, together with other source
7853     and binary packages, and which is sold for a distribution charge.
7854     </p>
7855 <p>In order to encode these restrictions, the package system
7856     defines five make variables that can be set to note these
7857     restrictions:</p>
7858 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
7859 <li class="listitem">
7860 <p><code class="varname">RESTRICTED</code></p>
7861 <p>This variable should be set whenever a restriction
7862         exists (regardless of its kind).  Set this variable to a
7863         string containing the reason for the restriction.  It should
7864         be understood that those wanting to understand the restriction
7865         will have to read the license, and perhaps seek advice of
7866         counsel.</p>
7867 </li>
7868 <li class="listitem">
7869 <p><code class="varname">NO_BIN_ON_CDROM</code></p>
7870 <p>Binaries may not be placed on CD-ROM containing other
7871         binary packages, for which a distribution charge may be made.
7872         In this case, set this variable to
7873         <code class="varname">${RESTRICTED}</code>.</p>
7874 </li>
7875 <li class="listitem">
7876 <p><code class="varname">NO_BIN_ON_FTP</code></p>
7877 <p>Binaries may not made available on the Internet without
7878         charge.  In this case, set this variable to
7879         <code class="varname">${RESTRICTED}</code>.  If this variable is set,
7880         binary packages will not be included on ftp.NetBSD.org.</p>
7881 </li>
7882 <li class="listitem">
7883 <p><code class="varname">NO_SRC_ON_CDROM</code></p>
7884 <p>Distfiles may not be placed on CD-ROM, together with
7885         other distfiles, for which a fee may be charged.  In this
7886         case, set this variable to <code class="varname">${RESTRICTED}</code>.
7887         </p>
7888 </li>
7889 <li class="listitem">
7890 <p><code class="varname">NO_SRC_ON_FTP</code></p>
7891 <p>Distfiles may not made available via FTP at no charge.
7892         In this case, set this variable to
7893         <code class="varname">${RESTRICTED}</code>.  If this variable is set,
7894         the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
7895 </li>
7896 </ul></div>
7897 </div>
7898 <div class="sect2" title="19.1.6. Handling dependencies">
7899 <div class="titlepage"><div><div><h3 class="title">
7900 <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
7901 <p>Your package may depend on some other package being present
7902     - and there are various ways of expressing this dependency.
7903     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
7904     <code class="varname">DEPENDS</code> definitions, the
7905     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
7906     via <code class="filename">buildlink3.mk</code>, which is the preferred way
7907     to handle dependencies, and which uses the variables named above.
7908     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
7909 <p>The basic difference between the two variables is as
7910     follows: The <code class="varname">DEPENDS</code> definition registers
7911     that pre-requisite in the binary package so it will be pulled in
7912     when the binary package is later installed, whilst the
7913     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
7914     dependency that is only needed for building the package.</p>
7915 <p>This means that if you only need a package present whilst
7916     you are building, it should be noted as a
7917     <code class="varname">BUILD_DEPENDS</code>.</p>
7918 <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
7919     <code class="varname">DEPENDS</code> definition is:</p>
7920 <pre class="programlisting">
7921 &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
7922     </pre>
7923 <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
7924     may include any of the wildcard version numbers recognized by
7925     <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>
7926 <div class="orderedlist"><ol class="orderedlist" type="1">
7927 <li class="listitem">
7928 <p>If your package needs another package's binaries or
7929         libraries to build or run, and if that package has a
7930         <code class="filename">buildlink3.mk</code> file available, use it:</p>
7931 <pre class="programlisting">
7932 .include "../../graphics/jpeg/buildlink3.mk"
7933         </pre>
7934 </li>
7935 <li class="listitem">
7936 <p>If your package needs binaries from another package to build,
7937         use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
7938 <pre class="programlisting">
7939 BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
7940         </pre>
7941 </li>
7942 <li class="listitem"><p>If your package needs a library with which to link and
7943         there is no <code class="filename">buildlink3.mk</code> file
7944         available, create one. Using
7945         <code class="varname">DEPENDS</code> won't be sufficient because the
7946         include files and libraries will be hidden from the compiler.</p></li>
7947 <li class="listitem">
7948 <p>If your package needs some executable to be able to run
7949         correctly and if there's no
7950         <code class="filename">buildlink3.mk</code> file, this is specified
7951         using the <code class="varname">DEPENDS</code> variable. The
7952         <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
7953         be able to execute the latex binary from the teTeX package
7954         when it runs, and that is specified:</p>
7955 <pre class="programlisting">
7956 DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
7957         </pre>
7958 </li>
7959 <li class="listitem">
7960 <p>You can use wildcards in package dependencies. Note that
7961         such wildcard dependencies are retained when creating binary
7962         packages. The dependency is checked when installing the binary
7963         package and any package which matches the pattern will be
7964         used. Wildcard dependencies should be used with care.</p>
7965 <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
7966         <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
7967         such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
7968         <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
7969 <p>Wildcards can also be used to specify that a package
7970         will only build against a certain minimum version of a
7971         pre-requisite:</p>
7972 <pre class="programlisting">
7973 DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
7974         </pre>
7975 <p>This means that the package will build using version 6.0
7976         of ImageMagick or newer. Such a dependency may be warranted
7977         if, for example, the command line options of an executable
7978         have changed.</p>
7979 <p>If you need to depend on minimum versions of libraries,
7980         see the buildlink section of the pkgsrc guide.</p>
7981 <p>For security fixes, please update the package
7982         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
7983         information.</p>
7984 </li>
7985 </ol></div>
7986 <p>If your package needs files from another package to build,
7987     add the relevant distribution files to
7988     <code class="varname">DISTFILES</code>, so they will be extracted
7989     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.
7990     (It relies on the jpeg sources being present in source form
7991     during the build.)</p>
7992 </div>
7993 <div class="sect2" title="19.1.7. Handling conflicts with other packages">
7994 <div class="titlepage"><div><div><h3 class="title">
7995 <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
7996 <p>Your package may conflict with other packages a user might
7997     already have installed on his system, e.g. if your package
7998     installs the same set of files as another package in the pkgsrc
7999     tree.</p>
8000 <p>In this case you can set <code class="varname">CONFLICTS</code> to a
8001     space-separated list of packages (including version string) your
8002     package conflicts with.</p>
8003 <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>
8004     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>
8005     install the same shared library, thus you set in
8006     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
8007 <pre class="programlisting">
8008 CONFLICTS=      Xaw-Xpm-[0-9]*
8009     </pre>
8010 <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
8011 <pre class="programlisting">
8012 CONFLICTS=      Xaw3d-[0-9]*
8013     </pre>
8014 <p>Packages will automatically conflict with other packages
8015     with the name prefix and a different version
8016     string. <span class="quote">&#8220;<span class="quote">Xaw3d-1.5</span>&#8221;</span> e.g. will automatically
8017     conflict with the older version <span class="quote">&#8220;<span class="quote">Xaw3d-1.3</span>&#8221;</span>.</p>
8018 </div>
8019 <div class="sect2" title="19.1.8. Packages that cannot or should not be built">
8020 <div class="titlepage"><div><div><h3 class="title">
8021 <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
8022 <p>There are several reasons why a package might be
8023     instructed to not build under certain circumstances.  If the
8024     package builds and runs on most platforms, the exceptions
8025     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
8026     the package builds and runs on a small handful of platforms,
8027     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
8028     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
8029     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
8030     (OS-version-platform) that can use glob-style
8031     wildcards.</p>
8032 <p>Some packages are tightly bound to a specific version of an
8033     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
8034     backwards compatible with other versions of the OS, and should be
8035     uploaded to a version specific directory on the FTP server.  Mark
8036     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
8037     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
8038     the package system internals, but may be used in the
8039     future.</p>
8040 <p>If the package should be skipped (for example, because it
8041     provides functionality already provided by the system), set
8042     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
8043     the package should fail because some preconditions are not met,
8044     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
8045     message.</p>
8046 </div>
8047 <div class="sect2" title="19.1.9. Packages which should not be deleted, once installed">
8048 <div class="titlepage"><div><div><h3 class="title">
8049 <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
8050 <p>To ensure that a package may not be deleted, once it has been
8051     installed, the <code class="varname">PKG_PRESERVE</code> definition should
8052     be set in the package Makefile. This will be carried into any
8053     binary package that is made from this pkgsrc entry. A
8054     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
8055     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
8056     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
8057 </div>
8058 <div class="sect2" title="19.1.10. Handling packages with security problems">
8059 <div class="titlepage"><div><div><h3 class="title">
8060 <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
8061 <p>When a vulnerability is found, this should be noted in
8062     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
8063     and after committing that file, use <span class="command"><strong>make upload</strong></span>
8064     in the same directory to update the file on ftp.NetBSD.org.</p>
8065 <p>After fixing the vulnerability by a patch, its
8066     <code class="varname">PKGREVISION</code> should be increased (this
8067     is of course not necessary if the problem is fixed by using
8068     a newer release of the software).</p>
8069 <p>Also, if the fix should be applied to the stable pkgsrc
8070     branch, be sure to submit a pullup request!</p>
8071 <p>Binary packages already on ftp.NetBSD.org will be handled
8072     semi-automatically by a weekly cron job.</p>
8073 </div>
8074 <div class="sect2" title="19.1.11. How to handle incrementing versions when fixing an existing package">
8075 <div class="titlepage"><div><div><h3 class="title">
8076 <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
8077 <p>When making fixes to an existing package it can be useful
8078     to change the version number in <code class="varname">PKGNAME</code>. To
8079     avoid conflicting with future versions by the original author, a
8080     <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
8081     on package versions by setting <code class="varname">PKGREVISION=1</code>
8082     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
8083     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
8084 <pre class="programlisting">
8085 DISTNAME=       foo-17.42
8086 PKGREVISION=    9
8087     </pre>
8088 <p>will result in a <code class="varname">PKGNAME</code> of
8089     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
8090     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
8091     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
8092     <code class="varname">PKGNAME_NOREV</code>.</p>
8093 <p>When a new release of the package is released, the
8094     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
8095     minor release of the above package, things should be like:</p>
8096 <pre class="programlisting">
8097 DISTNAME=       foo-17.43
8098     </pre>
8099 <p><code class="varname">PKGREVISION</code> should be incremented for any
8100     non-trivial change in the resulting binary package.  Without a
8101     <code class="varname">PKGREVISION</code> bump, someone with the previous
8102     version installed has no way of knowing that their package is out
8103     of date.  Thus, changes without increasing
8104     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
8105     trivial that no reasonable person would want to upgrade", and this
8106     is the rough test for when increasing
8107     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
8108     changes that do not merit increasing
8109     <code class="varname">PKGREVISION</code> are:</p>
8110 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8111 <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
8112       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
8113       or comments in Makefile.</p></li>
8114 <li class="listitem"><p>
8115       Changing build variables if the resulting binary package is the same.</p></li>
8116 <li class="listitem"><p>
8117       Changing <code class="filename">DESCR</code>.</p></li>
8118 <li class="listitem"><p>
8119       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
8120 </ul></div>
8121 <p>Examples of changes that do merit an increase to
8122     <code class="varname">PKGREVISION</code> include:</p>
8123 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8124 <li class="listitem"><p>
8125       Security fixes</p></li>
8126 <li class="listitem"><p>
8127       Changes or additions to a patch file</p></li>
8128 <li class="listitem"><p>
8129       Changes to the <code class="filename">PLIST</code></p></li>
8130 <li class="listitem"><p>A dependency is changed or renamed.</p></li>
8131 </ul></div>
8132 <p>PKGREVISION must also be incremented when dependencies have ABI
8133     changes.</p>
8134 </div>
8135 <div class="sect2" title="19.1.12. Substituting variable text in the package files (the SUBST framework)">
8136 <div class="titlepage"><div><div><h3 class="title">
8137 <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
8138 <p>When you want to replace the same text in multiple files
8139     or when the replacement text varies, patches alone cannot help.
8140     This is where the SUBST framework comes in. It provides an
8141     easy-to-use interface for replacing text in files.
8142     Example:</p>
8143 <pre class="programlisting">
8144 SUBST_CLASSES+=                 fix-paths
8145 SUBST_STAGE.fix-paths=          pre-configure
8146 SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
8147 SUBST_FILES.fix-paths=          src/*.c
8148 SUBST_FILES.fix-paths+=         scripts/*.sh
8149 SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
8150 SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
8151     </pre>
8152 <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
8153     that are used to identify the different SUBST blocks that are
8154     defined. The SUBST framework is heavily used by pkgsrc, so it is
8155     important to always use the <code class="literal">+=</code> operator with
8156     this variable. Otherwise some substitutions may be
8157     skipped.</p>
8158 <p>The remaining variables of each SUBST block are
8159     parameterized with the identifier from the first line
8160     (<code class="literal">fix-paths</code> in this case.) They can be seen as
8161     parameters to a function call.</p>
8162 <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
8163     which the replacement will take place. All combinations of
8164     <code class="literal">pre-</code>, <code class="literal">do-</code> and
8165     <code class="literal">post-</code> together with a phase name are
8166     possible, though only few are actually used. Most commonly used
8167     are <code class="literal">post-patch</code> and
8168     <code class="literal">pre-configure</code>. Of these two,
8169     <code class="literal">pre-configure</code> should be preferred because
8170     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
8171     have the state after applying the patches but before making any
8172     other changes. This is especially useful when you are debugging
8173     a package in order to create new patches for it. Similarly,
8174     <code class="literal">post-build</code> is preferred over
8175     <code class="literal">pre-install</code>, because the install phase should
8176     generally be kept as simple as possible. When you use
8177     <code class="literal">post-build</code>, you have the same files in the
8178     working directory that will be installed later, so you can check
8179     if the substitution has succeeded.</p>
8180 <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
8181     that is printed just before the substitution is done.</p>
8182 <p><code class="varname">SUBST_FILES.*</code> is the list of shell
8183     globbing patterns that specifies the files in which the
8184     substitution will take place. The patterns are interpreted
8185     relatively to the <code class="varname">WRKSRC</code> directory.</p>
8186 <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
8187     <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
8188     command should be prefixed with <code class="literal">-e</code>, so that
8189     all SUBST blocks look uniform.</p>
8190 <p>There are some more variables, but they are so seldomly
8191     used that they are only documented in the
8192     <code class="filename">mk/subst.mk</code> file.</p>
8193 </div>
8194 </div>
8195 <div class="sect1" title="19.2. Fixing problems in the fetch phase">
8196 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8197 <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
8198 <div class="sect2" title="19.2.1. Packages whose distfiles aren't available for plain downloading">
8199 <div class="titlepage"><div><div><h3 class="title">
8200 <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
8201 <p>If you need to download from a dynamic URL you can set
8202     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
8203     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
8204     with the name of each file to download as an argument, expecting
8205     it to output the URL of the directory from which to download
8206     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
8207     example of this usage.</p>
8208 <p>If the download can't be automated, because the user must
8209     submit personal information to apply for a password, or must pay
8210     for the source, or whatever, you can set
8211     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
8212     displayed to the user before aborting the build. Example:</p>
8213 <pre class="programlisting">
8214 FETCH_MESSAGE=  "Please download the files"
8215 FETCH_MESSAGE+= "    "${DISTFILES:Q}
8216 FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
8217     </pre>
8218 </div>
8219 <div class="sect2" title="19.2.2. How to handle modified distfiles with the 'old' name">
8220 <div class="titlepage"><div><div><h3 class="title">
8221 <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
8222 <p>Sometimes authors of a software package make some
8223     modifications after the software was released, and they put up a
8224     new distfile without changing the package's version number. If a
8225     package is already in pkgsrc at that time, the checksum will
8226     no longer match. The contents of the new distfile should be
8227     compared against the old one before changing anything, to make
8228     sure the distfile was really updated on purpose, and that
8229     no trojan horse or so crept in.
8230     Please mention that the distfiles were compared and what was found
8231     in your commit message.
8232     Then, the correct way to work around this is to
8233     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
8234     usually based on <code class="varname">PKGNAME_NOREV</code>. All
8235     <code class="varname">DISTFILES</code> and
8236     <code class="varname">PATCHFILES</code> for this package will be put in that
8237     subdirectory of the local distfiles directory.
8238     (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.)
8239     In case this
8240     happens more often, <code class="varname">PKGNAME</code> can be used (thus
8241     including the <code class="filename">nbX</code> suffix) or a date stamp
8242     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.
8243     Do not forget regenerating the <code class="filename">distinfo</code> file
8244     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
8245     path in the filenames.
8246     Also increase the PKGREVISION if the installed package is different.
8247     Furthermore, a mail to the package's authors seems appropriate
8248     telling them that changing distfiles after releases without
8249     changing the file names is not good practice.</p>
8250 </div>
8251 </div>
8252 <div class="sect1" title="19.3. Fixing problems in the configure phase">
8253 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8254 <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
8255 <div class="sect2" title="19.3.1. Shared libraries - libtool">
8256 <div class="titlepage"><div><div><h3 class="title">
8257 <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
8258 <p>pkgsrc supports many different machines, with different
8259     object formats like a.out and ELF, and varying abilities to do
8260     shared library and dynamic loading at all. To accompany this,
8261     varying commands and options have to be passed to the
8262     compiler, linker, etc. to get the Right Thing, which can be
8263     pretty annoying especially if you don't have all the machines
8264     at your hand to test things.  The
8265     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
8266     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
8267     both static and dynamic libraries from a set of source files,
8268     thus being platform-independent.</p>
8269 <p>Here's how to use libtool in a package in seven simple
8270     steps:</p>
8271 <div class="orderedlist"><ol class="orderedlist" type="1">
8272 <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
8273         Makefile.</p></li>
8274 <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
8275         ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
8276         add it to the definition of <code class="varname">CC</code>, if only
8277         libraries are being built in a given Makefile. This one command
8278         will build both PIC and non-PIC library objects, so you need not
8279         have separate shared and non-shared library rules.</p></li>
8280 <li class="listitem">
8281 <p>For the linking of the library, remove any
8282         <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
8283         -Bshareable</span>&#8221;</span> commands, and instead use:</p>
8284 <pre class="programlisting">
8285 ${LIBTOOL} --mode=link \
8286     ${CC} -o ${.TARGET:.a=.la} \
8287         ${OBJS:.o=.lo} \
8288         -rpath ${PREFIX}/lib \
8289         -version-info major:minor
8290         </pre>
8291 <p>Note that the library is changed to have a
8292         <code class="filename">.la</code> extension, and the objects are
8293         changed to have a <code class="filename">.lo</code>
8294         extension. Change <code class="varname">OBJS</code> as
8295         necessary. This automatically creates all of the
8296         <code class="filename">.a</code>,
8297         <code class="filename">.so.major.minor</code>, and ELF symlinks (if
8298         necessary) in the build directory. Be sure to include
8299         <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
8300         minor are zero, as libtool will otherwise strip off the
8301         shared library version.</p>
8302 <p>From the libtool manual:</p>
8303 <pre class="programlisting">
8304 So, libtool library versions are described by three integers:
8305
8306 CURRENT
8307 The most recent interface number that this library implements.
8308
8309 REVISION
8310 The implementation number of the CURRENT interface.
8311
8312 AGE
8313 The difference between the newest and oldest interfaces that
8314 this library implements.  In other words, the library implements
8315 all the interface numbers in the range from number `CURRENT -
8316 AGE' to `CURRENT'.
8317
8318 If two libraries have identical CURRENT and AGE numbers, then the
8319 dynamic linker chooses the library with the greater REVISION number.
8320         </pre>
8321 <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
8322         different results for a.out and ELF (excluding symlinks)
8323         in only one case. An ELF library of the form
8324         <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>
8325         will have a symlink of
8326         <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>
8327         on an a.out platform. This is handled
8328         automatically.</p>
8329 <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
8330         directory of the library being built.</p>
8331 <p>In the <code class="filename">PLIST</code>, include only the
8332         <code class="filename">.la</code> file, the other files will be
8333         added automatically.</p>
8334 </li>
8335 <li class="listitem">
8336 <p>When linking shared object (<code class="filename">.so</code>)
8337         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
8338         shared libraries, use <span class="quote">&#8220;<span class="quote">-module
8339         -avoid-version</span>&#8221;</span> to prevent them getting version
8340         tacked on.</p>
8341 <p>The <code class="filename">PLIST</code> file gets the
8342         <code class="filename">foo.so</code> entry.</p>
8343 </li>
8344 <li class="listitem">
8345 <p>When linking programs that depend on these libraries
8346         <span class="emphasis"><em>before</em></span> they are installed, preface
8347         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}
8348         --mode=link</span>&#8221;</span>, and it will find the correct
8349         libraries (static or shared), but please be aware that
8350         libtool will not allow you to specify a relative path in
8351         -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
8352         expects you to change that argument to be the
8353         <code class="filename">.la</code> file. e.g.</p>
8354 <pre class="programlisting">
8355 ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
8356         </pre>
8357 <p>should be changed to:</p>
8358 <pre class="programlisting">
8359 ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
8360         </pre>
8361 <p>and it will do the right thing with the libraries.</p>
8362 </li>
8363 <li class="listitem">
8364 <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>
8365         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}
8366         --mode=install</span>&#8221;</span>, and change the library name to
8367         <code class="filename">.la</code>. e.g.</p>
8368 <pre class="programlisting">
8369 ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
8370         </pre>
8371 <p>This will install the static <code class="filename">.a</code>,
8372         shared library, any needed symlinks, and run
8373         <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>
8374 </li>
8375 <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
8376         the <code class="filename">.la</code>
8377         file (this is a change from previous behaviour).</p></li>
8378 </ol></div>
8379 </div>
8380 <div class="sect2" title="19.3.2. Using libtool on GNU packages that already support libtool">
8381 <div class="titlepage"><div><div><h3 class="title">
8382 <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
8383 <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
8384     package Makefile. This will override the package's own libtool
8385     in most cases.  For older libtool using packages,  libtool is
8386     made by ltconfig script during the do-configure step; you can
8387     check the libtool script location by doing <span class="command"><strong>make
8388     configure; find work*/ -name libtool</strong></span>.</p>
8389 <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
8390     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
8391     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
8392     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
8393     package's libtool script(s), set it as appropriate.</p>
8394 <p>If you do not need <code class="filename">*.a</code> static
8395     libraries built and installed, then use
8396     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
8397 <p>If your package makes use of the platform-independent library
8398     for loading dynamic shared objects, that comes with libtool
8399     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
8400 <p>Some packages use libtool incorrectly so that the package
8401     may not work or build in some circumstances. Some of the more
8402     common errors are:</p>
8403 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8404 <li class="listitem">
8405 <p>The inclusion of a shared object (-module) as a dependent library in an
8406         executable or library. This in itself isn't a problem if one of two things
8407         has been done:</p>
8408 <div class="orderedlist"><ol class="orderedlist" type="1">
8409 <li class="listitem"><p>The shared object is named correctly, i.e.
8410             <code class="filename">libfoo.la</code>, not
8411             <code class="filename">foo.la</code></p></li>
8412 <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
8413 </ol></div>
8414 </li>
8415 <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
8416         The function lt_dlinit() should be called and the macro
8417         <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
8418         executables.</p></li>
8419 </ul></div>
8420 </div>
8421 <div class="sect2" title="19.3.3. GNU Autoconf/Automake">
8422 <div class="titlepage"><div><div><h3 class="title">
8423 <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
8424 <p>If a package needs GNU autoconf or automake to be executed
8425     to regenerate the configure script and Makefile.in makefile
8426     templates, then they should be executed in a pre-configure
8427     target.</p>
8428 <p>For packages that need only autoconf:</p>
8429 <pre class="programlisting">
8430 AUTOCONF_REQD=  2.50            # if default version is not good enough
8431 USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
8432 ...
8433
8434 pre-configure:
8435         cd ${WRKSRC} &amp;&amp; autoconf
8436
8437 ...
8438     </pre>
8439 <p>and for packages that need automake and autoconf:</p>
8440 <pre class="programlisting">
8441 AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
8442 USE_TOOLS+=     automake        # use "automake14" for automake-1.4
8443 ...
8444
8445 pre-configure:
8446         set -e; cd ${WRKSRC}; \
8447         aclocal; autoheader; automake -a --foreign -i; autoconf
8448
8449 ...
8450     </pre>
8451 <p>Packages which use GNU Automake will almost certainly
8452     require GNU Make.</p>
8453 <p>There are times when the configure process makes
8454     additional changes to the generated files, which then causes
8455     the build process to try to re-execute the automake sequence.
8456     This is prevented by touching various files in the configure
8457     stage. If this causes problems with your package you can set
8458     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
8459     Makefile.</p>
8460 </div>
8461 </div>
8462 <div class="sect1" title="19.4. Programming languages">
8463 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8464 <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
8465 <div class="sect2" title="19.4.1. C, C++, and Fortran">
8466 <div class="titlepage"><div><div><h3 class="title">
8467 <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
8468 <p>Compilers for the C, C++, and Fortran languages comes with
8469     the NetBSD base system.  By default, pkgsrc assumes that a package
8470     is written in C and will hide all other compilers (via the wrapper
8471     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
8472 <p>To declare which language's compiler a package needs, set
8473     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
8474     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
8475     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
8476     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
8477     written in C++, usually need a C compiler for the configure
8478     phase.</p>
8479 </div>
8480 <div class="sect2" title="19.4.2. Java">
8481 <div class="titlepage"><div><div><h3 class="title">
8482 <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
8483 <p>If a program is written in Java, use the Java framework in
8484     pkgsrc.  The package must include
8485     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
8486     provides the following variables:</p>
8487 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8488 <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
8489       dependency on the JDK is added.  If
8490       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
8491       there is only a runtime dependency on the JDK.  The default is
8492       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
8493       JDK.</p></li>
8494 <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
8495       a package needs a Java2 implementation.  The supported values
8496       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
8497       <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
8498       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
8499       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
8500       above. This variable is not set by default.</p></li>
8501 <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
8502       automatically set to the runtime location of the used Java
8503       implementation dependency. It may be used to set
8504       <code class="varname">JAVA_HOME</code> to a good value if the program
8505       needs this variable to be defined.
8506       </p></li>
8507 </ul></div>
8508 </div>
8509 <div class="sect2" title="19.4.3. Packages containing perl scripts">
8510 <div class="titlepage"><div><div><h3 class="title">
8511 <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
8512 <p>If your package contains interpreted perl scripts, add
8513     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
8514     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
8515     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
8516     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
8517     that you want adjusted.  Every occurrence of
8518     <code class="filename">*/bin/perl</code> will be replaced with the full
8519     path to the perl executable.</p>
8520 <p>If a particular version of perl is needed, set the
8521     <code class="varname">PERL5_REQD</code> variable to the version number.  The
8522     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
8523 <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
8524     about handling perl modules.</p>
8525 </div>
8526 <div class="sect2" title="19.4.4. Other programming languages">
8527 <div class="titlepage"><div><div><h3 class="title">
8528 <a name="other-programming-languages"></a>19.4.4. Other programming languages</h3></div></div></div>
8529 <p>Currently, there is no special handling for other languages
8530     in pkgsrc.  If a compiler package provides a
8531     <code class="filename">buildlink3.mk</code> file, include that, otherwise
8532     just add a (build) dependency on the appropriate compiler
8533     package.</p>
8534 </div>
8535 </div>
8536 <div class="sect1" title="19.5. Fixing problems in the build phase">
8537 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8538 <a name="fixes.build"></a>19.5. Fixing problems in the <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
8539 <p>The most common failures when building a package are that
8540         some platforms do not provide certain header files, functions or
8541         libraries, or they provide the functions in a library that the
8542         original package author didn't know. To work around this, you
8543         can rewrite the source code in most cases so that it does not
8544         use the missing functions or provides a replacement function.</p>
8545 <div class="sect2" title="19.5.1. Compiling C and C++ code conditionally">
8546 <div class="titlepage"><div><div><h3 class="title">
8547 <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
8548 <p>If a package already comes with a GNU configure script, the
8549         preferred way to fix the build failure is to change the
8550         configure script, not the code. In the other cases, you can
8551         utilize the C preprocessor, which defines certain macros
8552         depending on the operating system and hardware architecture it
8553         compiles for. These macros can be queried using for example
8554         <code class="varname">#if defined(__i386)</code>. Almost every operating
8555         system, hardware architecture and compiler has its own macro.
8556         For example, if the macros <code class="varname">__GNUC__</code>,
8557         <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
8558         are all defined, you know that you are using NetBSD on an i386
8559         compatible CPU, and your compiler is GCC.</p>
8560 <p>The list of the following macros for hardware and
8561         operating system depends on the compiler that is used. For
8562         example, if you want to conditionally compile code on Solaris,
8563         don't use <code class="varname">__sun__</code>, as the SunPro compiler
8564         does not define it. Use <code class="varname">__sun</code> instead.</p>
8565 <div class="sect3" title="19.5.1.1. C preprocessor macros to identify the operating system">
8566 <div class="titlepage"><div><div><h4 class="title">
8567 <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
8568 <p>To distinguish between 4.4 BSD-derived systems and the
8569         rest of the world, you should use the following code.</p>
8570 <pre class="programlisting">
8571 #include &lt;sys/param.h&gt;
8572 #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
8573 /* BSD-specific code goes here */
8574 #else
8575 /* non-BSD-specific code goes here */
8576 #endif
8577 </pre>
8578 <p>If this distinction is not fine enough, you can also test
8579         for the following macros.</p>
8580 <pre class="programlisting">
8581 FreeBSD     __FreeBSD__
8582 DragonFly   __DragonFly__
8583 Interix     __INTERIX
8584 IRIX        __sgi (TODO: get a definite source for this)
8585 Linux       linux, __linux, __linux__
8586 NetBSD      __NetBSD__
8587 OpenBSD     __OpenBSD__
8588 Solaris     sun, __sun
8589 </pre>
8590 </div>
8591 <div class="sect3" title="19.5.1.2. C preprocessor macros to identify the hardware architecture">
8592 <div class="titlepage"><div><div><h4 class="title">
8593 <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
8594 <pre class="programlisting">
8595 i386        i386, __i386, __i386__
8596 MIPS        __mips
8597 SPARC       sparc, __sparc
8598 </pre>
8599 </div>
8600 <div class="sect3" title="19.5.1.3. C preprocessor macros to identify the compiler">
8601 <div class="titlepage"><div><div><h4 class="title">
8602 <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
8603 <pre class="programlisting">
8604 GCC         __GNUC__ (major version), __GNUC_MINOR__
8605 MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
8606 SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
8607 SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
8608 </pre>
8609 </div>
8610 </div>
8611 <div class="sect2" title="19.5.2. How to handle compiler bugs">
8612 <div class="titlepage"><div><div><h3 class="title">
8613 <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
8614 <p>Some source files trigger bugs in the compiler, based on
8615         combinations of compiler version and architecture and almost
8616         always relation to optimisation being enabled.  Common symptoms
8617         are gcc internal errors or never finishing compiling a
8618         file.</p>
8619 <p>Typically, a workaround involves testing the
8620         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
8621         optimisation for that combination of file,
8622         <code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
8623         in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
8624         number of examples.</p>
8625 </div>
8626 <div class="sect2" title="19.5.3. Undefined reference to &#8220;...&#8221;">
8627 <div class="titlepage"><div><div><h3 class="title">
8628 <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
8629 </h3></div></div></div>
8630 <p>This error message often means that a package did not
8631         link to a shared library it needs. The following functions are
8632         known to cause this error message over and over.</p>
8633 <div class="informaltable">
8634 <a name="undefined-reference-functions"></a><table border="1">
8635 <colgroup>
8636 <col>
8637 <col>
8638 <col>
8639 </colgroup>
8640 <thead><tr>
8641 <th>Function</th>
8642 <th>Library</th>
8643 <th>Affected platforms</th>
8644 </tr></thead>
8645 <tbody>
8646 <tr>
8647 <td>accept, bind, connect</td>
8648 <td>-lsocket</td>
8649 <td>Solaris</td>
8650 </tr>
8651 <tr>
8652 <td>crypt</td>
8653 <td>-lcrypt</td>
8654 <td>DragonFly, NetBSD</td>
8655 </tr>
8656 <tr>
8657 <td>dlopen, dlsym</td>
8658 <td>-ldl</td>
8659 <td>Linux</td>
8660 </tr>
8661 <tr>
8662 <td>gethost*</td>
8663 <td>-lnsl</td>
8664 <td>Solaris</td>
8665 </tr>
8666 <tr>
8667 <td>inet_aton</td>
8668 <td>-lresolv</td>
8669 <td>Solaris</td>
8670 </tr>
8671 <tr>
8672 <td>nanosleep, sem_*, timer_*</td>
8673 <td>-lrt</td>
8674 <td>Solaris</td>
8675 </tr>
8676 <tr>
8677 <td>openpty</td>
8678 <td>-lutil</td>
8679 <td>Linux</td>
8680 </tr>
8681 </tbody>
8682 </table>
8683 </div>
8684 <p>To fix these linker errors, it is often sufficient to say
8685     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
8686     -l<em class="replaceable"><code>foo</code></em></code> to the package
8687     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
8688     bmake</strong></span>.</p>
8689 <div class="sect3" title="19.5.3.1. Special issue: The SunPro compiler">
8690 <div class="titlepage"><div><div><h4 class="title">
8691 <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
8692 <p>When you are using the SunPro compiler, there is another
8693 possibility. That compiler cannot handle the following code:</p>
8694 <pre class="programlisting">
8695 extern int extern_func(int);
8696
8697 static inline int
8698 inline_func(int x)
8699 {
8700         return extern_func(x);
8701 }
8702
8703 int main(void)
8704 {
8705         return 0;
8706 }
8707 </pre>
8708 <p>It generates the code for <code class="function">inline_func</code> even if
8709 that function is never used. This code then refers to
8710 <code class="function">extern_func</code>, which can usually not be resolved. To
8711 solve this problem you can try to tell the package to disable inlining
8712 of functions.</p>
8713 </div>
8714 </div>
8715 <div class="sect2" title="19.5.4. Running out of memory">
8716 <div class="titlepage"><div><div><h3 class="title">
8717 <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
8718 <p>Sometimes packages fail to build because the compiler runs
8719     into an operating system specific soft limit.  With the
8720     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
8721     to unlimit the resources.  Currently, the allowed values are
8722     <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).
8723     Setting this variable is similar to running the shell builtin
8724     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
8725     segment size or maximum stack size of a process, respectively, to
8726     their hard limits.</p>
8727 </div>
8728 </div>
8729 <div class="sect1" title="19.6. Fixing problems in the install phase">
8730 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
8731 <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
8732 <div class="sect2" title="19.6.1. Creating needed directories">
8733 <div class="titlepage"><div><div><h3 class="title">
8734 <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
8735 <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
8736     with some operating systems cannot create more than one
8737     directory at a time. As such, you should call
8738     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
8739 <pre class="programlisting">
8740 ${INSTALL_DATA_DIR} ${PREFIX}/dir1
8741 ${INSTALL_DATA_DIR} ${PREFIX}/dir2
8742     </pre>
8743 <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
8744     dir2</code></span>&#8221;</span> to the
8745     <code class="varname">INSTALLATION_DIRS</code> variable, which will
8746     automatically do the right thing.</p>
8747 </div>
8748 <div class="sect2" title="19.6.2. Where to install documentation">
8749 <div class="titlepage"><div><div><h3 class="title">
8750 <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
8751 <p>In general, documentation should be installed into
8752     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8753     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
8754     includes the version number of the package).</p>
8755 <p>Many modern packages using GNU autoconf allow to set the
8756     directory where HTML documentation is installed with the
8757     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
8758     is needed because otherwise the documentation ends up in
8759     <code class="filename">${PREFIX}/share/doc/html</code> or other
8760     places.</p>
8761 <p>An exception to the above is that library API documentation
8762     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
8763     browsers (devhelp) should be left at their default location, which
8764     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
8765     documentation can be recognized from files ending in
8766     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
8767     (It is also acceptable to install such files in
8768     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
8769     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
8770     <code class="filename">.devhelp*</code> file must be directly in that
8771     directory then, no additional subdirectory level is allowed in
8772     this case. This is usually achieved by using
8773     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
8774     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
8775     though.)</p>
8776 </div>
8777 <div class="sect2" title="19.6.3. Installing highscore files">
8778 <div class="titlepage"><div><div><h3 class="title">
8779 <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
8780 <p>Certain packages, most of them in the games category, install
8781     a score file that allows all users on the system to record their
8782     highscores.  In order for this to work, the binaries need to be
8783     installed setgid and the score files owned by the appropriate
8784     group and/or owner (traditionally the "games" user/group).  The
8785     following variables, documented in more detail in
8786     <code class="filename">mk/defaults/mk.conf</code>, control this
8787     behaviour: <code class="varname">SETGIDGAME</code>,
8788     <code class="varname">GAMEDATAMODE</code>, <code class="varname">GAMEGRP</code>,
8789     <code class="varname">GAMEMODE</code>, <code class="varname">GAMEOWN</code>.</p>
8790 <p>Note that per default, setgid installation of games is
8791     disabled;  setting <code class="varname">SETGIDGAME=YES</code> will set all
8792     the other variables accordingly.</p>
8793 <p>A package should therefore never hard code file ownership or
8794     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
8795     <code class="varname">INSTALL_GAME_DATA</code> to set these
8796     correctly.</p>
8797 </div>
8798 <div class="sect2" title="19.6.4. Adding DESTDIR support to packages">
8799 <div class="titlepage"><div><div><h3 class="title">
8800 <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
8801 <p><code class="varname">DESTDIR</code> support means that a package
8802     installs into a staging directory, not the final location of the
8803     files. Then a binary package is created which can be used for
8804     installation as usual. There are two ways: Either the package must
8805     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
8806     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
8807 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
8808 <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
8809       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
8810       bsd.prefs.mk is included in the Makefile,
8811       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
8812       the inclusion.</p></li>
8813 <li class="listitem"><p>All installation operations have to be prefixed with
8814       <code class="filename">${DESTDIR}</code>.</p></li>
8815 <li class="listitem"><p>automake gets this DESTDIR mostly right
8816       automatically. Many manual rules and pre/post-install often are
8817       incorrect; fix them.</p></li>
8818 <li class="listitem"><p>If files are installed with special owner/group
8819       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
8820 <li class="listitem"><p>In general, packages should support
8821       <code class="varname">UNPRIVILEGED</code> to be able to use
8822       DESTDIR.</p></li>
8823 </ul></div>
8824 </div>
8825 <div class="sect2" title="19.6.5. Packages with hardcoded paths to other interpreters">
8826 <div class="titlepage"><div><div><h3 class="title">
8827 <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
8828 <p>Your package may also contain scripts with hardcoded paths to
8829       other interpreters besides (or as well as) perl.  To correct the
8830       full pathname to the script interpreter, you need to set the
8831       following definitions in your <code class="filename">Makefile</code> (we
8832     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
8833 <pre class="programlisting">
8834 REPLACE_INTERPRETER+=   tcl
8835 REPLACE.tcl.old=        .*/bin/tclsh
8836 REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
8837 REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
8838 # relative to ${WRKSRC}, just as in REPLACE_PERL
8839     </pre>
8840 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
8841 <h3 class="title">Note</h3>
8842 <p>Before March 2006, these variables were called
8843     <code class="varname">_REPLACE.*</code> and
8844     <code class="varname">_REPLACE_FILES.*</code>.</p>
8845 </div>
8846 </div>
8847 <div class="sect2" title="19.6.6. Packages installing perl modules">
8848 <div class="titlepage"><div><div><h3 class="title">
8849 <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
8850 <p>Makefiles of packages providing perl5 modules should include
8851     the Makefile fragment
8852     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
8853     <span class="command"><strong>do-configure</strong></span> target for the standard perl
8854     configuration for such modules as well as various hooks to tune
8855     this configuration.  See comments in this file for
8856     details.</p>
8857 <p>Perl5 modules will install into different places depending
8858     on the version of perl used during the build process.  To
8859     address this, pkgsrc will append lines to the
8860     <code class="filename">PLIST</code> corresponding to the files listed in
8861     the installed <code class="filename">.packlist</code> file generated by
8862     most perl5 modules.  This is invoked by defining
8863     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
8864     paths to packlist files, e.g.:</p>
8865 <pre class="programlisting">
8866 PERL5_PACKLIST= ${PERL5_SITEARCH}/auto/Pg/.packlist
8867     </pre>
8868 <p>The variables <code class="varname">PERL5_SITELIB</code>,
8869     <code class="varname">PERL5_SITEARCH</code>, and
8870     <code class="varname">PERL5_ARCHLIB</code> represent the three locations
8871     in which perl5 modules may be installed, and may be used by
8872     perl5 packages that don't have a packlist.  These three
8873     variables are also substituted for in the
8874     <code class="filename">PLIST</code>.</p>
8875 </div>
8876 <div class="sect2" title="19.6.7. Packages installing info files">
8877 <div class="titlepage"><div><div><h3 class="title">
8878 <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
8879 <p>Some packages install info files or use the
8880     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
8881     commands.  <code class="varname">INFO_FILES</code> should be defined in
8882     the package Makefile so that <code class="filename">INSTALL</code> and
8883     <code class="filename">DEINSTALL</code> scripts will be generated to
8884     handle registration of the info files in the Info directory
8885     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
8886     files registration is either provided by the system, or by a
8887     special purpose package automatically added as dependency if
8888     needed.</p>
8889 <p><code class="varname">PKGINFODIR</code> is the directory under
8890     <code class="filename">${PREFIX}</code> where info files are primarily
8891     located. <code class="varname">PKGINFODIR</code> defaults to
8892     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
8893 <p>The info files for the package should be listed in the
8894     package <code class="filename">PLIST</code>; however any split info files
8895     need not be listed.</p>
8896 <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
8897     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
8898     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
8899     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
8900     should be noted with the <code class="varname">TEXINFO_REQD</code>
8901     variable in the package <code class="filename">Makefile</code>. By
8902     default, a minimum version of 3.12 is required. If the system
8903     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
8904     does not match the required minimum, a build dependency on the
8905     <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
8906     be added automatically.</p>
8907 <p>The build and installation process of the software provided
8908     by the package should not use the
8909     <span class="command"><strong>install-info</strong></span> command as the registration of
8910     info files is the task of the package
8911     <code class="filename">INSTALL</code> script, and it must use the
8912     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
8913 <p>To achieve this goal, the pkgsrc infrastructure creates
8914     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
8915     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
8916     in <code class="varname">PATH</code>.</p>
8917 <p>The script overriding <span class="command"><strong>install-info</strong></span> has
8918     no effect except the logging of a message. The script overriding
8919     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
8920     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
8921     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
8922 </div>
8923 <div class="sect2" title="19.6.8. Packages installing man pages">
8924 <div class="titlepage"><div><div><h3 class="title">
8925 <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
8926 <p>All packages that install manual pages should install them
8927     into the same directory, so that there is one common place to look
8928     for them. In pkgsrc, this place is
8929     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
8930     should be used in packages. The default for
8931     <code class="varname">PKGMANDIR</code> is
8932     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
8933     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
8934 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
8935 <h3 class="title">Note</h3>
8936 <p>The support for a custom <code class="varname">PKGMANDIR</code>
8937     is far from complete.</p>
8938 </div>
8939 <p>The <code class="filename">PLIST</code> files can just use
8940     <code class="filename">man/</code> as the top level directory for the man
8941     page file entries, and the pkgsrc framework will convert as
8942     needed. In all other places, the correct
8943     <code class="varname">PKGMANDIR</code> must be used.</p>
8944 <p>Packages that are
8945     configured with <code class="varname">GNU_CONFIGURE</code> set as
8946     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
8947     <code class="filename">./configure</code>
8948     --mandir switch to set where the man pages should be installed.
8949     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
8950     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
8951 <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
8952     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
8953     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
8954     Or if the <code class="filename">./configure</code> script uses
8955     a non-standard use of --mandir, you can set
8956     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
8957 <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
8958     information on installation of compressed manual pages.</p>
8959 </div>
8960 <div class="sect2" title="19.6.9. Packages installing GConf data files">
8961 <div class="titlepage"><div><div><h3 class="title">
8962 <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
8963 <p>If a package installs <code class="filename">.schemas</code> or
8964     <code class="filename">.entries</code> files, used by GConf,
8965     you need to take some extra steps to make sure they get registered
8966     in the database:</p>
8967 <div class="orderedlist"><ol class="orderedlist" type="1">
8968 <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
8969         instead of its <code class="filename">buildlink3.mk</code> file.  This
8970         takes care of rebuilding the GConf database at installation and
8971         deinstallation time, and tells the package where to install
8972         GConf data files using some standard configure arguments.  It
8973         also disallows any access to the database directly from the
8974         package.</p></li>
8975 <li class="listitem"><p>Ensure that the package installs its
8976         <code class="filename">.schemas</code> files under
8977         <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
8978         installed under <code class="filename">${PREFIX}/etc</code>, you will
8979         need to manually patch the package.</p></li>
8980 <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
8981         directory, as they will be handled automatically.  See
8982         <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>
8983 <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
8984         your <code class="filename">Makefile</code> with a list of all
8985         <code class="filename">.schemas</code> files installed by the package, if
8986         any.  Names must not contain any directories in them.</p></li>
8987 <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
8988         your <code class="filename">Makefile</code> with a
8989         list of all <code class="filename">.entries</code> files installed by the
8990         package, if any. Names must not contain any directories in
8991         them.</p></li>
8992 </ol></div>
8993 </div>
8994 <div class="sect2" title="19.6.10. Packages installing scrollkeeper/rarian data files">
8995 <div class="titlepage"><div><div><h3 class="title">
8996 <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
8997 <p>If a package installs <code class="filename">.omf</code> files, used by
8998     scrollkeeper/rarian, you need to take some extra steps to make sure they
8999     get registered in the database:</p>
9000 <div class="orderedlist"><ol class="orderedlist" type="1">
9001 <li class="listitem"><p>Include
9002         <code class="filename">../../mk/omf-scrollkeeper.mk</code>
9003         instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
9004         takes care of rebuilding the scrollkeeper database at
9005         installation and deinstallation time, and disallows any access
9006         to it directly from the package.</p></li>
9007 <li class="listitem"><p>Check the PLIST and remove any entries under the
9008         <code class="filename">libdata/scrollkeeper</code> directory, as they
9009         will be handled automatically.</p></li>
9010 <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
9011         the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
9012         print-PLIST</strong></span> does this automatically.)</p></li>
9013 </ol></div>
9014 </div>
9015 <div class="sect2" title="19.6.11. Packages installing X11 fonts">
9016 <div class="titlepage"><div><div><h3 class="title">
9017 <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
9018 <p>If a package installs font files, you will need to rebuild
9019     the fonts database in the directory where they get installed at
9020     installation and deinstallation time.  This can be automatically
9021     done by using the pkginstall framework.</p>
9022 <p>You can list the directories where fonts are installed in the
9023     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
9024     variables, where <em class="replaceable"><code>type</code></em> can be one of
9025     <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>.
9026     Also make sure that the database file
9027     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
9028 <p>Note that you should not create new directories for fonts;
9029     instead use the standard ones to avoid that the user needs to
9030     manually configure his X server to find them.</p>
9031 </div>
9032 <div class="sect2" title="19.6.12. Packages installing GTK2 modules">
9033 <div class="titlepage"><div><div><h3 class="title">
9034 <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
9035 <p>If a package installs GTK2 immodules or loaders, you need to
9036     take some extra steps to get them registered in the GTK2 database
9037     properly:</p>
9038 <div class="orderedlist"><ol class="orderedlist" type="1">
9039 <li class="listitem"><p>Include
9040       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
9041       <code class="filename">buildlink3.mk</code> file.  This takes care of
9042       rebuilding the database at installation and deinstallation time.</p></li>
9043 <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
9044       your package installs GTK2 immodules.</p></li>
9045 <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
9046       GTK2 loaders.</p></li>
9047 <li class="listitem">
9048 <p>Patch the package to not touch any of the GTK2
9049       databases directly.  These are:</p>
9050 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9051 <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
9052 <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
9053 </ul></div>
9054 </li>
9055 <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
9056       any entries under the <code class="filename">libdata/gtk-2.0</code>
9057       directory, as they will be handled automatically.</p></li>
9058 </ol></div>
9059 </div>
9060 <div class="sect2" title="19.6.13. Packages installing SGML or XML data">
9061 <div class="titlepage"><div><div><h3 class="title">
9062 <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
9063 <p>If a package installs SGML or XML data files that need to be
9064     registered in system-wide catalogs (like DTDs, sub-catalogs,
9065     etc.), you need to take some extra steps:</p>
9066 <div class="orderedlist"><ol class="orderedlist" type="1">
9067 <li class="listitem"><p>Include
9068         <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
9069         your <code class="filename">Makefile</code>, which takes care of
9070         registering those files in system-wide catalogs at
9071         installation and deinstallation time.</p></li>
9072 <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
9073         any SGML catalogs installed by the package.</p></li>
9074 <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
9075         any XML catalogs installed by the package.</p></li>
9076 <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
9077         to be added to the SGML catalog.  These come in groups of
9078         three strings; see xmlcatmgr(1) for more information
9079         (specifically, arguments recognized by the 'add' action).
9080         Note that you will normally not use this variable.</p></li>
9081 <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
9082         to be added to the XML catalog.  These come in groups of three
9083         strings; see xmlcatmgr(1) for more information (specifically,
9084         arguments recognized by the 'add' action).  Note that you will
9085         normally not use this variable.</p></li>
9086 </ol></div>
9087 </div>
9088 <div class="sect2" title="19.6.14. Packages installing extensions to the MIME database">
9089 <div class="titlepage"><div><div><h3 class="title">
9090 <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
9091 <p>If a package provides extensions to the MIME database by
9092     installing <code class="filename">.xml</code> files inside
9093     <code class="filename">${PREFIX}/share/mime/packages</code>, you
9094     need to take some extra steps to ensure that the database is kept
9095     consistent with respect to these new files:</p>
9096 <div class="orderedlist"><ol class="orderedlist" type="1">
9097 <li class="listitem"><p>Include
9098         <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
9099         (avoid using the <code class="filename">buildlink3.mk</code> file from
9100         this same directory, which is reserved for inclusion from
9101         other <code class="filename">buildlink3.mk</code> files).  It takes
9102         care of rebuilding the MIME database at installation and
9103         deinstallation time, and disallows any access to it directly
9104         from the package.</p></li>
9105 <li class="listitem"><p>Check the PLIST and remove any entries under the
9106         <code class="filename">share/mime</code> directory,
9107         <span class="emphasis"><em>except</em></span> for files saved under
9108         <code class="filename">share/mime/packages</code>.  The former are
9109         handled automatically by
9110         the update-mime-database program, but the latter are
9111         package-dependent and must be removed by the package that
9112         installed them in the first place.</p></li>
9113 <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
9114         from the PLIST.  They will be handled by the shared-mime-info
9115         package.</p></li>
9116 </ol></div>
9117 </div>
9118 <div class="sect2" title="19.6.15. Packages using intltool">
9119 <div class="titlepage"><div><div><h3 class="title">
9120 <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
9121 <p>If a package uses intltool during its build, add
9122     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
9123     which forces it to use the intltool package provided by pkgsrc,
9124     instead of the one bundled with the distribution file.</p>
9125 <p>This tracks intltool's build-time dependencies and uses the
9126     latest available version; this way, the package benefits of any
9127     bug fixes that may have appeared since it was released.</p>
9128 </div>
9129 <div class="sect2" title="19.6.16. Packages installing startup scripts">
9130 <div class="titlepage"><div><div><h3 class="title">
9131 <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
9132 <p>If a package contains a rc.d script, it won't be copied into
9133     the startup directory by default, but you can enable it, by adding
9134     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
9135     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
9136     into <code class="filename">/etc/rc.d</code> when a package is installed, and
9137     it will automatically remove the scripts when the package is
9138     deinstalled.</p>
9139 </div>
9140 <div class="sect2" title="19.6.17. Packages installing TeX modules">
9141 <div class="titlepage"><div><div><h3 class="title">
9142 <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
9143 <p>If a package installs TeX packages into the texmf tree,
9144     the <code class="filename">ls-R</code> database of the tree needs to be
9145     updated.</p>
9146 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
9147 <h3 class="title">Note</h3>
9148 <p>Except the main TeX packages such as kpathsea,
9149     packages should install files
9150     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
9151     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
9152 </div>
9153 <div class="orderedlist"><ol class="orderedlist" type="1">
9154 <li class="listitem"><p>Include
9155       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
9156       takes care of rebuilding the <code class="filename">ls-R</code>
9157       database at installation and deinstallation time.</p></li>
9158 <li class="listitem">
9159 <p>If your package installs files into a texmf
9160       tree other than the one
9161       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
9162       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
9163       trees that need database update.</p>
9164 <p>If your package also installs font map files that need
9165       to be registered using <span class="command"><strong>updmap</strong></span>,
9166       include <code class="filename">../../print/texlive-tetex/map.mk</code> and
9167       set <code class="varname">TEX_MAP_FILES</code> and/or
9168       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
9169       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
9170       be run automatically at installation/deinstallation to
9171       enable/disable font map files for TeX output
9172       drivers.</p>
9173 </li>
9174 <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
9175       databases are included in <code class="filename">PLIST</code>, as
9176       they will be removed only by the teTeX-bin package.</p></li>
9177 </ol></div>
9178 </div>
9179 <div class="sect2" title="19.6.18. Packages supporting running binaries in emulation">
9180 <div class="titlepage"><div><div><h3 class="title">
9181 <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
9182     emulation</h3></div></div></div>
9183 <p>There are some packages that provide libraries and
9184     executables for running binaries from a one operating system
9185     on a different one (if the latter supports it).  One example
9186     is running Linux binaries on NetBSD.</p>
9187 <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>
9188     helps in extracting and packaging Linux rpm packages.</p>
9189 <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
9190     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
9191     if all libraries for each installed executable can be found by
9192     the dynamic linker.  Since the standard dynamic linker is run,
9193     this fails for emulation packages, because the libraries used
9194     by the emulation are not in the standard directories.</p>
9195 </div>
9196 <div class="sect2" title="19.6.19. Packages installing hicolor theme icons">
9197 <div class="titlepage"><div><div><h3 class="title">
9198 <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
9199 <p>If a package installs images under the
9200     <code class="filename">share/icons/hicolor</code> and/or updates the
9201     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
9202     database, you need to take some extra steps to make sure that the
9203     shared theme directory is handled appropriately and that the cache
9204     database is rebuilt:</p>
9205 <div class="orderedlist"><ol class="orderedlist" type="1">
9206 <li class="listitem"><p>Include
9207         <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
9208 <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
9209         entry that refers to the theme cache.</p></li>
9210 <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
9211           directories from the <code class="filename">share/icons/hicolor</code>
9212           hierarchy because they will be handled automatically.</p></li>
9213 </ol></div>
9214 <p>The best way to verify that the PLIST is correct with
9215       respect to the last two points is to regenerate it using
9216       <span class="command"><strong>make print-PLIST</strong></span>.</p>
9217 </div>
9218 <div class="sect2" title="19.6.20. Packages installing desktop files">
9219 <div class="titlepage"><div><div><h3 class="title">
9220 <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
9221 <p>If a package installs <code class="filename">.desktop</code> files
9222       under <code class="filename">share/applications</code> and these include
9223       MIME information, you need to take extra steps to ensure that they
9224       are registered into the MIME database:</p>
9225 <div class="orderedlist"><ol class="orderedlist" type="1">
9226 <li class="listitem"><p>Include
9227           <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
9228 <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
9229           <code class="filename">share/applications/mimeinfo.cache</code> file.
9230           It will be handled automatically.</p></li>
9231 </ol></div>
9232 <p>The best way to verify that the PLIST is correct with
9233       respect to the last point is to regenerate it using <span class="command"><strong>make
9234       print-PLIST</strong></span>.</p>
9235 </div>
9236 </div>
9237 <div class="sect1" title="19.7. Marking packages as having problems">
9238 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9239 <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
9240 <p>In some cases one does not have the time to solve a problem
9241   immediately. In this case, one can plainly mark a package as broken.  For
9242   this, one just sets the variable <code class="varname">BROKEN</code> to the
9243   reason why the package is broken (similar to the
9244   <code class="varname">RESTRICTED</code> variable).  A user trying to build
9245   the package will immediately be shown this message, and the build
9246   will not be even tried.</p>
9247 <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
9248   intervals.</p>
9249 </div>
9250 </div>
9251 <div class="chapter" title="Chapter 20. Debugging">
9252 <div class="titlepage"><div><div><h2 class="title">
9253 <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
9254 <p>To check out all the gotchas when building a package, here are
9255   the steps that I do in order to get a package working.  Please note
9256   this is basically the same as what was explained in the previous
9257   sections, only with some debugging aids.</p>
9258 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9259 <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>
9260 <li class="listitem">
9261 <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>,
9262       create a directory for a new package, change into it, then run
9263       <span class="command"><strong>url2pkg</strong></span>:</p>
9264 <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>
9265 <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>
9266 <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
9267 </li>
9268 <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
9269 <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
9270 <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
9271 <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
9272       configure step to the package's
9273       <code class="filename">Makefile</code>.</p></li>
9274 <li class="listitem">
9275 <p>Make the package compile, doing multiple rounds of</p>
9276 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
9277 <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
9278 <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
9279 <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
9280 <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
9281 <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
9282 <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
9283 <p>Doing this step as non-root user will ensure that no files
9284       are modified that shouldn't be, especially during the build
9285       phase.  <span class="command"><strong>mkpatches</strong></span>,
9286       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
9287       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>
9288       package.</p>
9289 </li>
9290 <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
9291       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>
9292 <li class="listitem">
9293 <p>Generate a <code class="filename">PLIST</code>:</p>
9294 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9295 <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
9296 <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
9297 <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
9298 <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
9299 <p>You usually need to be <code class="username">root</code> to do
9300       this.  Look if there are any files left:</p>
9301 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9302 <p>If this reveals any files that are missing in
9303       <code class="filename">PLIST</code>, add them.</p>
9304 </li>
9305 <li class="listitem">
9306 <p>Now that the <code class="filename">PLIST</code> is OK, install the
9307       package again and make a binary package:</p>
9308 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
9309 <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
9310 </li>
9311 <li class="listitem">
9312 <p>Delete the installed package:</p>
9313 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
9314 </li>
9315 <li class="listitem">
9316 <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
9317       command, which shouldn't find anything now:</p>
9318 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
9319 </li>
9320 <li class="listitem">
9321 <p>Reinstall the binary package:</p>
9322 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
9323 </li>
9324 <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
9325 <li class="listitem">
9326 <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
9327       reports:</p>
9328 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
9329 </li>
9330 <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>
9331 </ul></div>
9332 </div>
9333 <div class="chapter" title="Chapter 21. Submitting and Committing">
9334 <div class="titlepage"><div><div><h2 class="title">
9335 <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
9336 <div class="toc">
9337 <p><b>Table of Contents</b></p>
9338 <dl>
9339 <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
9340 <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
9341 <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
9342 <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Importing a package into CVS</a></span></dt>
9343 <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
9344 <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
9345 <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
9346 </dl>
9347 </div>
9348 <div class="sect1" title="21.1. Submitting binary packages">
9349 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9350 <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
9351 <p>Our policy is that we accept binaries only from pkgsrc
9352         developers to guarantee that the packages don't contain any
9353         trojan horses etc. This is not to annoy anyone but rather to
9354         protect our users! You're still free to put up your home-made
9355         binary packages and tell the world where to get them. NetBSD
9356         developers doing bulk builds and wanting to upload them please
9357         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>
9358 </div>
9359 <div class="sect1" title="21.2. Submitting source packages (for non-NetBSD-developers)">
9360 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9361 <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
9362 <p>First, check that your package is complete, compiles and
9363         runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
9364         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>
9365         archive that contains all files that make up the package.
9366         Finally, send this package to the pkgsrc bug tracking system,
9367         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
9368         that, go to the web page
9369         <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
9370         which contains some instructions and a link to a form where you
9371         can submit packages.  The
9372         <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
9373         also available as a substitute for either of the above two tools.
9374         </p>
9375 <p>In the form of the problem report, the category should be
9376         <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
9377         and version number, and the description field should contain a
9378         short description of your package (contents of the COMMENT
9379         variable or DESCR file are OK). The uuencoded package data should
9380         go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
9381 <p>If you want to submit several packages, please send a
9382         separate PR for each one, it's easier for us to track things
9383         that way.</p>
9384 <p>Alternatively, you can also import new packages into
9385         pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
9386         homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
9387         for details.</p>
9388 </div>
9389 <div class="sect1" title="21.3. General notes when adding, updating, or removing packages">
9390 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9391 <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
9392 <p>Please note all package additions, updates, moves, and
9393         removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
9394         important to keep this file up to date and conforming to the
9395         existing format, because it will be used by scripts to
9396         automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
9397         sites. Additionally, check the
9398         <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
9399         for the package you updated or removed, in case it was mentioned
9400         there.</p>
9401 <p>When the <code class="varname">PKGREVISION</code> of a package is
9402         bumped, the change should appear in
9403         <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
9404         related or otherwise relevant. Mass bumps that result from a
9405         dependency being updated should not be mentioned. In all other
9406         cases it's the developer's decision.</p>
9407 <p>There is a make target that helps in creating proper
9408   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
9409   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
9410   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
9411   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
9412   file is up-to-date (to avoid having to resolve conflicts later-on)
9413   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
9414   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
9415   For new packages, or package moves or removals, set the
9416   <code class="varname">CTYPE</code> variable on the command line to "Added",
9417   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
9418   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
9419   not the same as your NetBSD login name. The target also automatically
9420   removes possibly existing entries for the package in the
9421   <code class="filename">TODO</code> file. Don't forget to commit
9422   the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
9423   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
9424   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
9425   makes the cvs commands use the main repository.
9426   </p>
9427 </div>
9428 <div class="sect1" title="21.4. Committing: Importing a package into CVS">
9429 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9430 <a name="committing-importing"></a>21.4. Committing: Importing a package into CVS</h2></div></div></div>
9431 <p>This section is only of interest for pkgsrc developers with write
9432   access to the pkgsrc repository. Please remember that cvs
9433   imports files relative to the current working directory, and that
9434   the pathname that you
9435   give the <span class="command"><strong>cvs import</strong></span> command is so that it knows where
9436   to place the files in the repository.  Newly created packages should be
9437   imported with a vendor tag of <span class="quote">&#8220;<span class="quote">TNF</span>&#8221;</span> and a release tag of
9438   <span class="quote">&#8220;<span class="quote">pkgsrc-base</span>&#8221;</span>, e.g:</p>
9439 <pre class="programlisting">
9440 <code class="prompt">$</code> cd .../pkgsrc/category/pkgname
9441 <code class="prompt">$</code> cvs import pkgsrc/category/pkgname TNF pkgsrc-base
9442 </pre>
9443 <p>Remember to move the directory from which you imported out of
9444   the way, or cvs will complain the next time you <span class="quote">&#8220;<span class="quote">cvs
9445   update</span>&#8221;</span> your source tree.  Also don't forget to add the new
9446   package to the category's <code class="filename">Makefile</code>.</p>
9447 <p>The commit message of the initial import should include part of the
9448   <code class="filename">DESCR</code> file, so people reading the mailing lists know
9449   what the package is/does.</p>
9450 <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
9451   add</span>&#8221;</span> because the former gets everything with a single command,
9452   and provides a consistent tag.</p>
9453 </div>
9454 <div class="sect1" title="21.5. Updating a package to a newer version">
9455 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9456 <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
9457 <p>Please always put a concise, appropriate and relevant summary of the
9458   changes between old and new versions into the commit log when updating
9459   a package. There are various reasons for this:</p>
9460 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9461 <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
9462   or its information may be overwritten by newer information.</p></li>
9463 <li class="listitem"><p>Having the change information between old and new versions in our CVS
9464   repository is very useful for people who use either cvs or anoncvs.</p></li>
9465 <li class="listitem"><p>Having the change information between old and new versions in our CVS
9466   repository is very useful for people who read the pkgsrc-changes mailing
9467   list, so that they can make tactical decisions about when to upgrade
9468   the package.</p></li>
9469 </ul></div>
9470 <p>Please also recognize that, just because a new version of a package
9471   has been released, it should not automatically be upgraded in the CVS
9472   repository.  We prefer to be conservative in the packages that are
9473   included in pkgsrc - development or beta packages are not really the
9474   best thing for most places in which pkgsrc is used. Please use your
9475   judgement about what should go into pkgsrc, and bear in mind that
9476   stability is to be preferred above new and possibly untested features.</p>
9477 </div>
9478 <div class="sect1" title="21.6. Renaming a package in pkgsrc">
9479 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9480 <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
9481 <p>Renaming packages is not recommended.</p>
9482 <p>When renaming packages, be sure to fix any references to old name
9483   in other Makefiles, options, buildlink files, etc.</p>
9484 <p>Also When renaming a package, please define
9485   <code class="varname">SUPERSEDES</code> to the package name and dewey version
9486   pattern(s) of the previous package name.
9487   This may be repeated for multiple renames.
9488   The new package would be an exact replacement.
9489 </p>
9490 <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
9491   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
9492   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
9493   not be an exact replacement but is a suggestion for the replaced
9494   functionality.</p>
9495 </div>
9496 <div class="sect1" title="21.7. Moving a package in pkgsrc">
9497 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9498 <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
9499 <p>It is preferred that packages are not renamed or moved, but if needed
9500   please follow these steps.
9501 </p>
9502 <div class="orderedlist"><ol class="orderedlist" type="1">
9503 <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
9504 <li class="listitem">
9505 <p>Remove all CVS dirs.</p>
9506 <p>Alternatively to the first two steps you can also do:</p>
9507 <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>
9508 <p>and use that for further work.</p>
9509 </li>
9510 <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
9511 <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
9512 instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
9513 <li class="listitem"><p>In the modified package's Makefile, consider setting
9514 <code class="varname">PREV_PKGPATH</code> to the previous category/package
9515 pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
9516 for doing an update using pkgsrc building; for example, it can
9517 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>
9518 (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
9519 new <code class="varname">PKGPATH</code> for that moved package.  Note that
9520 it may have multiple matches, so the tool should also check on the
9521 <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
9522 probably has no value unless <code class="varname">SUPERSEDES</code> is not
9523 set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
9524 <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
9525 place.</p></li>
9526 <li class="listitem">
9527 <p>Check if any package depends on it:
9528 </p>
9529 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
9530 <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
9531 </li>
9532 <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
9533 <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
9534 <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
9535 <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
9536 <li class="listitem">
9537 <p>Commit the changed and removed files:</p>
9538 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
9539 <p>(and any packages from step 5, of course).</p>
9540 </li>
9541 </ol></div>
9542 </div>
9543 </div>
9544 <div class="chapter" title="Chapter 22. Frequently Asked Questions">
9545 <div class="titlepage"><div><div><h2 class="title">
9546 <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
9547 <p>This section contains the answers to questions that may
9548         arise when you are writing a package. If you don't find your
9549         question answered here, first have a look in the other chapters,
9550         and if you still don't have the answer, ask on the
9551         <code class="literal">pkgsrc-users</code> mailing list.</p>
9552 <div class="qandaset" title="Frequently Asked Questions">
9553 <a name="id1168229338136"></a><dl>
9554 <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
9555         MAKEFLAGS, .MAKEFLAGS and
9556         MAKE_FLAGS?</a>
9557 </dt>
9558 <dt>22.2. <a href="#devfaq.make">What is the difference between
9559         MAKE, GMAKE and
9560         MAKE_PROGRAM?</a>
9561 </dt>
9562 <dt>22.3. <a href="#devfaq.cc">What is the difference between
9563         CC, PKG_CC and
9564         PKGSRC_COMPILER?</a>
9565 </dt>
9566 <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
9567         BUILDLINK_LDFLAGS,
9568         BUILDLINK_LDADD and
9569         BUILDLINK_LIBS?</a>
9570 </dt>
9571 <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
9572         VARNAME=BUILDLINK_PREFIX.foo
9573         say it's empty?</a>
9574 </dt>
9575 <dt>22.6. <a href="#devfaq.master_sites">What does
9576         ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
9577         don't understand the := inside
9578         it.</a>
9579 </dt>
9580 <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
9581         developers?</a>
9582 </dt>
9583 <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
9584         documentation?</a>
9585 </dt>
9586 <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
9587 do?</a>
9588 </dt>
9589 </dl>
9590 <table border="0" width="100%" summary="Q and A Set">
9591 <col align="left" width="1%">
9592 <col>
9593 <tbody>
9594 <tr class="question" title="22.1.">
9595 <td align="left" valign="top">
9596 <a name="devfaq.makeflags"></a><a name="id1168229338139"></a><p><b>22.1.</b></p>
9597 </td>
9598 <td align="left" valign="top"><p>What is the difference between
9599         <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
9600         <code class="varname">MAKE_FLAGS</code>?</p></td>
9601 </tr>
9602 <tr class="answer">
9603 <td align="left" valign="top"></td>
9604 <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
9605         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
9606         <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
9607         the <code class="varname">MAKE_PROGRAM</code> when building the
9608         package. [FIXME: What is .MAKEFLAGS for?]</p></td>
9609 </tr>
9610 <tr class="question" title="22.2.">
9611 <td align="left" valign="top">
9612 <a name="devfaq.make"></a><a name="id1168229338172"></a><p><b>22.2.</b></p>
9613 </td>
9614 <td align="left" valign="top"><p>What is the difference between
9615         <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
9616         <code class="varname">MAKE_PROGRAM</code>?</p></td>
9617 </tr>
9618 <tr class="answer">
9619 <td align="left" valign="top"></td>
9620 <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
9621         <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
9622         infrastructure. <code class="varname">GMAKE</code> is the path to GNU
9623         Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
9624         use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
9625         Make program that is used for building the
9626         package.</p></td>
9627 </tr>
9628 <tr class="question" title="22.3.">
9629 <td align="left" valign="top">
9630 <a name="devfaq.cc"></a><a name="id1168229338210"></a><p><b>22.3.</b></p>
9631 </td>
9632 <td align="left" valign="top"><p>What is the difference between
9633         <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
9634         <code class="varname">PKGSRC_COMPILER</code>?</p></td>
9635 </tr>
9636 <tr class="answer">
9637 <td align="left" valign="top"></td>
9638 <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
9639         compiler, which can be configured by the pkgsrc user.
9640         <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
9641         <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
9642         path to a compiler, but the type of compiler that should be
9643         used. See <code class="filename">mk/compiler.mk</code> for more
9644         information about the latter variable.</p></td>
9645 </tr>
9646 <tr class="question" title="22.4.">
9647 <td align="left" valign="top">
9648 <a name="devfaq.bl3flags"></a><a name="id1168229338244"></a><p><b>22.4.</b></p>
9649 </td>
9650 <td align="left" valign="top"><p>What is the difference between
9651         <code class="varname">BUILDLINK_LDFLAGS</code>,
9652         <code class="varname">BUILDLINK_LDADD</code> and
9653         <code class="varname">BUILDLINK_LIBS</code>?</p></td>
9654 </tr>
9655 <tr class="answer">
9656 <td align="left" valign="top"></td>
9657 <td align="left" valign="top"><p>[FIXME]</p></td>
9658 </tr>
9659 <tr class="question" title="22.5.">
9660 <td align="left" valign="top">
9661 <a name="devfaq.bl3prefix"></a><a name="id1168229338263"></a><p><b>22.5.</b></p>
9662 </td>
9663 <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
9664         VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
9665         say it's empty?</p></td>
9666 </tr>
9667 <tr class="answer">
9668 <td align="left" valign="top"></td>
9669 <td align="left" valign="top"><p>For optimization reasons, some variables are only
9670         available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
9671         <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
9672         <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
9673         command.</p></td>
9674 </tr>
9675 <tr class="question" title="22.6.">
9676 <td align="left" valign="top">
9677 <a name="devfaq.master_sites"></a><a name="id1168229338289"></a><p><b>22.6.</b></p>
9678 </td>
9679 <td align="left" valign="top"><p>What does
9680         <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
9681         don't understand the <code class="literal">:=</code> inside
9682         it.</p></td>
9683 </tr>
9684 <tr class="answer">
9685 <td align="left" valign="top"></td>
9686 <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
9687         assignment operator, like you might expect at first sight.
9688         Instead, it is a degenerate form of
9689         <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
9690         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
9691         may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
9692         case of <code class="varname">MASTER_SITE_*</code>,
9693         <em class="replaceable"><code>old_string</code></em> is the empty string and
9694         <em class="replaceable"><code>new_string</code></em> is
9695         <code class="literal">package/</code>. That's where the
9696         <code class="literal">:</code> and the <code class="literal">=</code> fall
9697         together.</p></td>
9698 </tr>
9699 <tr class="question" title="22.7.">
9700 <td align="left" valign="top">
9701 <a name="devfaq.mailinglists"></a><a name="id1168229338390"></a><p><b>22.7.</b></p>
9702 </td>
9703 <td align="left" valign="top"><p>Which mailing lists are there for package
9704         developers?</p></td>
9705 </tr>
9706 <tr class="answer">
9707 <td align="left" valign="top"></td>
9708 <td align="left" valign="top"><div class="variablelist"><dl>
9709 <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
9710 <dd><p>This is a list for technical discussions related
9711         to pkgsrc development, e.g. soliciting feedback for changes to
9712         pkgsrc infrastructure, proposed new features, questions related
9713         to porting pkgsrc to a new platform, advice for maintaining a
9714         package, patches that affect many packages, help requests moved
9715         from pkgsrc-users when an infrastructure bug is found,
9716         etc.</p></dd>
9717 <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
9718 <dd><p>All bug reports in category "pkg" sent with
9719         <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
9720         directly; use one of the other mailing
9721         lists.</p></dd>
9722 </dl></div></td>
9723 </tr>
9724 <tr class="question" title="22.8.">
9725 <td align="left" valign="top">
9726 <a name="devfaq.documentation"></a><a name="id1168229338422"></a><p><b>22.8.</b></p>
9727 </td>
9728 <td align="left" valign="top"><p>Where is the pkgsrc
9729         documentation?</p></td>
9730 </tr>
9731 <tr class="answer">
9732 <td align="left" valign="top"></td>
9733 <td align="left" valign="top">
9734 <p>There are many places where you can find
9735         documentation about pkgsrc:</p>
9736 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9737 <li class="listitem"><p>The pkgsrc guide (this document) is a collection
9738         of chapters that explain large parts of pkgsrc, but some
9739         chapters tend to be outdated. Which ones they are is hard to
9740         say.</p></li>
9741 <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
9742         about certain features, announcements of new parts of the pkgsrc
9743         infrastructure and sometimes even announcements that a certain
9744         feature has been marked as obsolete. The benefit here is that
9745         each message has a date appended to it.</p></li>
9746 <li class="listitem"><p>Many of the files in the
9747         <code class="filename">mk/</code> directory start with a comment that
9748         describes the purpose of the file and how it can be used by the
9749         pkgsrc user and package authors. An easy way to find this
9750         documentation is to run <span class="command"><strong>bmake
9751         help</strong></span>.</p></li>
9752 <li class="listitem"><p>The CVS log messages are a rich source of
9753         information, but they tend to be highly abbreviated, especially
9754         for actions that occur often. Some contain a detailed
9755         description of what has changed, but they are geared towards the
9756         other pkgsrc developers, not towards an average pkgsrc user.
9757         They also only document <span class="emphasis"><em>changes</em></span>, so if you
9758         don't know what has been before, these messages may not be worth
9759         too much to you.</p></li>
9760 <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
9761         documented</span>&#8221;</span>, that is the documentation exists only in the
9762         mind of the developer who wrote the code. To get this
9763         information, use the <span class="command"><strong>cvs annotate</strong></span> command
9764         to see who has written it and ask on the
9765         <code class="literal">tech-pkg</code> mailing list, so that others can
9766         find your questions later (see above). To be sure that the
9767         developer in charge reads the mail, you may CC him or
9768         her.</p></li>
9769 </ul></div>
9770 </td>
9771 </tr>
9772 <tr class="question" title="22.9.">
9773 <td align="left" valign="top">
9774 <a name="devfaq.too-much-time"></a><a name="id1168229338475"></a><p><b>22.9.</b></p>
9775 </td>
9776 <td align="left" valign="top"><p>I have a little time to kill.  What shall I
9777 do?</p></td>
9778 </tr>
9779 <tr class="answer">
9780 <td align="left" valign="top"></td>
9781 <td align="left" valign="top">
9782 <p>This is not really an FAQ yet, but here's the answer
9783 anyway.</p>
9784 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9785 <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
9786     <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
9787     will tell you about newer versions of installed packages that are
9788     available, but not yet updated in pkgsrc.</p></li>
9789 <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
9790     &mdash; it contains a list of suggested new packages and a list of
9791     cleanups and enhancements for pkgsrc that would be nice to
9792     have.</p></li>
9793 <li class="listitem"><p>Review packages for which review was requested on
9794     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
9795     mailing list.</p></li>
9796 </ul></div>
9797 </td>
9798 </tr>
9799 </tbody>
9800 </table>
9801 </div>
9802 </div>
9803 <div class="chapter" title="Chapter 23. GNOME packaging and porting">
9804 <div class="titlepage"><div><div><h2 class="title">
9805 <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
9806 <div class="toc">
9807 <p><b>Table of Contents</b></p>
9808 <dl>
9809 <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
9810 <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
9811 <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
9812 <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
9813 </dl>
9814 </div>
9815 <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
9816 site</a>:</p>
9817 <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
9818   environment, an intuitive and attractive desktop for users, and the
9819   GNOME development platform, an extensive framework for building
9820   applications that integrate into the rest of the desktop.</p></blockquote></div>
9821 <p>pkgsrc provides a seamless way to automatically build and install
9822 a complete GNOME environment <span class="emphasis"><em>under many different
9823 platforms</em></span>.  We can say with confidence that pkgsrc is one of
9824 the most advanced build and packaging systems for GNOME due to its
9825 included technologies buildlink3, the wrappers and tools framework and
9826 automatic configuration file management.  Lots of efforts are put into
9827 achieving a completely clean deinstallation of installed software
9828 components.</p>
9829 <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
9830 the above also means that great efforts are put into making GNOME work
9831 under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
9832 pkgsrc as its preferred packaging system, contributing lots of
9833 portability fixes to make GNOME build and install under it.</p>
9834 <p>This chapter is aimed at pkgsrc developers and other people
9835 interested in helping our GNOME porting and packaging efforts.  It
9836 provides instructions on how to manage the existing packages and some
9837 important information regarding their internals.</p>
9838 <div class="note" title="We need your help!" style="margin-left: 0.5in; margin-right: 0.5in;">
9839 <h3 class="title">We need your help!</h3>
9840 <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
9841   and GNOME and are willing to learn new exciting stuff, please jump
9842   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
9843   work</a> list!  There is still a long way to go to get a
9844   fully-functional GNOME desktop under NetBSD and we need your help to
9845   achieve it!</p>
9846 </div>
9847 <div class="sect1" title="23.1. Meta packages">
9848 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9849 <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
9850 <p>pkgsrc includes three GNOME-related meta packages:</p>
9851 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9852 <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
9853     the core GNOME desktop environment.  It only includes the necessary
9854     bits to get it to boot correctly, although it may lack important
9855     functionality for daily operation.  The idea behind this package is
9856     to let end users build their own configurations on top of this one,
9857     first installing this meta package to achieve a functional setup and
9858     then adding individual applications.</p></li>
9859 <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
9860     complete installation of the GNOME platform and desktop as defined
9861     by the GNOME project; this is based on the components distributed in
9862     the <code class="filename">platform/x.y/x.y.z/sources</code> and
9863     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
9864     official FTP server.  Developer-only tools found in those
9865     directories are not installed unless required by some other
9866     component to work properly.  Similarly, packages from the bindings
9867     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
9868     in unless required as a dependency for an end-user component.  This
9869     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>
9870 <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>:
9871     Installs all the tools required to build a GNOME component when
9872     fetched from the CVS repository.  These are required to let the
9873     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
9874 </ul></div>
9875 <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
9876 sorted in a way that eases updates: a package may depend on other
9877 packages listed before it but not on any listed after it.  It is very
9878 important to keep this order to ease updates so... <span class="emphasis"><em>do not
9879 change it to alphabetical sorting!</em></span></p>
9880 </div>
9881 <div class="sect1" title="23.2. Packaging a GNOME application">
9882 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9883 <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
9884 <p>Almost all GNOME applications are written in C and use a common
9885 set of tools as their build system.  Things get different with the new
9886 bindings to other languages (such as Python), but the following will
9887 give you a general idea on the minimum required tools:</p>
9888 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
9889 <li class="listitem">
9890 <p>Almost all GNOME applications use the GNU Autotools as their
9891     build system.  As a general rule you will need to tell this to your
9892     package:</p>
9893 <pre class="programlisting">
9894 GNU_CONFIGURE=yes
9895 USE_LIBTOOL=yes
9896 USE_TOOLS+=gmake
9897 </pre>
9898 </li>
9899 <li class="listitem">
9900 <p>If the package uses pkg-config to detect dependencies, add this
9901     tool to the list of required utilities:</p>
9902 <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
9903 <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
9904     the end of the build process to ensure that you did not miss to
9905     specify any dependency in your package and that the version
9906     requirements are all correct.</p>
9907 </li>
9908 <li class="listitem"><p>If the package uses intltool, be sure to add
9909     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
9910     to handle dependencies and to force the package to use the latest
9911     available version.</p></li>
9912 <li class="listitem">
9913 <p>If the package uses gtk-doc (a documentation generation
9914     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
9915     tool is rather big and the distfile should come with pregenerated
9916     documentation anyway; if it does not, it is a bug that you ought to
9917     report.  For such packages you should disable gtk-doc (unless it is
9918     the default):</p>
9919 <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
9920 <p>The default location of installed HTML files
9921     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
9922     and should not be changed unless the package insists on installing
9923     them somewhere else.  Otherwise programs as
9924     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
9925     do that with an entry similar to:</p>
9926 <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
9927 </li>
9928 </ul></div>
9929 <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
9930 files under the installation prefix to maintain databases.  In this
9931 context, shared means that those exact same directories and files are
9932 used among several different packages, leading to conflicts in the
9933 <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
9934 handle the most common cases, so you have to forget about using
9935 <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
9936 omitting shared files from them.  If you find yourself doing those,
9937 <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
9938 <p>The following table lists the common situations that result in
9939 using shared directories or files.  For each of them, the appropriate
9940 solution is given.  After applying the solution be sure to
9941 <span class="emphasis"><em>regenerate the package's file list</em></span> with
9942 <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
9943 <div class="table">
9944 <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
9945 <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
9946 <colgroup>
9947 <col>
9948 <col>
9949 </colgroup>
9950 <thead><tr>
9951 <th>If the package...</th>
9952 <th>Then...</th>
9953 </tr></thead>
9954 <tbody>
9955 <tr>
9956 <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
9957 <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>
9958 </tr>
9959 <tr>
9960 <td>Installs icons under the
9961         <code class="filename">share/icons/hicolor</code> hierarchy or updates
9962         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
9963 <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>
9964 </tr>
9965 <tr>
9966 <td>Installs files under
9967         <code class="filename">share/mime/packages</code>.</td>
9968 <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>
9969 </tr>
9970 <tr>
9971 <td>Installs <code class="filename">.desktop</code> files under
9972         <code class="filename">share/applications</code> and these include MIME
9973         information.</td>
9974 <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>
9975 </tr>
9976 </tbody>
9977 </table></div>
9978 </div>
9979 <br class="table-break">
9980 </div>
9981 <div class="sect1" title="23.3. Updating GNOME to a newer version">
9982 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
9983 <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
9984 <p>When seeing GNOME as a whole, there are two kinds of
9985 updates:</p>
9986 <div class="variablelist"><dl>
9987 <dt><span class="term">Major update</span></dt>
9988 <dd>
9989 <p>Given that there is still a very long way for GNOME 3 (if it
9990       ever appears), we consider a major update one that goes from a
9991       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
9992       where <code class="literal">Y</code> is even and greater than
9993       <code class="literal">X</code>.  These are hard to achieve because they
9994       introduce lots of changes in the components' code and almost all
9995       GNOME distfiles are updated to newer versions.  Some of them can
9996       even break API and ABI compatibility with the previous major
9997       version series.  As a result, the update needs to be done all at
9998       once to minimize breakage.</p>
9999 <p>A major update typically consists of around 80 package
10000       updates and the addition of some new ones.</p>
10001 </dd>
10002 <dt><span class="term">Minor update</span></dt>
10003 <dd>
10004 <p>We consider a minor update one that goes from a
10005       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
10006       one where <code class="literal">Y</code> is greater than
10007       <code class="literal">X</code>.  These are easy to achieve because they do
10008       not update all GNOME components, can be done in an incremental way
10009       and do not break API nor ABI compatibility.</p>
10010 <p>A minor update typically consists of around 50 package
10011       updates, although the numbers here may vary a lot.</p>
10012 </dd>
10013 </dl></div>
10014 <p>In order to update the GNOME components in pkgsrc to a new stable
10015 release (either major or minor), the following steps should be
10016 followed:</p>
10017 <div class="orderedlist"><ol class="orderedlist" type="1">
10018 <li class="listitem">
10019 <p>Get a list of all the tarballs that form the new release by
10020     using the following commands.  These will leave the full list of the
10021     components' distfiles into the <code class="filename">list.txt</code>
10022     file:</p>
10023 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10024     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
10025     awk '{ print $9 }' &gt;list.txt</code></strong>
10026 <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
10027     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
10028     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
10029 </li>
10030 <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
10031     bump their version to the release you are updating them to.  The
10032     three meta packages should be always consistent with versioning.
10033     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
10034     in them.</p></li>
10035 <li class="listitem">
10036 <p>For each meta package, update all its
10037     <code class="varname">DEPENDS</code> lines to match the latest versions as
10038     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
10039     newer version (even if found in the FTP) because the meta packages
10040     are supposed to list the exact versions that form a specific GNOME
10041     release.  Exceptions are permitted here if a newer version solves a
10042     serious issue in the overall desktop experience; these typically
10043     come in the form of a revision bump in pkgsrc, not in newer versions
10044     from the developers.</p>
10045 <p>Packages not listed in the <code class="filename">list.txt</code> file
10046     should be updated to the latest version available (if found in
10047     pkgsrc).  This is the case, for example, of the dependencies on the
10048     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>
10049 </li>
10050 <li class="listitem">
10051 <p>Generate a patch from the modified meta packages and extract the
10052     list of "new" lines.  This will provide you an outline on what
10053     packages need to be updated in pkgsrc and in what order:</p>
10054 <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>
10055 </li>
10056 <li class="listitem"><p>For major desktop updates it is recommended to zap all your
10057     installed packages and start over from scratch at this point.</p></li>
10058 <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
10059     of <code class="filename">todo.txt</code> and update the packages listed in
10060     it in order.  For major desktop updates none of these should be
10061     committed until the entire set is completed because there are chances
10062     of breaking not-yet-updated packages.</p></li>
10063 <li class="listitem"><p>Once the packages are up to date and working, commit them to
10064     the tree one by one with appropriate log messages.  At the end,
10065     commit the three meta package updates and all the corresponding
10066     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
10067     <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>
10068 </ol></div>
10069 </div>
10070 <div class="sect1" title="23.4. Patching guidelines">
10071 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10072 <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
10073 <p>GNOME is a very big component in pkgsrc which approaches 100
10074 packages.  Please, it is very important that you always, always,
10075 <span class="strong"><strong>always</strong></span> feed back any portability
10076 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
10077 their attention on portability issues and to ensure that future versions
10078 can be built out-of-the box on NetBSD.  The less custom patches in
10079 pkgsrc, the easier further updates are.  Those developers in charge of
10080 issuing major GNOME updates will be grateful if you do that.</p>
10081 <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
10082 Bugzilla</a>.  Not all components use these to track bugs, but most
10083 of them do.  Do not be short on your reports: always provide detailed
10084 explanations of the current failure, how it can be improved to achieve
10085 maximum portability and, if at all possible, provide a patch against CVS
10086 head.  The more verbose you are, the higher chances of your patch being
10087 accepted.</p>
10088 <p>Also, please avoid using preprocessor magic to fix portability
10089 issues.  While the FreeBSD GNOME people are doing a great job in porting
10090 GNOME to their operating system, the official GNOME sources are now
10091 plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
10092 and similar macros.  This hurts portability.  Please see our patching
10093 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
10094 details.</p>
10095 </div>
10096 </div>
10097 </div>
10098 <div class="part" title="Part III. The pkgsrc infrastructure internals">
10099 <div class="titlepage"><div><div><h1 class="title">
10100 <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
10101 <div class="partintro" title="The pkgsrc infrastructure internals">
10102 <div></div>
10103 <p>This part of the guide deals with everything
10104         from the infrastructure that is behind the interfaces described
10105         in the developer's guide. A casual package maintainer should not
10106         need anything from this part.</p>
10107 <div class="toc">
10108 <p><b>Table of Contents</b></p>
10109 <dl>
10110 <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
10111 <dd><dl>
10112 <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10113 <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10114 <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
10115 <dd><dl>
10116 <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10117 <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
10118 </dl></dd>
10119 <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10120 <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
10121 <dd><dl>
10122 <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10123 <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
10124 </dl></dd>
10125 <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
10126 <dd><dl>
10127 <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>
10128 <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>
10129 </dl></dd>
10130 </dl></dd>
10131 <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
10132 <dd><dl>
10133 <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10134 <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10135 <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
10136 <dd><dl>
10137 <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10138 <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
10139 </dl></dd>
10140 </dl></dd>
10141 <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
10142 <dd><dl>
10143 <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10144 <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
10145 </dl></dd>
10146 </dl>
10147 </div>
10148 </div>
10149 <div class="chapter" title="Chapter 24. Design of the pkgsrc infrastructure">
10150 <div class="titlepage"><div><div><h2 class="title">
10151 <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
10152 <div class="toc">
10153 <p><b>Table of Contents</b></p>
10154 <dl>
10155 <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
10156 <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
10157 <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
10158 <dd><dl>
10159 <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
10160 <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
10161 </dl></dd>
10162 <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
10163 <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
10164 <dd><dl>
10165 <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
10166 <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
10167 </dl></dd>
10168 <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
10169 <dd><dl>
10170 <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>
10171 <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>
10172 </dl></dd>
10173 </dl>
10174 </div>
10175 <p>The pkgsrc infrastructure consists of many small Makefile
10176         fragments. Each such fragment needs a properly specified
10177         interface. This chapter explains how such an interface looks
10178         like.</p>
10179 <div class="sect1" title="24.1. The meaning of variable definitions">
10180 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10181 <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
10182 <p>Whenever a variable is defined in the pkgsrc
10183         infrastructure, the location and the way of definition provide
10184         much information about the intended use of that variable.
10185         Additionally, more documentation may be found in a header
10186         comment or in this pkgsrc guide.</p>
10187 <p>A special file is
10188         <code class="filename">mk/defaults/mk.conf</code>, which lists all
10189         variables that are intended to be user-defined. They are either
10190         defined using the <code class="literal">?=</code> operator or they are
10191         left undefined because defining them to anything would
10192         effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
10193         overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
10194         file.</p>
10195 <p>Outside this file, the following conventions apply:
10196         Variables that are defined using the <code class="literal">?=</code>
10197         operator may be overridden by a package.</p>
10198 <p>Variables that are defined using the <code class="literal">=</code>
10199         operator may be used read-only at run-time.</p>
10200 <p>Variables whose name starts with an underscore must not be
10201         accessed outside the pkgsrc infrastructure at all. They may
10202         change without further notice.</p>
10203 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
10204 <h3 class="title">Note</h3>
10205 <p>These conventions are currently not applied
10206         consistently to the complete pkgsrc
10207         infrastructure.</p>
10208 </div>
10209 </div>
10210 <div class="sect1" title="24.2. Avoiding problems before they arise">
10211 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10212 <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
10213 <p>All variables that contain lists of things should default
10214         to being empty. Two examples that do not follow this rule are
10215         <code class="varname">USE_LANGUAGES</code> and
10216         <code class="varname">DISTFILES</code>. These variables cannot simply be
10217         modified using the <code class="literal">+=</code> operator in package
10218         <code class="filename">Makefile</code>s (or other files included by
10219         them), since there is no guarantee whether the variable is
10220         already set or not, and what its value is. In the case of
10221         <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
10222         the default value and just define it as in the following
10223         example.</p>
10224 <pre class="programlisting">
10225 DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
10226 </pre>
10227 <p>Because of the selection of this default value, the same
10228         value appears in many package Makefiles. Similarly for
10229         <code class="varname">USE_LANGUAGES</code>, but in this case the default
10230         value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
10231         doesn't stand out. Nevertheless it is mentioned in many
10232         files.</p>
10233 </div>
10234 <div class="sect1" title="24.3. Variable evaluation">
10235 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10236 <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
10237 <div class="sect2" title="24.3.1. At load time">
10238 <div class="titlepage"><div><div><h3 class="title">
10239 <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
10240 <p>Variable evaluation takes place either at load time or at
10241         runtime, depending on the context in which they occur. The
10242         contexts where variables are evaluated at load time are:</p>
10243 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
10244 <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
10245         and <code class="literal">!=</code> operators,</p></li>
10246 <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
10247         <code class="literal">.for</code>,</p></li>
10248 <li class="listitem"><p>Dependency lines.</p></li>
10249 </ul></div>
10250 <p>A special exception are references to the iteration
10251         variables of <code class="literal">.for</code> loops, which are expanded
10252         inline, no matter in which context they appear.</p>
10253 <p>As the values of variables may change during load time,
10254         care must be taken not to evaluate them by accident. Typical
10255         examples for variables that should not be evaluated at load time
10256         are <code class="varname">DEPENDS</code> and
10257         <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
10258         clear, here is an example:</p>
10259 <pre class="programlisting">
10260 CONFIGURE_ARGS=         # none
10261 CFLAGS=                 -O
10262 CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
10263
10264 CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
10265
10266 CFLAGS+=                -Wall
10267         </pre>
10268 <p>This code shows how the use of the <code class="literal">:=</code>
10269         operator can quickly lead to unexpected results. The first
10270         paragraph is fairly common code. The second paragraph evaluates
10271         the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
10272         <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
10273         <code class="literal">-Wall</code> is appended to the
10274         <code class="varname">CFLAGS</code>, but this addition will not appear in
10275         <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
10276         paragraphs from above typically occur in completely unrelated
10277         files.</p>
10278 </div>
10279 <div class="sect2" title="24.3.2. At runtime">
10280 <div class="titlepage"><div><div><h3 class="title">
10281 <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
10282 <p>After all the files have been loaded, the values of the
10283         variables cannot be changed anymore. Variables that are used in
10284         the shell commands are expanded at this point.</p>
10285 </div>
10286 </div>
10287 <div class="sect1" title="24.4. How can variables be specified?">
10288 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10289 <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
10290 <p>There are many ways in which the definition and use of a
10291         variable can be restricted in order to detect bugs and
10292         violations of the (mostly unwritten) policies. See the
10293         <code class="literal">pkglint</code> developer's documentation for further
10294         details.</p>
10295 </div>
10296 <div class="sect1" title="24.5. Designing interfaces for Makefile fragments">
10297 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10298 <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
10299 <p>Most of the <code class="filename">.mk</code> files fall into one
10300         of the following classes. Cases where a file falls into more
10301         than one class should be avoided as it often leads to subtle
10302         bugs.</p>
10303 <div class="sect2" title="24.5.1. Procedures with parameters">
10304 <div class="titlepage"><div><div><h3 class="title">
10305 <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
10306 <p>In a traditional imperative programming language some of
10307         the <code class="filename">.mk</code> files could be described as
10308         procedures. They take some input parameters and&mdash;after
10309         inclusion&mdash;provide a result in output parameters. Since all
10310         variables in <code class="filename">Makefile</code>s have global scope
10311         care must be taken not to use parameter names that have already
10312         another meaning. For example, <code class="varname">PKGNAME</code> is a
10313         bad choice for a parameter name.</p>
10314 <p>Procedures are completely evaluated at preprocessing time.
10315         That is, when calling a procedure all input parameters must be
10316         completely resolvable. For example,
10317         <code class="varname">CONFIGURE_ARGS</code> should never be an input
10318         parameter since it is very likely that further text will be
10319         added after calling the procedure, which would effectively apply
10320         the procedure to only a part of the variable. Also, references
10321         to other variables wit will be modified after calling the
10322         procedure.</p>
10323 <p>A procedure can declare its output parameters either as
10324         suitable for use in preprocessing directives or as only
10325         available at runtime. The latter alternative is for variables
10326         that contain references to other runtime variables.</p>
10327 <p>Procedures shall be written such that it is possible to
10328         call the procedure more than once. That is, the file must not
10329         contain multiple-inclusion guards.</p>
10330 <p>Examples for procedures are
10331         <code class="filename">mk/bsd.options.mk</code> and
10332         <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
10333         that the parameters are evaluated at load time, they should be
10334         assigned using the <code class="literal">:=</code> operator, which should
10335         be used only for this purpose.</p>
10336 </div>
10337 <div class="sect2" title="24.5.2. Actions taken on behalf of parameters">
10338 <div class="titlepage"><div><div><h3 class="title">
10339 <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
10340 <p>Action files take some input parameters and may define
10341         runtime variables. They shall not define loadtime variables.
10342         There are action files that are included implicitly by the
10343         pkgsrc infrastructure, while other must be included
10344         explicitly.</p>
10345 <p>An example for action files is
10346         <code class="filename">mk/subst.mk</code>.</p>
10347 </div>
10348 </div>
10349 <div class="sect1" title="24.6. The order in which files are loaded">
10350 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10351 <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
10352 <p>Package <code class="filename">Makefile</code>s usually consist of
10353         a set of variable definitions, and include the file
10354         <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
10355         Before that, they may also include various other
10356         <code class="filename">*.mk</code> files if they need to query the
10357         availability of certain features like the type of compiler or
10358         the X11 implementation. Due to the heavy use of preprocessor
10359         directives like <code class="literal">.if</code> and
10360         <code class="literal">.for</code>, the order in which the files are loaded
10361         matters.</p>
10362 <p>This section describes at which point the various files
10363         are loaded and gives reasons for that order.</p>
10364 <div class="sect2" title="24.6.1. The order in bsd.prefs.mk">
10365 <div class="titlepage"><div><div><h3 class="title">
10366 <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
10367 </h3></div></div></div>
10368 <p>The very first action in <code class="filename">bsd.prefs.mk</code>
10369         is to define some essential variables like
10370         <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
10371         <code class="varname">MACHINE_ARCH</code>.</p>
10372 <p>Then, the user settings are loaded from the file specified
10373         in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
10374         After that, those variables
10375         that have not been overridden by the user are loaded from
10376         <code class="filename">mk/defaults/mk.conf</code>.</p>
10377 <p>After the user settings, the system settings and platform
10378         settings are loaded, which may override the user
10379         settings.</p>
10380 <p>Then, the tool definitions are loaded. The tool wrappers
10381         are not yet in effect. This only happens when building a
10382         package, so the proper variables must be used instead of the
10383         direct tool names.</p>
10384 <p>As the last steps, some essential variables from the
10385         wrapper and the package system flavor are loaded, as well as the
10386         variables that have been cached in earlier phases of a package
10387         build.</p>
10388 </div>
10389 <div class="sect2" title="24.6.2. The order in bsd.pkg.mk">
10390 <div class="titlepage"><div><div><h3 class="title">
10391 <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
10392 </h3></div></div></div>
10393 <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
10394 <p>Then, the various <code class="filename">*-vars.mk</code> files are
10395         loaded, which fill default values for those variables that have
10396         not been defined by the package. These variables may later
10397         be used even in unrelated files.</p>
10398 <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
10399         provides the target <code class="literal">error-check</code> that is added
10400         as a special dependency to all other targets that use
10401         <code class="varname">DELAYED_ERROR_MSG</code> or
10402         <code class="varname">DELAYED_WARNING_MSG</code>.</p>
10403 <p>Then, the package-specific hacks from
10404         <code class="filename">hacks.mk</code> are included.</p>
10405 <p>Then, various other files follow. Most of them don't have
10406         any dependencies on what they need to have included before or
10407         after them, though some do.</p>
10408 <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
10409         <code class="varname">PKG_SKIP_REASON</code> is then executed, which
10410         restricts the use of these variables to all the files that have
10411         been included before. Appearances in later files will be
10412         silently ignored.</p>
10413 <p>Then, the files for the main targets are included, in the
10414         order of later execution, though the actual order should not
10415         matter.</p>
10416 <p>At last, some more files are included that don't set any
10417         interesting variables but rather just define make targets to be
10418         executed.</p>
10419 </div>
10420 </div>
10421 </div>
10422 <div class="chapter" title="Chapter 25. Regression tests">
10423 <div class="titlepage"><div><div><h2 class="title">
10424 <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
10425 <div class="toc">
10426 <p><b>Table of Contents</b></p>
10427 <dl>
10428 <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
10429 <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
10430 <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
10431 <dd><dl>
10432 <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
10433 <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
10434 </dl></dd>
10435 </dl>
10436 </div>
10437 <p>The pkgsrc infrastructure consists of a large codebase,
10438         and there are many corners where every little bit of a file is
10439         well thought out, making pkgsrc likely to fail as soon as
10440         anything is changed near those parts. To prevent most changes
10441         from breaking anything, a suite of regression tests should go
10442         along with every important part of the pkgsrc infrastructure.
10443         This chapter describes how regression tests work in pkgsrc and
10444         how you can add new tests.</p>
10445 <div class="sect1" title="25.1. The regression tests framework">
10446 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10447 <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
10448 <p></p>
10449 </div>
10450 <div class="sect1" title="25.2. Running the regression tests">
10451 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10452 <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
10453 <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
10454         provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
10455         can simply run that command, which will run all tests in the
10456         <code class="filename">regress</code> category.</p>
10457 </div>
10458 <div class="sect1" title="25.3. Adding a new regression test">
10459 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10460 <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
10461 <p>Every directory in the <code class="filename">regress</code>
10462         category that contains a file called <code class="filename">spec</code>
10463         is considered a regression test. This file is a shell program
10464         that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
10465         The following functions can be overridden to suit your
10466         needs.</p>
10467 <div class="sect2" title="25.3.1. Overridable functions">
10468 <div class="titlepage"><div><div><h3 class="title">
10469 <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
10470 <p>These functions do not take any parameters. They are all
10471         called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, so you should be careful
10472         to check the exitcodes of any commands you run in the
10473         test.</p>
10474 <div class="variablelist"><dl>
10475 <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
10476 <dd><p>This function prepares the environment for the
10477         test. By default it does nothing.</p></dd>
10478 <dt><span class="term"><code class="varname">do_test()</code></span></dt>
10479 <dd><p>This function runs the actual test. By default,
10480         it calls <code class="varname">TEST_MAKE</code> with the arguments
10481         <code class="varname">MAKEARGS_TEST</code> and writes its output including
10482         error messages into the file
10483         <code class="varname">TEST_OUTFILE</code>.</p></dd>
10484 <dt><span class="term"><code class="varname">check_result()</code></span></dt>
10485 <dd><p>This function is run after the test and is
10486         typically used to compare the actual output from the one that is
10487         expected. It can make use of the various helper functions from
10488         the next section.</p></dd>
10489 <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
10490 <dd><p>This function cleans everything up after the
10491         test has been run. By default it does nothing.</p></dd>
10492 </dl></div>
10493 </div>
10494 <div class="sect2" title="25.3.2. Helper functions">
10495 <div class="titlepage"><div><div><h3 class="title">
10496 <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
10497 <div class="variablelist"><dl>
10498 <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
10499 <dd><p>This function compares the exitcode of the
10500         <span class="command"><strong>do_test()</strong></span> function with its first parameter.
10501         If they differ, the test will fail.</p></dd>
10502 <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
10503 <dd><p>This function checks for each of its parameters
10504         if the output from <span class="command"><strong>do_test()</strong></span> matches the
10505         extended regular expression. If it does not, the test will
10506         fail.</p></dd>
10507 <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
10508 <dd><p>This function checks for each of its parameters
10509         if the output from <span class="command"><strong>do_test()</strong></span> does
10510         <span class="emphasis"><em>not</em></span> match the extended regular expression.
10511         If any of the regular expressions matches, the test will
10512         fail.</p></dd>
10513 </dl></div>
10514 </div>
10515 </div>
10516 </div>
10517 <div class="chapter" title="Chapter 26. Porting pkgsrc">
10518 <div class="titlepage"><div><div><h2 class="title">
10519 <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
10520 <div class="toc">
10521 <p><b>Table of Contents</b></p>
10522 <dl>
10523 <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
10524 <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
10525 </dl>
10526 </div>
10527 <p>The pkgsrc system has already been ported to many
10528         operating systems, hardware architectures and compilers. This
10529         chapter explains the necessary steps to make pkgsrc even more
10530         portable.</p>
10531 <div class="sect1" title="26.1. Porting pkgsrc to a new operating system">
10532 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10533 <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
10534 <p>To port pkgsrc to a new operating system (called
10535         <code class="literal">MyOS</code> in this example), you need to touch the
10536         following files:</p>
10537 <div class="variablelist"><dl>
10538 <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>
10539 <dd><p>This file contains some basic definitions, for
10540         example the name of the C
10541         compiler.</p></dd>
10542 <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
10543 <dd><p>Insert code that defines the variables
10544         <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
10545         <code class="varname">LOWER_OS_VERSION</code>,
10546         <code class="varname">LOWER_VENDOR</code>,
10547         <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
10548         <code class="varname">APPEND_ELF</code>, and the other variables that
10549         appear in this file.</p></dd>
10550 <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10551 <dd><p>This file contains the platform-specific
10552         definitions that are used by pkgsrc. Start by copying one of the
10553         other files and edit it to your
10554         needs.</p></dd>
10555 <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
10556 <dd><p>This file contains a list of directories,
10557         together with their permission bits and ownership. These
10558         directories will be created automatically with every package
10559         that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
10560         be removed.</p></dd>
10561 <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
10562 <dd><p>Just copy one of the pre-existing x11.dist files
10563         to your
10564         <code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
10565 <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
10566 <dd><p>On some operating systems, the tools that are
10567         provided with the base system are not good enough for pkgsrc.
10568         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
10569         narrow limit on the line length they can process. Therefore
10570         pkgsrc brings its own tools, which can be enabled
10571         here.</p></dd>
10572 <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
10573 <dd><p>This file defines the paths to all the tools
10574         that are needed by one or the other package in pkgsrc, as well
10575         as by pkgsrc itself. Find out where these tools are on your
10576         platform and add them.</p></dd>
10577 </dl></div>
10578 <p>Now, you should be able to build some basic packages, like
10579         <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>
10580 </div>
10581 <div class="sect1" title="26.2. Adding support for a new compiler">
10582 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10583 <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
10584 <p>TODO</p>
10585 </div>
10586 </div>
10587 </div>
10588 <div class="appendix" title="Appendix A. A simple example package: bison">
10589 <div class="titlepage"><div><div><h2 class="title">
10590 <a name="examples"></a>Appendix A. A simple example package: bison</h2></div></div></div>
10591 <div class="toc">
10592 <p><b>Table of Contents</b></p>
10593 <dl>
10594 <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
10595 <dd><dl>
10596 <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
10597 <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
10598 <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
10599 <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>
10600 </dl></dd>
10601 <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
10602 </dl>
10603 </div>
10604 <p>We checked to find a piece of software that wasn't in the packages
10605     collection, and picked GNU bison. Quite why someone would want to have
10606     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
10607     present in the tree is beyond us, but it's useful for the purposes of
10608     this exercise.</p>
10609 <div class="sect1" title="A.1. files">
10610 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10611 <a name="example-files"></a>A.1. files</h2></div></div></div>
10612 <div class="sect2" title="A.1.1. Makefile">
10613 <div class="titlepage"><div><div><h3 class="title">
10614 <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
10615 <pre class="programlisting">
10616 # $NetBSD$
10617 #
10618
10619 DISTNAME=       bison-1.25
10620 CATEGORIES=     devel
10621 MASTER_SITES=   ${MASTER_SITE_GNU}
10622
10623 MAINTAINER=     thorpej@NetBSD.org
10624 HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
10625 COMMENT=        GNU yacc clone
10626
10627 GNU_CONFIGURE=  yes
10628 INFO_FILES=     bison.info
10629
10630 .include "../../mk/bsd.pkg.mk"
10631 </pre>
10632 </div>
10633 <div class="sect2" title="A.1.2. DESCR">
10634 <div class="titlepage"><div><div><h3 class="title">
10635 <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
10636 <pre class="programlisting">
10637 GNU version of yacc.  Can make re-entrant parsers, and numerous other
10638 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
10639 of the NetBSD source tree is beyond me.
10640 </pre>
10641 </div>
10642 <div class="sect2" title="A.1.3. PLIST">
10643 <div class="titlepage"><div><div><h3 class="title">
10644 <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
10645 <pre class="programlisting">
10646 @comment $NetBSD$
10647 bin/bison
10648 man/man1/bison.1.gz
10649 share/bison.simple
10650 share/bison.hairy
10651 </pre>
10652 </div>
10653 <div class="sect2" title="A.1.4. Checking a package with pkglint">
10654 <div class="titlepage"><div><div><h3 class="title">
10655 <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
10656 </h3></div></div></div>
10657 <p>The NetBSD package system comes with
10658         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
10659         which helps to check the contents of these
10660         files. After installation it is quite easy to use, just change to the
10661         directory of the package you wish to examine and execute
10662         <span class="command"><strong>pkglint</strong></span>:</p>
10663 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
10664 looks fine.</pre>
10665 <p>Depending on the supplied command line arguments (see pkglint(1)),
10666         more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
10667         -Wall</strong></span> for a very thorough check.</p>
10668 </div>
10669 </div>
10670 <div class="sect1" title="A.2. Steps for building, installing, packaging">
10671 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10672 <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
10673 <p>Create the directory where the package lives,
10674       plus any auxiliary directories:</p>
10675 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
10676 <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
10677 <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
10678 <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
10679 <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
10680       <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>)
10681       then continue with fetching the distfile:</p>
10682 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
10683 &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
10684 &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
10685 Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10686 ftp: Error retrieving file: 500 Internal error
10687
10688 &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
10689 Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10690 ftp: Error retrieving file: 500 Internal error
10691
10692 &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
10693 Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
10694 Successfully retrieved file.</pre>
10695 <p>Generate the checksum of the distfile into
10696       <code class="filename">distinfo</code>:</p>
10697 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
10698 <p>Now compile:</p>
10699 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10700 &gt;&gt; Checksum OK for bison-1.25.tar.gz.
10701 ===&gt;  Extracting for bison-1.25
10702 ===&gt;  Patching for bison-1.25
10703 ===&gt;   Ignoring empty patch directory
10704 ===&gt;  Configuring for bison-1.25
10705 creating cache ./config.cache
10706 checking for gcc... cc
10707 checking whether we are using GNU C... yes
10708 checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
10709 checking how to run the C preprocessor... cc -E
10710 checking for minix/config.h... no
10711 checking for POSIXized ISC... no
10712 checking whether cross-compiling... no
10713 checking for ANSI C header files... yes
10714 checking for string.h... yes
10715 checking for stdlib.h... yes
10716 checking for memory.h... yes
10717 checking for working const... yes
10718 checking for working alloca.h... no
10719 checking for alloca... yes
10720 checking for strerror... yes
10721 updating cache ./config.cache
10722 creating ./config.status
10723 creating Makefile
10724 ===&gt;  Building for bison-1.25
10725 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
10726 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
10727 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
10728 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
10729 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
10730 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
10731 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
10732 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
10733 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
10734 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
10735 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
10736 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
10737 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
10738 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
10739 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
10740 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
10741 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
10742 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
10743 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
10744 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
10745 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
10746 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
10747 ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
10748 rm -f bison.s1
10749 sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
10750 <p>Everything seems OK, so install the files:</p>
10751 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10752 &gt;&gt; Checksum OK for bison-1.25.tar.gz.
10753 ===&gt;  Installing for bison-1.25
10754 sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
10755 rm -f /usr/pkg/bin/bison
10756 cd /usr/pkg/share; rm -f bison.simple bison.hairy
10757 rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
10758 install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
10759 /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
10760 /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
10761 cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
10762 /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
10763 ===&gt;  Registering installation for bison-1.25</pre>
10764 <p>You can now use bison, and also - if you decide so - remove it with
10765       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
10766       binary package, do this now:</p>
10767 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10768 &gt;&gt; Checksum OK for bison-1.25.tar.gz.
10769 ===&gt;  Building package for bison-1.25
10770 Creating package bison-1.25.tgz
10771 Registering depends:.
10772 Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
10773 <p>Now that you don't need the source and object files
10774       any more, clean up:</p>
10775 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
10776 ===&gt;  Cleaning for bison-1.25</pre>
10777 </div>
10778 </div>
10779 <div class="appendix" title="Appendix B. Build logs">
10780 <div class="titlepage"><div><div><h2 class="title">
10781 <a name="logs"></a>Appendix B. Build logs</h2></div></div></div>
10782 <div class="toc">
10783 <p><b>Table of Contents</b></p>
10784 <dl>
10785 <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
10786 <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
10787 </dl>
10788 </div>
10789 <div class="sect1" title="B.1. Building figlet">
10790 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10791 <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
10792 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
10793 ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
10794 =&gt; figlet221.tar.gz doesn't seem to exist on this system.
10795 =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
10796 =&gt; [172219 bytes]
10797 Connected to ftp.plig.net.
10798 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
10799 331 Guest login ok, send your complete e-mail address as password.
10800 230-You are user #5 of 500 simultaneous users allowed.
10801 230-
10802 230-  ___ _             _ _
10803 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
10804 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
10805 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
10806 230-         |_|   |_|     |___|         |___|
10807 230-
10808 230-** Welcome to ftp.plig.org **
10809 230-
10810 230-Please note that all transfers from this FTP site are logged. If you
10811 230-do not like this, please disconnect now.
10812 230-
10813 230-This archive is available via
10814 230-
10815 230-HTTP:  http://ftp.plig.org/
10816 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
10817 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
10818 230-
10819 230-Please email comments, bug reports and requests for packages to be
10820 230-mirrored to ftp-admin@plig.org.
10821 230-
10822 230-
10823 230 Logged in anonymously.
10824 Remote system type is UNIX.
10825 Using binary mode to transfer files.
10826 200 Type okay.
10827 250 "/pub" is new cwd.
10828 250-"/pub/figlet" is new cwd.
10829 250-
10830 250-Welcome to the figlet archive at ftp.figlet.org
10831 250-
10832 250-    ftp://ftp.figlet.org/pub/figlet/
10833 250-
10834 250-The official FIGlet web page is:
10835 250-    http://www.figlet.org/
10836 250-
10837 250-If you have questions, please mailto:info@figlet.org. If you want to
10838 250-contribute a font or something else, you can email us.
10839 250
10840 250 "/pub/figlet/program" is new cwd.
10841 250 "/pub/figlet/program/unix" is new cwd.
10842 local: figlet221.tar.gz remote: figlet221.tar.gz
10843 502 Unimplemented command.
10844 227 Entering Passive Mode (195,40,6,41,246,104)
10845 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
10846 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
10847 226 Transfer completed.
10848 172219 bytes received in 00:02 (75.99 KB/s)
10849 221 Goodbye.
10850 =&gt; Checksum OK for figlet221.tar.gz.
10851 ===&gt; Extracting for figlet-2.2.1nb2
10852 ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
10853 ===&gt; Patching for figlet-2.2.1nb2
10854 ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
10855 ===&gt; Overriding tools for figlet-2.2.1nb2
10856 ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
10857 ===&gt; Configuring for figlet-2.2.1nb2
10858 ===&gt; Building for figlet-2.2.1nb2
10859 gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
10860 chmod a+x figlet
10861 gcc -O2 -o chkfont chkfont.c
10862 =&gt; Unwrapping files-to-be-installed.
10863 <code class="prompt">#</code>
10864 <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
10865 ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
10866 ===&gt; Installing for figlet-2.2.1nb2
10867 install -d -o root -g wheel -m 755 /usr/pkg/bin
10868 install -d -o root -g wheel -m 755 /usr/pkg/man/man6
10869 mkdir -p /usr/pkg/share/figlet
10870 cp figlet /usr/pkg/bin
10871 cp chkfont /usr/pkg/bin
10872 chmod 555 figlist showfigfonts
10873 cp figlist /usr/pkg/bin
10874 cp showfigfonts /usr/pkg/bin
10875 cp fonts/*.flf /usr/pkg/share/figlet
10876 cp fonts/*.flc /usr/pkg/share/figlet
10877 cp figlet.6 /usr/pkg/man/man6
10878 ===&gt; Registering installation for figlet-2.2.1nb2
10879 <code class="prompt">#</code></pre>
10880 </div>
10881 <div class="sect1" title="B.2. Packaging figlet">
10882 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10883 <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
10884 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
10885 ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
10886 ===&gt; Packaging figlet-2.2.1nb2
10887 ===&gt; Building binary package for figlet-2.2.1nb2
10888 Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
10889 Using SrcDir value of /usr/pkg
10890 Registering depends:.
10891 <code class="prompt">#</code></pre>
10892 </div>
10893 </div>
10894 <div class="appendix" title="Appendix C. Directory layout of the pkgsrc FTP server">
10895 <div class="titlepage"><div><div><h2 class="title">
10896 <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h2></div></div></div>
10897 <div class="toc">
10898 <p><b>Table of Contents</b></p>
10899 <dl>
10900 <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
10901 <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
10902 <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
10903 <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
10904 <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
10905 <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10906 source packages</a></span></dt>
10907 </dl>
10908 </div>
10909 <p>As in other big projects, the directory layout of pkgsrc
10910         is quite complex for newbies. This chapter explains where you
10911         find things on the FTP server. The base directory on
10912         <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>.
10913         On other servers it may be different, but inside this directory,
10914         everything should look the same, no matter on which server you
10915         are. This directory contains some subdirectories, which are
10916         explained below.</p>
10917 <div class="sect1" title="C.1. distfiles: The distributed source files">
10918 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10919 <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
10920 <p>The directory <code class="filename">distfiles</code> contains lots
10921         of archive files from all pkgsrc packages, which are mirrored
10922         here. The subdirectories are called after their package names
10923         and are used when the distributed files have names that don't
10924         explicitly contain a version number or are otherwise too generic
10925         (for example <code class="filename">release.tar.gz</code>).</p>
10926 </div>
10927 <div class="sect1" title="C.2. misc: Miscellaneous things">
10928 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10929 <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
10930 <p>This directory contains things that individual pkgsrc
10931         developers find worth publishing.</p>
10932 </div>
10933 <div class="sect1" title="C.3. packages: Binary packages">
10934 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10935 <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
10936 <p>This directory contains binary packages for the various
10937         platforms that are supported by pkgsrc.
10938         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>
10939 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
10940 <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
10941         operating system for which the packages have been built. The
10942         name is taken from the output of the <span class="command"><strong>uname</strong></span>
10943         command, so it may differ from the one you are used to
10944         hear.</p></li>
10945 <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
10946         architecture of the platform for which the packages have been
10947         built. It also includes the <code class="varname">ABI</code> (Application
10948         Binary Interface) for platforms that have several of
10949         them.</p></li>
10950 <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
10951         the operating system. For version numbers that change often (for
10952         example NetBSD-current), the often-changing part should be
10953         replaced with an <code class="literal">x</code>, for example
10954         <code class="literal">4.99.x</code>.</p></li>
10955 <li class="listitem"><p><code class="varname">TAG</code> is either
10956         <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
10957         for a stable branch, or <code class="literal">head</code> for packages
10958         built from the HEAD branch. The latter should only be used when
10959         the packages are updated on a regular basis. Otherwise the date
10960         from checking out pkgsrc should be appended, for example
10961         <code class="literal">head_20071015</code>.</p></li>
10962 </ul></div>
10963 <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
10964         can quickly click through the directories on the
10965         server and find the best binary packages for their machines. Since they
10966         usually know the operating system and the hardware architecture, OPSYS
10967         and ARCH are placed first. After these choices, they can select the
10968         best combination of OSVERSION and TAG together, since it is usually the
10969         case that packages stay compatible between different version of the
10970         operating system.</p>
10971 <p>In each of these directories, there is a
10972         whole binary packages collection for a specific platform. It has a directory called
10973         <code class="filename">All</code> which contains all binary packages.
10974         Besides that, there are various category directories that
10975         contain symbolic links to the real binary packages.</p>
10976 </div>
10977 <div class="sect1" title="C.4. reports: Bulk build reports">
10978 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10979 <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
10980 <p>Here are the reports from bulk builds, for those who want
10981         to fix packages that didn't build on some of the platforms. The
10982         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>
10983 </div>
10984 <div class="sect1" title="C.5. current, pkgsrc-20xxQy: source packages">
10985 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
10986 <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
10987 <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
10988 source packages</h2></div></div></div>
10989 <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
10990         that is the files that define how to create binary packages from
10991         source archives.</p>
10992 <p>The directory <code class="filename">pkgsrc</code> contains a
10993         snapshot of the CVS repository, which is updated regularly. The
10994         file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
10995         directory, ready to be downloaded as a whole.</p>
10996 <p>In the directories for the quarterly branches, there is an
10997         additional file called
10998         <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
10999         which contains the state of pkgsrc when it was branched.</p>
11000 </div>
11001 </div>
11002 <div class="appendix" title="Appendix D. Editing guidelines for the pkgsrc guide">
11003 <div class="titlepage"><div><div><h2 class="title">
11004 <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h2></div></div></div>
11005 <div class="toc">
11006 <p><b>Table of Contents</b></p>
11007 <dl>
11008 <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
11009 <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
11010 </dl>
11011 </div>
11012 <p>This section contains information on editing the pkgsrc
11013         guide itself.</p>
11014 <div class="sect1" title="D.1. Make targets">
11015 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11016 <a name="targets"></a>D.1. Make targets</h2></div></div></div>
11017 <p>The pkgsrc guide's source code is stored in
11018         <code class="filename">pkgsrc/doc/guide/files</code>, and several files
11019         are created from it:</p>
11020 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
11021 <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
11022 <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
11023 <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>
11024 <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>:
11025         The PDF version of the pkgsrc guide.</p></li>
11026 <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>:
11027         PostScript version of the pkgsrc guide.</p></li>
11028 </ul></div>
11029 </div>
11030 <div class="sect1" title="D.2. Procedure">
11031 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
11032 <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
11033 <p>The procedure to edit the pkgsrc guide is:</p>
11034 <div class="procedure"><ol class="procedure" type="1">
11035 <li class="step" title="Step 1"><p>Make sure you have the packages needed to
11036         regenerate the pkgsrc guide (and other XML-based NetBSD
11037         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
11038         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
11039         PostScript and PDF versions. You will need both packages
11040         installed, to make sure documentation is consistent across all
11041         formats.</p></li>
11042 <li class="step" title="Step 2"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
11043         right directory. All further steps will take place
11044         here.</p></li>
11045 <li class="step" title="Step 3"><p>Edit the XML file(s) in
11046         <code class="filename">files/</code>.</p></li>
11047 <li class="step" title="Step 4"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
11048         guide for valid XML and to build the final output files. If you
11049         get any errors at this stage, you can just edit the files, as
11050         there are only symbolic links in the working directory, pointing
11051         to the files in <code class="filename">files/</code>.</p></li>
11052 <li class="step" title="Step 5"><p><span class="command"><strong>(cd files &amp;&amp; cvs
11053         commit)</strong></span></p></li>
11054 <li class="step" title="Step 6"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
11055         regenerate the output files with the proper RCS
11056         Ids.</p></li>
11057 <li class="step" title="Step 7">
11058 <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
11059         commit the files in both <code class="filename">pkgsrc/doc</code> and
11060         <code class="filename">htdocs</code>.</p>
11061 <div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;">
11062 <h3 class="title">Note</h3>
11063 <p>If you have added, removed or renamed some chapters,
11064         you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
11065         <span class="command"><strong>cvs delete</strong></span> in the htdocs
11066         directory.</p>
11067 </div>
11068 </li>
11069 </ol></div>
11070 </div>
11071 </div>
11072 </div></body>
11073 </html>