 @@ -4531,1999 +4531,1999 @@ converters    games         mbone
   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
   you upgrade a package this way, you can easily compare the new
   set of patches with the previously existing one with
   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
   are replaced by new files, so carefully check if you want to take all
   the changes.</p>
 <p>When you have finished a package, remember to generate
   the checksums for the patch files by using the <span class="command"><strong>make
   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>
 <p>When adding a patch that corrects a problem in the
   distfile (rather than e.g. enforcing pkgsrc's view of where
   man pages should go), send the patch as a bug report to the
   maintainer.  This benefits non-pkgsrc users of the package,
   and usually makes it possible to remove the patch in future
   version.</p>
 <p>The file names of the patch files are usually of the form
   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
   Many packages still use the previous convention
   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
   but new patches should be of the form containing the filename.
   <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
   automatically.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
 <p>If you want to share patches between multiple packages
   in pkgsrc, e.g. because they use the same distfiles, set
   <code class="varname">PATCHDIR</code> to the path where the patch files
   can be found, e.g.:</p>
 <pre class="programlisting">
 PATCHDIR= ${.CURDIR}/../xemacs/patches
 </pre>
 <p>Patch files that are distributed by the author or other
     maintainers can be listed in
     <code class="varname">PATCHFILES</code>.</p>
 <p>If it is desired to store any patches that should not be
     committed into pkgsrc, they can be kept outside the pkgsrc
     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
     directory tree there is expected to have the same
     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
     patches are expected to be stored inside these dirs (also
     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
     example, if you want to keep a private patch for
     <code class="filename">pkgsrc/graphics/png</code>, keep it in
     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
     files in the named directory are expected to be patch files,
     and <span class="emphasis"><em>they are applied after pkgsrc patches are
     applied</em></span>.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
 <p>When fixing a portability issue in the code do not use
       preprocessor magic to check for the current operating system nor
       platform.  Doing so hurts portability to other platforms because
       the OS-specific details are not abstracted appropriately.</p>
 <p>The general rule to follow is: instead of checking for the
       operating system the application is being built on, check for the
       specific <span class="emphasis"><em>features</em></span> you need.  For example,
       instead of assuming that kqueue is available under NetBSD and
       using the <code class="varname">__NetBSD__</code> macro to conditionalize
       kqueue support, add a check that detects kqueue itself &mdash;
       yes, this generally involves patching the
       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
       that prevents some OSes from adopting interfaces from other OSes
       (e.g. Linux implementing kqueue), something that the above checks
       cannot take into account.</p>
 <p>Of course, checking for features generally involves more
       work on the developer's side, but the resulting changes are
       cleaner and there are chances they will work on many other
       platforms.  Not to mention that there are higher chances of being
       later integrated into the mainstream sources.  Remember:
       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
 <p>Some typical examples:</p>
 <div class="table">
 <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
 <div class="table-contents"><table summary="Patching examples" border="1">
 <colgroup>
 <col>
 <col>
 <col>
 </colgroup>
 <thead><tr>
 <th>Where</th>
 <th>Incorrect</th>
 <th>Correct</th>
 </tr></thead>
 <tbody>
 <tr>
 <td>configure script</td>
 <td>
 <pre class="programlisting">
 case ${target_os} in
 netbsd*) have_kvm=yes ;;
 *)       have_kvm=no  ;;
 esac
 </pre>
 	      </td>
 <td>
 <pre class="programlisting">
 AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
 </pre>
 	      </td>
 </tr>
 <tr>
 <td>C source file</td>
 <td>
 <pre class="programlisting">
 #if defined(__NetBSD__)
 #  include &lt;sys/event.h&gt;
 #endif
 </pre>
 	      </td>
 <td>
 <pre class="programlisting">
 #if defined(HAVE_SYS_EVENT_H)
 #  include &lt;sys/event.h&gt;
 #endif
 </pre>
 	      </td>
 </tr>
 <tr>
 <td>C source file</td>
 <td>
 <pre class="programlisting">
 int
 monitor_file(...)
+{
 #if defined(__NetBSD__)
         int fd = kqueue();
         ...
 #else
         ...
 #endif
+}
 </pre>
 	      </td>
 <td>
 <pre class="programlisting">
 int
 monitor_file(...)
+{
 #if defined(HAVE_KQUEUE)
         int fd = kqueue();
         ...
 #else
 	...
 #endif
+}
 </pre>
 	      </td>
 </tr>
 </tbody>
 </table></div>
 </div>
 <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
       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
 </a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
 </a>).  It summarizes multiple details on how to make
       software easier to package; all the suggestions in it were
       collected from our experience in pkgsrc work, so they are possibly
       helpful when creating patches too.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
 <p>Always, always, <span class="strong"><strong>always</strong></span>
       feed back any <span class="emphasis"><em>portability fixes</em></span> or
       improvements you do to a package to the mainstream developers.
       This is the only way to get their attention on portability issues
       and to ensure that future versions can be built out-of-the box on
       NetBSD.  Furthermore, any user that gets newer distfiles will get
       the fixes straight from the packaged code.</p>
 <p>This generally involves cleaning up the patches
       (because sometimes the patches that are
       added to pkgsrc are quick hacks), filing bug reports in the
       appropriate trackers for the projects and working with the
       mainstream authors to accept your changes.  It is
       <span class="emphasis"><em>extremely important</em></span> that you do it so that
       the packages in pkgsrc are kept simple and thus further changes
       can be done without much hassle.</p>
 <p>When you have done this, please add a URL to the upstream
       bug report to the patch comment.</p>
 <p>Support the idea of free software!</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="filename">DESCR</code></span></dt>
 <dd><p>A multi-line description of the piece of software.  This should include
 	  any credits where they are due.  Please bear in mind that others do not
 	  share your sense of humour (or spelling idiosyncrasies), and that others
 	  will read everything that you write here.</p></dd>
 <dt><span class="term"><code class="filename">PLIST</code></span></dt>
 <dd><p>This file governs the files that are installed on your
 	  system: all the binaries, manual pages, etc. There are other
 	  directives which may be entered in this file, to control the
 	  creation and deletion of directories, and the location of
 	  inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
 	  information.</p></dd>
 </dl></div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
 <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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
 	    First time after package extraction and before files are
 	    moved in place, the second time after the files to install
 	    are moved in place. This can be used to do any custom
 	    procedures not possible with @exec commands in
 	    <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
 	    <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><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>.
 	    Please note that you can modify variables in it easily by using
 	    <code class="varname">FILES_SUBST</code> in the package's
 	    <code class="filename">Makefile</code>:</p>
 <pre class="programlisting">
 FILES_SUBST+=  SOMEVAR="somevalue"
 </pre>
 <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
 	    <code class="filename">INSTALL</code>.  By default, substitution is
 	    performed for <code class="varname">PREFIX</code>,
 	    <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
 	    <code class="varname">VARBASE</code>, and a few others, type
 	    <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
 	    complete list.</p>
 </dd>
 <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
 <dd><p>This script is executed before and after any files are removed.  It is
 	    this script's responsibility to clean up any additional messy details
 	    around the package's installation, since all pkg_delete knows is how to
 	    delete the files created in the original distribution.
 	    See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
 	    and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
 	    The same methods to replace variables can be used as for
 	    the <code class="filename">INSTALL</code> file.</p></dd>
 <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
 <dd>
 <p>This file is displayed after installation of the package.
 	    Useful for things like legal notices on almost-free
 	    software and hints for updating config files after
 	    installing modules for apache, PHP etc.
 	    Please note that you can modify variables in it easily by using
 	    <code class="varname">MESSAGE_SUBST</code> in the package's
 	    <code class="filename">Makefile</code>:</p>
 <pre class="programlisting">
 MESSAGE_SUBST+=  SOMEVAR="somevalue"
 </pre>
 <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
 	    <code class="filename">MESSAGE</code>.  By default, substitution is
 	    performed for <code class="varname">PKGNAME</code>,
 	    <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
 	    <code class="varname">LOCALBASE</code>, <code class="varname">X11PREFIX</code>,
 	    <code class="varname">X11BASE</code>,
 	    <code class="varname">PKG_SYSCONFDIR</code>,
 	    <code class="varname">ROOT_GROUP</code>, and
 	    <code class="varname">ROOT_USER</code>.</p>
 <p>You can display a different or additional files by
 	    setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
 	    default is <code class="filename">MESSAGE</code>, if the file
 	    exists.</p>
 </dd>
 <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
 <dd><p>FIXME: There is no documentation on the
 	alternatives framework.</p></dd>
 </dl></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
 <dd><p>This file contains arbitrary things that could
 	also go into a <code class="filename">Makefile</code>, but its purpose is
 	to be used by more than one package. This file should only be
 	used when the packages that will use the file are known in
 	advance. For other purposes it is often better to write a
 	<code class="filename">*.mk</code> file and give it a good name that
 	describes what it does.</p></dd>
 <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
 <dd><p>This file contains the dependency information
 	for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
 <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
 <dd><p>This file contains workarounds for compiler bugs
 	and similar things. It is included automatically by the pkgsrc
 	infrastructure, so you don't need an extra
 	<code class="literal">.include</code> line for
 	it.</p></dd>
 <dt><span class="term"><code class="filename">options.mk</code></span></dt>
 <dd><p>This file contains the code for the
 	package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
 	selected by the user. If a package has only one or two options,
 	it is equally acceptable to put the code directly into the
 	<code class="filename">Makefile</code>.</p></dd>
 </dl></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="filename">README*</code></span></dt>
 <dd><p>These files do not take place in the creation of
 	a package and thus are purely informative to the package
 	developer.</p></dd>
 <dt><span class="term"><code class="filename">TODO</code></span></dt>
 <dd><p>This file contains things that need to be done
 	to make the package even
 	better.</p></dd>
 </dl></div>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="work-dir"></a>11.6. <code class="filename">work*</code>
 </h2></div></div></div>
 <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
     unpacked into the directory denoted by
     <code class="varname">WRKDIR</code>. It can be removed by running
     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
     directory is also used to keep various timestamp files.
     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
     The default is <code class="filename">${.CURDIR}/work</code>
     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
     if <code class="varname">OBJMACHINE</code> is set.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
 </h2></div></div></div>
 <p>If you have any files that you wish to be placed in the package prior
     to configuration or building, you could place these files here and use
     a <span class="command"><strong>${CP}</strong></span> command in the
     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
     this. Alternatively, you could simply diff the file against
     <code class="filename">/dev/null</code> and use the patch mechanism to manage
     the creation of this file.</p>
 <p>If you want to share files in this way with other
     packages, set the <code class="varname">FILESDIR</code> variable to point
     to the other package's <code class="filename">files</code> directory,
     e.g.:</p>
 <pre class="programlisting">
 FILESDIR=${.CURDIR}/../xemacs/files
 </pre>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
 <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
 <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
 <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
 <dt><span class="sect2"><a href="#converting-internal-to-external">12.3.2. Converting an internal list into an external list</a></span></dt>
 <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.3. Passing variables to a shell command</a></span></dt>
 <dt><span class="sect2"><a href="#quoting-guideline">12.3.4. Quoting guideline</a></span></dt>
 <dt><span class="sect2"><a href="#bsd-make-bug-workaround">12.3.5. Workaround for a bug in BSD Make</a></span></dt>
 </dl></dd>
 </dl>
 </div>
 <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
   each of which forms a well-defined part of the pkgsrc system. Using
   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
   like pkgsrc requires some discipline to keep the code correct and
   understandable.</p>
 <p>The basic ingredients for <code class="filename">Makefile</code>
   programming are variables (which are actually macros) and shell
   commands. Among these shell commands may even be more complex ones
   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
   as intended it is necessary to quote all variables correctly when they
   are used.</p>
 <p>This chapter describes some patterns, that appear quite often in
   <code class="filename">Makefile</code>s, including the pitfalls that come along
   with them.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
 <p>When you are creating a file as a
     target of a rule, always write the data to a temporary file first
     and finally rename that file. Otherwise there might occur an error
     in the middle of generating the file, and when the user runs
     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
     regenerated properly. Example:</p>
 <pre class="programlisting">
 wrong:
         @echo "line 1" &gt; ${.TARGET}
         @echo "line 2" &gt;&gt; ${.TARGET}
         @false
 correct:
         @echo "line 1" &gt; ${.TARGET}.tmp
         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
         @false
         @mv ${.TARGET}.tmp ${.TARGET}
 </pre>
 <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
     <code class="filename">wrong</code> will exist, although there was an error
     message in the first run. On the other hand, running <span class="command"><strong>make
     correct</strong></span> gives an error message twice, as expected.</p>
 <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
     <code class="literal">${.TARGET}</code> in case of error, but this only
     happens when it is interrupted, for example by pressing
     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
 </li></ul></div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
 <p><code class="filename">Makefile</code> variables contain strings that
     can be processed using the five operators ``='', ``+='', ``?='',
     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
     page.</p>
 <p>When a variable's value is parsed from a
     <code class="filename">Makefile</code>, the hash character ``#'' and the
     backslash character ``\'' are handled specially. If a backslash is
     followed by a newline, any whitespace immediately in front of the
     backslash, the backslash, the newline, and any whitespace
     immediately behind the newline are replaced with a single space. A
     backslash character and an immediately following hash character are
     replaced with a single hash character. Otherwise, the backslash is
     passed as is. In a variable assignment, any hash character that is
     not preceded by a backslash starts a comment that continues upto the
     end of the logical line.</p>
 <p><span class="emphasis"><em>Note:</em></span> Because of this parsing algorithm
     the only way to create a variable consisting of a single backslash
     is using the ``!='' operator, for example: <code class="varname">BACKSLASH!=echo "\\"</code>.</p>
 <p>So far for defining variables. The other thing you can do with
     variables is evaluating them. A variable is evaluated when it is
     part of the right side of the ``:='' or the ``!='' operator, or
     directly before executing a shell command which the variable is part
     of. In all other cases, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> performs lazy evaluation, that
     is, variables are not evaluated until there's no other way. The
     ``modifiers'' mentioned in the man page also evaluate the
     variable.</p>
 <p>Some of the modifiers split the string into words and then
     operate on the words, others operate on the string as a whole. When
     a string is split into words, it is split as you would expect
     it from <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sh+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
 <p>No rule without exception&mdash;the <span class="command"><strong>.for</strong></span>
     loop does not follow the shell quoting rules but splits at sequences
     of whitespace.</p>
 <p>There are several types of variables that should be handled
     differently. Strings and two types of lists.</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
       characters. Nevertheless, you should restrict yourself to only
       using printable characters. Examples are
       <code class="varname">PREFIX</code> and
       <code class="varname">COMMENT</code>.</p></li>
 <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
       are never exported to any shell command. Their elements are
       separated by whitespace. Therefore, the elements themselves cannot
       have embedded whitespace. Any other characters are allowed.
       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
       Examples are <code class="varname">DEPENDS</code> and
       <code class="varname">BUILD_DEPENDS</code>.</p></li>
 <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
       may be exported to a shell command. Their elements can contain any
       characters, including whitespace. That's why they cannot be used
       in <span class="command"><strong>.for</strong></span> loops. Examples are
       <code class="varname">DISTFILES</code> and
       <code class="varname">MASTER_SITES</code>.</p></li>
 </ul></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>All variable names starting with an underscore
 	are reserved for use by the pkgsrc infrastructure. They shall
 	not be used by package
 	<code class="filename">Makefile</code>s.</p></li>
 <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
 	lowercase variable names for the iteration
 	variables.</p></li>
 <li class="listitem"><p>All list variables should have a ``plural''
 	name, e.g. <code class="varname">PKG_OPTIONS</code> or
 	<code class="varname">DISTFILES</code>.</p></li>
 </ul></div>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
 <p>This section presents you with some code snippets you should
     use in your own code. If you don't find anything appropriate here,
     you should test your code and add it here.</p>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
 <pre class="programlisting">
 STRING=                 foo * bar `date`
 INT_LIST=               # empty
 ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
 EXT_LIST=               # empty
 ANOTHER_EXT_LIST=       a=b c=d
 INT_LIST+=              ${STRING}               # 1
 INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
 EXT_LIST+=              ${STRING:Q}             # 3
 EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
 </pre>
 <p>When you add a string to an external list (example 3), it
       must be quoted. In all other cases, you must not add a quoting
       level. You must not merge internal and external lists, unless you
       are sure that all entries are correctly interpreted in both
       lists.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="converting-internal-to-external"></a>12.3.2. Converting an internal list into an external list</h3></div></div></div>
 <pre class="programlisting">
 EXT_LIST=       # empty
 .for i in ${INT_LIST}
 EXT_LIST+=      ${i:Q}""
 .endfor
 </pre>
 <p>This code converts the internal list
       <code class="varname">INT_LIST</code> into the external list
       <code class="varname">EXT_LIST</code>. As the elements of an internal list
       are unquoted they must be quoted here. The reason for appending
       <code class="varname">""</code> is explained below.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="passing-variable-to-shell"></a>12.3.3. Passing variables to a shell command</h3></div></div></div>
 <p>Sometimes you may want to print an arbitrary string. There
 	are many ways to get it wrong and only few that can handle every
 	nastiness.</p>
 <pre class="programlisting">
 STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
 EXT_LIST=       string=${STRING:Q} x=second\ item
 all:
         echo ${STRING}                  # 1
         echo "${STRING}"                # 2
         echo "${STRING:Q}"              # 3
         echo ${STRING:Q}                # 4
         echo x${STRING:Q} | sed 1s,.,,  # 5
         printf "%s\\n" ${STRING:Q}""    # 6
         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
 </pre>
 <p>Example 1 leads to a syntax error in the shell, as the
       characters are just copied.</p>
 <p>Example 2 leads to a syntax error too, and if you leave out
       the last " character from <code class="varname">${STRING}</code>,
       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?date+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">date</span>(1)</span></a> will be executed. The <code class="varname">$HOME</code> shell
       variable would be evaluated, too.</p>
 <p>Example 3 outputs each space character preceded by a
       backslash (or not), depending on the implementation of the
       <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command.</p>
 <p>Example 4 handles correctly every string that does not start
       with a dash. In that case, the result depends on the
       implementation of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command. As long as you can
       guarantee that your input does not start with a dash, this form is
       appropriate.</p>
 <p>Example 5 handles even the case of a leading dash
       correctly.</p>
 <p>Example 6 also works with every string and is the
       light-weight solution, since it does not involve a pipe, which has
       its own problems.</p>
 <p>The <code class="varname">EXT_LIST</code> does not need to be quoted
       because the quoting has already been done when adding elements to
       the list.</p>
 <p>As internal lists shall not be passed to the shell, there is
       no example for it.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="quoting-guideline"></a>12.3.4. Quoting guideline</h3></div></div></div>
 <p>There are many possible sources of wrongly quoted variables.
       This section lists some of the commonly known ones.</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem">
 <p>Whenever you use the value of a list, think
 	about what happens to leading or trailing whitespace. If the
 	list is a well-formed shell expression, you can apply the
 	<code class="varname">:M*</code> modifier to strip leading and trailing
 	whitespace from each word. The <code class="varname">:M</code> operator
 	first splits its argument according to the rules of the shell,
 	and then creates a new list consisting of all words that match
 	the shell glob expression <code class="varname">*</code>, that is: all.
 	One class of situations where this is needed is when adding a
 	variable like <code class="varname">CPPFLAGS</code> to
 	<code class="varname">CONFIGURE_ARGS</code>. If the configure script
 	invokes other configure scripts, it strips the leading and
 	trailing whitespace from the variable and then passes it to the
 	other configure scripts. But these configure scripts expect the
 	(child) <code class="varname">CPPFLAGS</code> variable to be the same as
 	the parent <code class="varname">CPPFLAGS</code>. That's why we better
 	pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
 	here is how we do it:</p>
 <pre class="programlisting">
 CPPFLAGS=               # empty
 CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
 CPPFLAGS+=              ${MY_CPPFLAGS}
 CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
 all:
         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
         echo x${CONFIGURE_ARGS}x        # properly trimmed
 </pre>
 </li>
 <li class="listitem"><p>The example above contains one bug: The
 	<code class="varname">${PREFIX}</code> is a properly quoted shell
 	expression, but there is the C compiler after it, which also
 	expects a properly quoted string (this time in C syntax). The
 	version above is therefore only correct if
 	<code class="varname">${PREFIX}</code> does not have embedded backslashes
 	or double quotes. If you want to allow these, you have to add
 	another layer of quoting to each variable that is used as a C
 	string literal. You cannot use the <code class="varname">:Q</code>
 	operator for it, as this operator only works for the
 	shell.</p></li>
 <li class="listitem">
 <p>Whenever a variable can be empty, the
 	<code class="varname">:Q</code> operator can have surprising results. Here
 	are two completely different cases which can be solved with the
 	same trick.</p>
 <pre class="programlisting">
 EMPTY=                  # empty
 empty_test:
         for i in a ${EMPTY:Q} c; do \
             echo "$$i"; \
         done
 for_test:
 .for i in a:\ a:\test.txt
         echo ${i:Q}
         echo "foo"
 .endfor
 </pre>
 <p>The first example will only print two of the three lines
 	we might have expected. This is because
 	<code class="varname">${EMPTY:Q}</code> expands to the empty string, which
 	the shell cannot see. The workaround is to write
 	<code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
 	as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
 	-f ${FNAME:Q}</code> (both of these are wrong).</p>
 <p>The second example will only print three lines instead of
 	four. The first line looks like <code class="varname">a:\ echo foo</code>.
 	This is because the backslash of the value
 	<code class="varname">a:\</code> is interpreted as a line-continuation by
 	<a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, which makes the second line the arguments of the
 	<a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?echo+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">echo</span>(1)</span></a> command from the first line. To avoid this, write
 	<code class="varname">${i:Q}""</code>.</p>
 </li>
 </ul></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="bsd-make-bug-workaround"></a>12.3.5. Workaround for a bug in BSD Make</h3></div></div></div>
 <p>The pkgsrc bmake program does not handle the following
       assignment correctly. In case <code class="varname">_othervar_</code>
       contains a ``-'' character, one of the closing braces is included
       in <code class="varname">${VAR}</code> after this code executes.</p>
 <pre class="programlisting">
 VAR:=   ${VAR:N${_othervar_:C/-//}}
 </pre>
 <p>For a more complex code snippet and a workaround, see the
       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
       <code class="varname">bug1</code>.</p>
 </div>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
 <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
 <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>
 <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
 <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
 <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
 <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
 <dt><span class="sect1"><a href="#faq.common-dirs">13.8. Sharing directories between packages</a></span></dt>
 </dl>
 </div>
 <p>The <code class="filename">PLIST</code> file contains a package's
   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
   the package (relative to the <code class="filename">${PREFIX}</code>
   directory it's been installed in) plus some additional statements
   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
   This chapter addresses some issues that need attention when
   dealing with the <code class="filename">PLIST</code> file (or files, see
   below!).</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
 <p>Be sure to add a RCS ID line as the first thing in any
     <code class="filename">PLIST</code> file you write:</p>
 <pre class="programlisting">
 @comment $NetBSD$
     </pre>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
 <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
     to output a PLIST that matches any new files since the package
     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
     more information on this target.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
 </h2></div></div></div>
 <p>If you have used any of the *-dirs packages, as explained in
     <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
     <span class="command"><strong>make print-PLIST</strong></span> outputs a set of
     <code class="varname">@comment</code>s instead of real
     <code class="varname">@dirrm</code> lines.  You can also do this for
     specific directories and files, so that the results of that
     command are very close to reality. This helps <span class="emphasis"><em>a
     lot</em></span> during the update of packages.</p>
 <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
     of AWK patterns and actions that are used to filter the output of
     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
     scripting you like to it, but be careful with quoting.</p>
 <p>For example, to get all files inside the
     <code class="filename">libdata/foo</code> directory removed from the
     resulting PLIST:</p>
 <pre class="programlisting">
 PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
     </pre>
 <p>And to get all the <code class="varname">@dirrm</code> lines referring
     to a specific (shared) directory converted to
     <code class="varname">@comment</code>s:</p>
 <pre class="programlisting">
 PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
     </pre>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
 <p>A number of variables are substituted automatically in
     PLISTs when a package is installed on a system. This includes the
     following variables:</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
 <dd>
 <p>Some packages like emacs and perl embed information
 	  about which architecture they were built on into the
 	  pathnames where they install their files. To handle this
 	  case, PLIST will be preprocessed before actually used, and
 	  the symbol
 	  <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
 	  replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
 	  same is done if the string
 	  <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
 	  PLIST somewhere - use this on packages that have GNU
 	  autoconf-created configure scripts.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 <h3 class="title">Legacy note</h3>
 <p>There used to be a symbol
 	    <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
 	    was replaced by the output of <span class="command"><strong>uname
 	    -m</strong></span>, but that's no longer supported and has
 	    been removed.</p>
 </div>
 </dd>
 <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
 <dd>
 <p>Some packages want to embed the OS name and version
 	  into some paths.  To do this, use these variables in the
 	  <code class="filename">PLIST</code>:
 	  </p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <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>
 <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>
 <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>
 </ul></div>
 </dd>
 </dl></div>
 <p>For a complete list of values which are replaced by
     default, please look in <code class="filename">bsd.pkg.mk</code> (and
     search for <code class="varname">PLIST_SUBST</code>).</p>
 <p>If you want to change other variables not listed above, you
     can add variables and their expansions to this variable in the
     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>
 <pre class="programlisting">
 PLIST_SUBST+=   SOMEVAR="somevalue"
     </pre>
 <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
     in the <code class="filename">PLIST</code> with
     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
 <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
     the common case of conditionally including some
     <code class="filename">PLIST</code> entries. It can be done by adding
     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
     setting the corresponding <code class="varname">PLIST.foo</code> variable
     to <code class="literal">yes</code> if the entry should be included.
     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
     in the <code class="filename">PLIST</code> with either
     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
     For example, in <code class="filename">Makefile</code>:</p>
 <pre class="programlisting">
 PLIST_VARS+=	foo
 .if <em class="replaceable"><code>condition</code></em>
 PLIST.foo=	yes
 .else
     </pre>
 <p>And then in <code class="filename">PLIST</code>:</p>
 <pre class="programlisting">
 @comment $NetBSD$
 bin/bar
 man/man1/bar.1
 ${PLIST.foo}bin/foo
 ${PLIST.foo}man/man1/foo.1
 ${PLIST.foo}share/bar/foo.data
 ${PLIST.foo}@dirrm share/bar
     </pre>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
 <p>Man pages should be installed in compressed form if
     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
     and uncompressed otherwise. To handle this in the
     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
     appended/removed automatically for man pages according to
     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
     or not, see above for details. This modification of the
     <code class="filename">PLIST</code> file is done on a copy of it, not
     <code class="filename">PLIST</code> itself.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
 </h2></div></div></div>
 <p>To use one or more files as source for the <code class="filename">PLIST</code> used
     in generating the binary package, set the variable
     <code class="varname">PLIST_SRC</code> to the names of that file(s).
     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
     important. The default for <code class="varname">PLIST_SRC</code> is
     <code class="filename">${PKGDIR}/PLIST</code>.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
 <p>Some packages decide to install a different set of files based on
     the operating system being used. These differences can be
     automatically handled by using the following files:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
 <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
 <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
 <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
 <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
 </ul></div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="faq.common-dirs"></a>13.8. Sharing directories between packages</h2></div></div></div>
 <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
     multiple (and unrelated) packages install files.  These
     directories were problematic because you had to add special
     tricks in the PLIST to conditionally remove them, or have some
     centralized package handle them.</p>
 <p>In pkgsrc, it is now easy: Each package should create
     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
     will remove any directories left empty after uninstalling a
     package.</p>
 <p>If a package needs an empty directory to work, create
     the directory during installation as usual, and also add an
     entry to the PLIST:
     </p>
 <pre class="programlisting">
 @pkgdir path/to/empty/directory
     </pre>
 <p>
     </p>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
 <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
 <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       and
       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
 <dd><dl>
 <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>
 <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
 </dl></dd>
 </dl>
 </div>
 <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
   are seen by a package's configure and build processes.  This is implemented
   in a two step process:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Symlink headers and libraries for dependencies into
       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
       of <code class="varname">WRKDIR</code>.</p></li>
 <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
       <code class="option">-L${LOCALBASE}/lib</code> into references to
       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
       native compiler on some operating systems look like GCC, so that
       packages that expect GCC won't require modifications to build with
       those native compilers.</p></li>
 </ol></div>
 <p>This normalizes the environment in which a package is built so that the
   package may be built consistently despite what other software may be
   installed. Please note that the normal system header and library paths,
   e.g. <code class="filename">/usr/include</code>,
   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
   designed to insulate the package build from non-system-supplied
   software.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
 <p>The process of converting packages to use the buildlink3
     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
     The things to keep in mind are:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
 	instead of the actual toolchain.  Some packages are tricky,
 	and the only way to know for sure is the check
 	<code class="filename">${WRKDIR}/.work.log</code> to see if the
 	wrappers are being invoked.</p></li>
 <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
 	the package Makefile, e.g. Java VMs, standalone shells,
 	etc., because the code to symlink files into
 	<code class="filename">${BUILDLINK_DIR}</code> looks for files
 	relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
 	</p></li>
 <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
 	<code class="filename">buildlink3.mk</code> files that you list in a
 	package's Makefile are added as dependencies for that package.
 	</p></li>
 </ol></div>
 <p>If a dependency on a particular package is required for its libraries and
     headers, then we replace:</p>
 <pre class="programlisting">
 DEPENDS+=       foo&gt;=1.1.0:../../category/foo
 </pre>
 <p>with</p>
 <pre class="programlisting">
 .include "../../category/foo/buildlink3.mk"
 </pre>
 <p>The buildlink3.mk files usually define the required dependencies.
     If you need a newer version of the dependency when using buildlink3.mk
     files, then you can define it in your Makefile; for example:</p>
 <pre class="programlisting">
 BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
 .include "../../category/foo/buildlink3.mk"
 </pre>
 <p>There are several <code class="filename">buildlink3.mk</code>
     files in <code class="filename">pkgsrc/mk</code>
     that handle special package issues:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
 	the native or a pkgsrc Berkeley DB implementation based on
 	the values of <code class="varname">BDB_ACCEPTED</code> and
 	<code class="varname">BDB_DEFAULT</code>.</p></li>
 <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
 	comes with neither Curses nor NCurses, this will take care
 	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>
 <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
 	of <code class="varname">KRB5_ACCEPTED</code> to choose between
 	adding a dependency on Heimdal or MIT-krb5 for packages that
 	require a Kerberos 5 implementation.</p></li>
 <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
 	system-provided Motif installation or adds a dependency on
 	<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</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
 	<code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
 	<span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span> or
 	<span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
 	which Motif version will be used.</p></li>
 <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
-	system-provided GNU readline or ediline (libedit) installation,
+	system-provided GNU readline or editline (libedit) installation,
 	or adds a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
 	<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
 	<code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
 	If your package really needs GNU readline library, its Makefile
 	should include <code class="filename">devel/readline/buildlink3.mk</code>
 	instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
 <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
 	variables that may be used by packages that use the
 	Open Sound System (OSS) API.</p></li>
 <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
 	any of the Postgres versions in the variable
 	<code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
 	the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
 	the file for more information.</p></li>
 <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
 	<code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
 	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>
 <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
 	<code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
 	library.</p></li>
 </ul></div>
 <p>The comments in those <code class="filename">buildlink3.mk</code>
     files provide a more complete
     description of how to use them properly.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
 <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
     included by Makefiles to indicate the need to compile and link
     against header files and libraries provided by the package.  A
     <code class="filename">buildlink3.mk</code> file should always provide
     enough information to add the correct type of dependency
     relationship and include any other
     <code class="filename">buildlink3.mk</code> files that it needs to find
     headers and libraries that it needs in turn.</p>
 <p>To generate an initial <code class="filename">buildlink3.mk</code>
     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>
     package is highly recommended.  For most packages, the following
     command will generate a good starting point for
     <code class="filename">buildlink3.mk</code> files:</p>
 <pre class="screen">
 <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
 <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
     </pre>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
 <p>The following real-life example
       <code class="filename">buildlink3.mk</code> is taken
       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
 <pre class="programlisting">
 # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
 BUILDLINK_TREE+=	tiff
 .if !defined(TIFF_BUILDLINK3_MK)
 TIFF_BUILDLINK3_MK:=
 BUILDLINK_API_DEPENDS.tiff+=	tiff&gt;=3.6.1
 BUILDLINK_ABI_DEPENDS.tiff+=	tiff&gt;=3.7.2nb1
 BUILDLINK_PKGSRCDIR.tiff?=	../../graphics/tiff
 .include "../../devel/zlib/buildlink3.mk"
 .include "../../graphics/jpeg/buildlink3.mk"
 .endif # TIFF_BUILDLINK3_MK
 BUILDLINK_TREE+=	-tiff
 </pre>
 <p>The header and footer manipulate
       <code class="varname">BUILDLINK_TREE</code>, which is common across all
       <code class="filename">buildlink3.mk</code> files and is used to track
       the dependency tree.</p>
 <p>The main section is protected from multiple inclusion
       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
       added.  Several important variables are set in the section:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
 	  is the actual dependency recorded in the installed
 	  package; this should always be set using
 	  <span class="command"><strong>+=</strong></span> to ensure that
 	  we're appending to any pre-existing list of values.  This
 	  variable should be set to the first version of the
 	  package that had an backwards-incompatible API change.
 	  </p></li>
 <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
 	  is the location of the <em class="replaceable"><code>pkg</code></em>
 	  pkgsrc directory.</p></li>
 <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
 	  (not shown above) controls whether we use
 	  <code class="varname">BUILD_DEPENDS</code> or
 	  <code class="varname">DEPENDS</code> to add the dependency on
 	  <em class="replaceable"><code>pkg</code></em>.  The build dependency is
 	  selected by setting
 	  <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
 	  to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
 	  used.</p></li>
 <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
 	    and
 	    <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
 	    (not shown above) are lists of subdirectories of
 	    <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
 	    to add to the header and library search paths.  These
 	    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>
 	  respectively.</p></li>
 <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
 	    (not shown above) is the list of preprocessor flags to add
 	    to <code class="varname">CPPFLAGS</code>, which are passed on to the
 	    configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
 	    should be avoided and instead be handled using
 	    <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
 	  above.</p></li>
 </ul></div>
 <p>The following variables are all optionally defined within
       this second section (protected against multiple inclusion) and
       control which package files are symlinked into
       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
       transformed during the symlinking:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
 	    (not shown above) is a shell glob pattern relative to
 	    <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
 	    to be symlinked into
 	    <code class="filename">${BUILDLINK_DIR}</code>,
 	  e.g. <code class="filename">include/*.h</code>.</p></li>
 <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
 	    (not shown above) is a shell pipeline that
 	    outputs to stdout a list of files relative to
 	    <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
 	    The resulting files are to be symlinked
 	    into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
 	    this takes the <code class="filename">+CONTENTS</code> of a
 	    <em class="replaceable"><code>pkg</code></em> and filters it through
 	    <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
 <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
 	    (not shown above) is a filter command that filters
 	    <code class="filename">+CONTENTS</code> input into a list of files
 	    relative to
 	    <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
 	    on stdout.  By default for overwrite packages,
 	    <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
 	    outputs the contents of the <code class="filename">include</code>
 	    and <code class="filename">lib</code> directories in the package
 	    <code class="filename">+CONTENTS</code>, and for pkgviews packages,
 	    it outputs any libtool archives in
 	    <code class="filename">lib</code> directories.</p></li>
 <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
 	    (not shown above) is a list of sed arguments used to
 	    transform the name of the source filename into a
 	    destination filename, e.g. <span class="command"><strong>-e
 	    "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
 </ul></div>
 <p>This section can additionally include any
       <code class="filename">buildlink3.mk</code> needed for
       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
       Including these <code class="filename">buildlink3.mk</code> files
       means that the headers and libraries for these
       dependencies are also symlinked into
       <code class="filename">${BUILDLINK_DIR}</code>
       whenever the <em class="replaceable"><code>pkg</code></em>
       <code class="filename">buildlink3.mk</code>
       file is included. Dependencies are only added for directly
       include <code class="filename">buildlink3.mk</code> files.</p>
 <p>When providing a <code class="filename">buildlink3.mk</code> and
       including other <code class="filename">buildlink3.mk</code> files in it,
       please only add necessary ones, i.e., those whose libraries or
       header files are automatically exposed when the package is
       use.</p>
 <p>In particular, if only an executable
       (<code class="filename">bin/foo</code>) is linked against a library, that
       library does not need to be propagated in the
       <code class="filename">buildlink3.mk</code> file.</p>
 <p>The following steps should help you decide if a
       <code class="filename">buildlink3.mk</code> file needs to be included:
       </p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>Look at the installed header files: What
 	headers do they include? The packages providing these files
 	must be buildlinked.</p></li>
 <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
 	libraries and look against what other libraries they link.
 	Some of the packages providing these probably need to be
 	buildlinked; however, it's not automatic, since e.g. GTK on
 	some systems pulls in the X libraries, so they will show up in
 	the <code class="filename">ldd</code> output, while on others (like OS
 	X) it won't. <code class="filename">ldd</code> output can thus only be
 	used as a hint.</p></li>
 </ul></div>
 <p>
       </p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="updating-buildlink-depends"></a>14.2.2. Updating
       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       and
       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
 <p>These two variables differ in that one describes source
       compatibility (API) and the other binary compatibility (ABI).
       The difference is that a change in the API breaks compilation of
       programs while changes in the ABI stop compiled programs from
       running.</p>
 <p>Changes to the
       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       variable in a <code class="filename">buildlink3.mk</code> file happen
       very rarely. One possible reason is that all packages depending
       on this already need a newer version. In case it is bumped see
       the description below.</p>
 <p>The most common example of an ABI change is that the major
       version of a shared library is increased. In this case,
       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       should be adjusted to require at least the new package version.
       Then the packages that depend on this package need their
       <code class="varname">PKGREVISION</code>s increased and, if they have
       <code class="filename">buildlink3.mk</code> files, their
       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       adjusted, too. This is needed so pkgsrc will require the correct
       package dependency and not settle for an older one when building
       the source.</p>
 <p>See <a class="xref" href="#dependencies" title="19.1.6. Handling dependencies">Section 19.1.6, &#8220;Handling dependencies&#8221;</a> for
       more information about dependencies on other packages,
       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
       <code class="varname">ABI_DEPENDS</code> definitions.</p>
 <p>Please take careful consideration before adjusting
       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       or
       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       as we don't want to cause unneeded package deletions and
       rebuilds.  In many cases, new versions of packages work just
       fine with older dependencies.</p>
 <p>Also it is not needed to set
       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
       when it is identical to
       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.	</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
 <p>Some packages in pkgsrc install headers and libraries that
       coincide with headers and libraries present in the base system.
       Aside from a <code class="filename">buildlink3.mk</code> file, these
       packages should also include a <code class="filename">builtin.mk</code>
       file that includes the necessary checks to decide whether using
       the built-in software or the pkgsrc software is
     appropriate.</p>
 <p>The only requirements of a builtin.mk file for
     <em class="replaceable"><code>pkg</code></em> are:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>It should set
 	<code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
 	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>
 	after it is included.</p></li>
 <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
 	<code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
 	which is already set before the
 	<code class="filename">builtin.mk</code> file is included.</p></li>
 <li class="listitem"><p>It should be written to allow multiple inclusion.  This
 	is <span class="emphasis"><em>very</em></span> important and takes careful
 	attention to <code class="filename">Makefile</code> coding.</p></li>
 </ol></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
 <p>The following is the recommended template for builtin.mk
       files:</p>
 <pre class="programlisting">
 .if !defined(IS_BUILTIN.foo)
+#
 # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
 # genuinely exists in the system or not.
+#
 IS_BUILTIN.foo?=        no
 # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
 # version can be determined.
+#
 .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
 BUILTIN_PKG.foo?=       foo-1.0
 .  endif
 .endif  # IS_BUILTIN.foo
 .if !defined(USE_BUILTIN.foo)
 USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
 .  if defined(BUILTIN_PKG.foo)
 .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
 .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
 USE_BUILTIN.foo!=                                                       \
         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
 .      endif
 .    endfor
 .  endif
 .endif  # USE_BUILTIN.foo
 CHECK_BUILTIN.foo?=     no
 .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
+#
 # Here we place code that depends on whether USE_BUILTIN.foo is set to
 # "yes" or "no".
+#
 .endif  # CHECK_BUILTIN.foo
 </pre>
 <p>The first section sets
       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
       depending on if <em class="replaceable"><code>pkg</code></em> really exists
       in the base system.  This should not be a base system software
       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
       included as part of the base system.  This variable is only
       used internally within the <code class="filename">builtin.mk</code>
       file.</p>
 <p>The second section sets
       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
       to the version of <em class="replaceable"><code>pkg</code></em> in the base
       system if it exists (if
       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
       within the <code class="filename">builtin.mk</code> file.</p>
 <p>The third section sets
       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
       and is <span class="emphasis"><em>required</em></span> in all
       <code class="filename">builtin.mk</code> files.  The code in this
       section must make the determination whether the built-in
       software is adequate to satisfy the dependencies listed in
       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
       This is typically done by comparing
       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
       against each of the dependencies in
       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
       <span class="emphasis"><em>must</em></span> be set to the correct value by the
       end of the <code class="filename">builtin.mk</code> file.  Note that
       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
       that the built-in version of the software is similar enough to
       be used as a replacement.</p>
 <p>The last section is guarded by
       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
       and includes code that uses the value of
       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
       set in the previous section.  This typically includes, e.g.,
       adding additional dependency restrictions and listing additional
       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
 <p>When building packages, it's possible to choose whether to set
 	a global preference for using either the built-in (native)
 	version or the pkgsrc version of software to satisfy a
 	dependency.  This is controlled by setting
 	<code class="varname">PREFER_PKGSRC</code> and
 	<code class="varname">PREFER_NATIVE</code>.  These variables take values
 	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
 	packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
 	use the pkgsrc versions of software, while
 	<code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
 	built-in versions.  Preferences are determined by the most
 	specific instance of the package in either
 	<code class="varname">PREFER_PKGSRC</code> or
 	<code class="varname">PREFER_NATIVE</code>.  If a package is specified
 	in neither or in both variables, then
 	<code class="varname">PREFER_PKGSRC</code> has precedence over
 	<code class="varname">PREFER_NATIVE</code>.  For example, to require
 	using pkgsrc versions of software for all but the most basic
       bits on a NetBSD system, you can set:</p>
 <pre class="programlisting">
 PREFER_PKGSRC=  yes
 PREFER_NATIVE=  getopt skey tcp_wrappers
 </pre>
 <p>A package <span class="emphasis"><em>must</em></span> have a
       <code class="filename">builtin.mk</code>
       file to be listed in <code class="varname">PREFER_NATIVE</code>,
       otherwise it is simply ignored in that list.</p>
 </div>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
 <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
 <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
 <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
 <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
 <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>
 <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
 <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
 <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
 <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
 <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>
 </dl>
 </div>
 <p>This chapter describes the framework known as
 <code class="literal">pkginstall</code>, whose key features are:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>Generic installation and manipulation of directories and files
     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
 <li class="listitem"><p>Automatic handling of configuration files during installation,
     provided that packages are correctly designed.</p></li>
 <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
 <li class="listitem"><p>Registration of system users and groups.</p></li>
 <li class="listitem"><p>Registration of system shells.</p></li>
 <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
 </ul></div>
 <p>The following sections inspect each of the above points in detail.</p>
 <p>You may be thinking that many of the things described here could be
 easily done with simple code in the package's post-installation target
 (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
 as the code in them is only executed when building from source.  Machines
 using binary packages could not benefit from it at all (as the code itself
 could be unavailable).  Therefore, the only way to achieve any of the items
 described above is by means of the installation scripts, which are
 automatically generated by pkginstall.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
 <p>As you already know, the <code class="filename">PLIST</code> file holds a list
 of files and directories that belong to a package.  The names used in it
 are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
 which means that it cannot register files outside this directory (absolute
 path names are not allowed).  Despite this restriction, some packages need
 to install files outside this location; e.g., under
 <code class="filename">${VARBASE}</code> or
 <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
 is to create such files during installation time by using
 installation scripts.</p>
 <p>The generic installation scripts are shell scripts that can
 contain arbitrary code.  The list of scripts to execute is taken from
 the <code class="varname">INSTALL_FILE</code> variable, which defaults to
 <code class="filename">INSTALL</code>.  A similar variable exists for package
 removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
 <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
 commands, so they have the potential to create and manage files
 anywhere in the file system.</p>
 <p>Using these general installation files is not recommended, but
 may be needed in some special cases.  One reason for avoiding them is
 that the user has to trust the packager that there is no unwanted or
 simply erroneous code included in the installation script. Also,
 previously there were many similar scripts for the same functionality,
 and fixing a common error involved finding and changing all of
 them.</p>
 <p>The pkginstall framework offers another, standardized way.  It
 provides generic scripts to abstract the manipulation of such files
 and directories based on variables set in the package's
 <code class="filename">Makefile</code>.  The rest of this section describes
 these variables.</p>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
 <p>The following variables can be set to request the creation of
 directories anywhere in the file system:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
     contain a list of directories that should be created and should attempt
     to be destroyed by the installation scripts.  The difference between
     the two is that the latter prompts the administrator to remove any
     directories that may be left after deinstallation (because they were
     not empty), while the former does not.</p></li>
 <li class="listitem">
 <p><code class="varname">MAKE_DIRS_PERMS</code> and
     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
     which directories should be created and should attempt to be destroyed
     by the installation scripts.  Each tuple holds the following values,
     separated by spaces: the directory name, its owner, its group and its
     numerical mode.  For example:</p>
 <pre class="programlisting">
 MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
 </pre>
 <p>The difference between the two is exactly the same as their
     non-<code class="varname">PERMS</code> counterparts.</p>
 </li>
 </ul></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
 <p>Creating non-empty files outside the installation prefix is tricky
 because the <code class="filename">PLIST</code> forces all files to be inside it.
 To overcome this problem, the only solution is to extract the file in the
 known place (i.e., inside the installation prefix) and copy it to the
 appropriate location during installation (done by the installation scripts
 generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
 file</em></span> in the following paragraphs, which describe the variables
 that can be used to automatically and consistently handle files outside the
 installation prefix:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem">
 <p><code class="varname">CONF_FILES</code> and
     <code class="varname">REQD_FILES</code> are pairs of master and target files.
     During installation time, the master file is copied to the target one
     if and only if the latter does not exist.  Upon deinstallation, the
     target file is removed provided that it was not modified by the
     installation.</p>
 <p>The difference between the two is that the latter prompts the
     administrator to remove any files that may be left after
     deinstallation (because they were not empty), while the former does
     not.</p>
 </li>
 <li class="listitem">
 <p><code class="varname">CONF_FILES_PERMS</code> and
     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
     files as well as their target locations.  For each of them, it also
     specifies their owner, their group and their numeric permissions, in
     this order.  For example:</p>
 <pre class="programlisting">
 REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
 </pre>
 <p>The difference between the two is exactly the same as their
     non-<code class="varname">PERMS</code> counterparts.</p>
 </li>
 </ul></div>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
 <p>Configuration files are special in the sense that they are installed
 in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
 need special treatment during installation (most of which is automated by
 pkginstall).  The main concept you must bear in mind is that files marked
 as configuration files are automatically copied to the right place (somewhere
 inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
 and only if</em></span> they didn't exist before.  Similarly, they will not
 be removed if they have local modifications.  This ensures that
 administrators never lose any custom changes they may have made.</p>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
 <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
 specifies where configuration files shall be installed.  Its contents are
 set based upon the following variables:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
     be overridden by the user to point to his preferred location (e.g.,
     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
     Packages must not use it directly.</p></li>
 <li class="listitem">
 <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
     for the package being built shall be installed.  The definition of this
     variable only makes sense in the package's
     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
 <p>As an example, consider the Apache package,
     <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
     configuration files under the
     <code class="filename">httpd/</code> subdirectory of
     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
     Makefile.</p>
 </li>
 <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
     variable that holds this package's configuration directory (if
     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
 <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
     directory where the configuration files for the package identified by
     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
 </ul></div>
 <p>Based on the above variables, pkginstall determines the value of
 <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
 variable that can be used within a package to refer to its configuration
 directory.  The algorithm used to set its value is basically the
 following:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
     its value is used.</p></li>
 <li class="listitem"><p>If the previous variable is not defined but
     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
     <code class="filename">Makefile</code>, the resulting value is
     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
 <li class="listitem"><p>Otherwise, it is set to
     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
 </ol></div>
 <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
 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
 subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
 be created with OWN_DIRS or MAKE_DIRS.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
 <p>Given that pkgsrc (and users!) expect configuration files to be in a
 known place, you need to teach each package where it shall install its
 files.  In some cases you will have to patch the package Makefiles to
 achieve it.  If you are lucky, though, it may be as easy as passing an
 extra flag to the configuration script; this is the case of GNU Autoconf-
 generated files:</p>
 <pre class="programlisting">
 CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
 </pre>
 <p>Note that this specifies where the package has to <span class="emphasis"><em>look
 for</em></span> its configuration files, not where they will be originally
 installed (although the difference is never explicit,
 unfortunately).</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
 <p>As said before, pkginstall automatically handles configuration files.
 This means that <span class="strong"><strong>the packages themselves must not
 touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
 directly</strong></span>.  Bad news is that many software installation scripts
 will, out of the box, mess with the contents of that directory.  So what is
 the correct procedure to fix this issue?</p>
 <p>You must teach the package (usually by manually patching it) to
 install any configuration files under the examples hierarchy,
 <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
 <code class="filename">PLIST</code> registers them and the administrator always
 has the original copies available.</p>
 <p>Once the required configuration files are in place (i.e., under the
 examples hierarchy), the pkginstall framework can use them as master copies
 during the package installation to update what is in
 <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
 <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
 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
 about their syntax and their purpose.  Here is an example, taken from the
 <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>
 <pre class="programlisting">
 EGDIR=        ${PREFIX}/share/doc/mutt/samples
 CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
 </pre>
 <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
 package and has no meaning outside it.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
 <p>The automatic copying of config files can be toggled by setting the
 environment variable <code class="varname">PKG_CONFIG</code> prior to package
 installation.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
 <p>System startup scripts are special files because they must be
 installed in a place known by the underlying OS, usually outside the
 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
 can be used.  However, pkginstall provides a special mechanism to handle
 these files.</p>
 <p>In order to provide system startup scripts, the package has
 to:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
     the <code class="literal">.sh</code> suffix appended.  Considering the
     <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
     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
 <li class="listitem">
 <p>Tell pkginstall to handle it, appending the name of the script,
     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
     Continuing the previous example:</p>
 <pre class="programlisting">
 RCD_SCRIPTS+=   cupsd
 </pre>
 </li>
 </ol></div>
 <p>Once this is done, pkginstall will do the following steps for each
 script in an automated fashion:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Process the file found in the files directory applying all the
     substitutions described in the <code class="filename">FILES_SUBST</code>
     variable.</p></li>
 <li class="listitem"><p>Copy the script from the files directory to the examples
     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
     that this master file must be explicitly registered in the
     <code class="filename">PLIST</code>.</p></li>
 <li class="listitem"><p>Add code to the installation scripts to copy the startup script
     from the examples hierarchy into the system-wide startup scripts
     directory.</p></li>
 </ol></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
 <p>The automatic copying of config files can be toggled by setting the
 environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
 installation.  Note that the scripts will be always copied inside the
 examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
 matter what the value of this variable is.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
 <p>If a package needs to create special users and/or groups during
 installation, it can do so by using the pkginstall framework.</p>
 <p>Users can be created by adding entries to the
 <code class="varname">PKG_USERS</code> variable.  Each entry has the following
 syntax:</p>
 <pre class="programlisting">
 user:group
 </pre>
 <p>Further specification of user details may be done by setting
 per-user variables.
 <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
 numeric UID for the user.
 <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
 user's description or comment.
 <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
 user's home directory, and defaults to
 <code class="filename">/nonexistent</code> if not specified.
 <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
 user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
 not specified.</p>
 <p>Similarly, groups can be created by adding entries to the
 <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
 <pre class="programlisting">
 group
 </pre>
 <p>The numeric GID of the group may be set by defining
 <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
 <p>If a package needs to create the users and groups at an earlier
 stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
 either <code class="literal">configure</code> or <code class="literal">build</code> to
 indicate the phase before which the users and groups are created.  In
 this case, the numeric UIDs and GIDs of the created users and groups
 are automatically hardcoded into the final installation scripts.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="shells"></a>15.5. System shells</h2></div></div></div>
 <p>Packages that install system shells should register them in the shell
 database, <code class="filename">/etc/shells</code>, to make things easier to the
 administrator.  This must be done from the installation scripts to keep
 binary packages working on any system.  pkginstall provides an easy way to
 accomplish this task.</p>
 <p>When a package provides a shell interpreter, it has to set the
 <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
 add some hooks to the installation scripts to handle it.  Consider the
 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>
 <pre class="programlisting">
 PKG_SHELL=      ${PREFIX}/bin/zsh
 </pre>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
 <p>The automatic registration of shell interpreters can be disabled by
 the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
 environment variable to <code class="literal">NO</code>.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
 <p>Packages that install X11 fonts should update the database files
 that index the fonts within each fonts directory.  This can easily be
 accomplished within the pkginstall framework.</p>
 <p>When a package installs X11 fonts, it must list the directories in
 which fonts are installed in the
 <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
 where <em class="replaceable"><code>type</code></em> can be one of <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>.  This will add hooks to the
 installation scripts to run the appropriate commands to update the fonts
 database files within each of those directories.  For convenience, if the
 directory path is relative, it is taken to be relative to the package's
 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>
 <pre class="programlisting">
 FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
 </pre>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
 <p>The automatic update of fonts databases can be disabled by
 the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
 environment variable to <code class="literal">NO</code>.</p>
 </div>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
 <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>
 <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
 <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
 </dl>
 </div>
 <p>Many packages have the ability to be built to support different
 sets of features.  <code class="filename">bsd.options.mk</code> is a framework
 in pkgsrc that provides generic handling of those options that
 determine different ways in which the packages can be built.  It's
 possible for the user to specify exactly which sets of options will be
 built into a package or to allow a set of global default options
 apply.</p>
 <p>There are two broad classes of behaviors that one might want to
 control via options.  One is whether some particular feature is
 enabled in a program that will be built anyway, often by including or
 not including a dependency on some other package.  The other is
 whether or not an additional program will be built as part of the
 package.  Generally, it is better to make a split package for such
 additional programs instead of using options, because it enables
 binary packages to be built which can then be added separately.  For
 example, the foo package might have minimal dependencies (those
 packages without which foo doesn't make sense), and then the foo-gfoo
 package might include the GTK frontend program gfoo.  This is better
 than including a gtk option to foo that adds gfoo, because either that
 option is default, in which case binary users can't get foo without
 gfoo, or not default, in which case they can't get gfoo.  With split
 packages, they can install foo without having GTK, and later decide to
 install gfoo (pulling in GTK at that time).  This is an advantage to
 source users too, avoiding the need for rebuilds.</p>
 <p>Plugins with widely varying dependencies should usually be split
 instead of options.</p>
 <p>It is often more work to maintain split packages, especially if
 the upstream package does not support this.  The decision of split
 vs. option should be made based on the likelihood that users will want
 or object to the various pieces, the size of the dependencies that are
 included, and the amount of work.</p>
 <p>A further consideration is licensing.  Non-free parts, or parts
 that depend on non-free dependencies (especially plugins) should
 almost always be split if feasible.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
 <p>Global default options are listed in
 <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
 that should be built into every package if that option is supported.
 This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
 </h2></div></div></div>
 <p>The following example shows how
 <code class="filename">bsd.options.mk</code> should be used
 by the hypothetical ``wibble'' package, either in the package
 <code class="filename">Makefile</code>, or in a file,
 e.g. <code class="filename">options.mk</code>, that is included by the
 main package <code class="filename">Makefile</code>.</p>
 <pre class="programlisting">
 PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
 PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
 PKG_OPTIONS_OPTIONAL_GROUPS=    database
 PKG_OPTIONS_GROUP.database=     mysql pgsql
 PKG_SUGGESTED_OPTIONS=          wibble-foo
 PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
 PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
 .include "../../mk/bsd.prefs.mk"
 # this package was previously named wibble2
 .if defined(PKG_OPTIONS.wibble2)
 PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
 PKG_OPTIONS_DEPRECATED_WARNINGS+= \
         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
 .endif
 .include "../../mk/bsd.options.mk"
 # Package-specific option-handling
 ###
 ### FOO support
 ###
 .if !empty(PKG_OPTIONS:Mwibble-foo)
 CONFIGURE_ARGS+=    --enable-foo
 .endif
 ###
 ### LDAP support
 ###
 .if !empty(PKG_OPTIONS:Mldap)
 .  include "../../databases/openldap-client/buildlink3.mk"
 CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
 .endif
 ###
 ### database support
 ###
 .if !empty(PKG_OPTIONS:Mmysql)
 .  include "../../mk/mysql.buildlink3.mk"
 .endif
 .if !empty(PKG_OPTIONS:Mpgsql)
 .  include "../../mk/pgsql.buildlink3.mk"
 .endif
 </pre>
 <p>The first section contains the information about which build
 options are supported by the package, and any default options settings
 if needed.</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
 <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
 options.  It should be set to
 PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
 PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
 at the point where the options are processed.</p></li>
 <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
 build options supported by the package.</p></li>
 <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
 list of names of groups of mutually exclusive options.  The options in
 each group are listed in
 <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
 The most specific setting of any option from the group takes
 precedence over all other options in the group.  Options from the
 groups will be automatically added to
 <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
 <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
 <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
 packages will fail if no option from the group is
 selected.</p></li>
 <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
 of names of sets of options.  At least one option from each set must
 be selected.  The options in each set are listed in
 <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
 Options from the sets will be automatically added to
 <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
 fail if no option from the set is selected.</p></li>
 <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
 build options which are enabled by default.</p></li>
 <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
 of
 <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>
 pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
 their option counterparts.  Pairs should be added with
 <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
 warning will be issued if the user uses a legacy
 variable.</p></li>
 <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
 of
 <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>
 pairs that map options that have been renamed to their new
 counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
 the listing of global legacy options.  A warning will be issued if
 the user uses a legacy option.</p></li>
 <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
 options implied by deprecated variables used.  This can be used for
 cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
 <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
 <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
 <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
 a list of warnings about deprecated variables or options used, and
 what to use instead.</p></li>
 </ol></div>
 <p>A package should never modify
 <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
 <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
 To suggest a default set of options, use
 <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
 <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
 including <code class="filename">bsd.options.mk</code>.  If none of
 <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
 <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
 <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
 happen with platform-specific options if none of them is supported on
 the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
 empty list and the package is otherwise treated as not using the
 options framework.</p>
 <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
 variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
 build options, properly filtered to remove unsupported and duplicate
 options.</p>
 <p>The remaining sections contain the logic that is specific to
 each option.  The correct way to check for an option is to check
 whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
 <pre class="programlisting">
 .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
 </pre>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
 <p>Options that enable similar features in different packages (like
 optional support for a library) should use a common name in all
 packages that support it (like the name of the library).  If another
 package already has an option with the same meaning, use the same
 name.</p>
 <p>Options that enable features specific to one package, where it's
 unlikely that another (unrelated) package has the same (or a similar)
 optional feature, should use a name prefixed with
 <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
 <p>If a group of related packages share an optional feature
 specific to that group, prefix it with the name of the
 <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
 (e. g. <code class="varname">djbware-errno-hack</code>).</p>
 <p>For new options, add a line to
 <code class="filename">mk/defaults/options.description</code>.  Lines have two
 fields, separated by tab.  The first field is the option name, the
 second its description.  The description should be a whole sentence
 (starting with an uppercase letter and ending with a period) that
 @@ -6670,2039 +6670,2039 @@ details.
 	is enabled by default.</p>
 </li>
 <li class="listitem"><p><code class="varname">X11PREFIX</code> should be used to refer to
 	the installed location of an X11
 	package. <code class="varname">X11PREFIX</code> will be set to
 	<code class="varname">X11BASE</code> if xpkgwedge is not installed, and
 	to <code class="varname">LOCALBASE</code> if xpkgwedge is
 	installed.</p></li>
 <li class="listitem">
 <p>If xpkgwedge is installed, it is possible to have some
 	packages installed in <code class="varname">X11BASE</code> and some in
 	<code class="varname">LOCALBASE</code>.  To determine the prefix of an
 	installed package, the <code class="varname">EVAL_PREFIX</code>
 	definition can be used. It takes pairs in the format
 	<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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
 	variable <code class="varname">DIRNAME</code> will be set to the prefix
 	of the installed package &lt;package&gt;, or
 	<span class="quote">&#8220;<span class="quote">${X11PREFIX}</span>&#8221;</span> if the package is not
 	installed.</p>
 <p>This is best illustrated by example.</p>
 <p>The following lines are taken from
 	<code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
 <pre class="programlisting">
 EVAL_PREFIX+=           GTKDIR=gtk+
 CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
 CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
 CONFIGURE_ARGS+=        --enable-multibyte
 </pre>
 <p>Specific defaults can be defined for the packages
 	evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
 	definition of the form:</p>
 <pre class="programlisting">
 GTKDIR_DEFAULT= ${LOCALBASE}
 </pre>
 <p>where <code class="varname">GTKDIR</code> corresponds
 	to the first definition in
 	the <code class="varname">EVAL_PREFIX</code> pair.</p>
 </li>
 <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
 	install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
 	manual pages go into <code class="filename">${PREFIX}/man</code>, not
 	<code class="filename">${PREFIX}/share/man</code>.</p></li>
 </ul></div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
 <p>When building a package, various directories are used to store
     source files, temporary files, pkgsrc-internal files, and so on. These
     directories are explained here.</p>
 <p>Some of the directory variables contain relative pathnames. There
     are two common base directories for these relative directories:
     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
     inside the package itself.</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
 <dd><p>This is an absolute pathname that points to the pkgsrc
       root directory. Generally, you don't need
       it.</p></dd>
 <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
 <dd><p>This is an absolute pathname that points to the
       current package.</p></dd>
 <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
 <dd><p>This is a pathname relative to
       <code class="varname">PKGSRCDIR</code> that points to the current
       package.</p></dd>
 <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
 <dd><p>This is an absolute pathname pointing to the directory
       where all work takes place. The distfiles are extracted to this
       directory. It also contains temporary directories and log files used by
       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
 <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
 <dd><p>This is an absolute pathname pointing to the directory
       where the distfiles are extracted. It is usually a direct subdirectory
       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
       that isn't hidden. This variable may be changed by a package
       <code class="filename">Makefile</code>.</p></dd>
 </dl></div>
 <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
     If users would like to have their pkgsrc trees behave in a
     read-only manner, then the value of
     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
     <span class="emphasis"><em>no</em></span>.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
 <p>You can run a particular phase by typing <span class="command"><strong>make
     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
     phase. This will automatically run all phases that are required for this
     phase. The default phase is <code class="varname">build</code>, that is, when you
     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
     the package will be built, but not installed.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
 <p>The first step in building a package is to fetch the
     distribution files (distfiles) from the sites that are providing
     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
     phase.</p>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
 <p>In simple cases, <code class="varname">MASTER_SITES</code>
       defines all URLs from where the distfile, whose name is
       derived from the <code class="varname">DISTNAME</code> variable, is
       fetched. The more complicated cases are described
       below.</p>
 <p>The variable <code class="varname">DISTFILES</code> specifies
       the list of distfiles that have to be fetched. Its value
       defaults to <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
       so that most packages don't need to define it at all.
       <code class="varname">EXTRACT_SUFX</code> is
       <code class="literal">.tar.gz</code> by default, but can be changed
       freely. Note that if your package requires additional
       distfiles to the default one, you cannot just append the
       additional filenames using the <code class="literal">+=</code>
       operator, but you have write for example:</p>
 <pre class="programlisting">
 DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
 </pre>
 <p>Each distfile is fetched from a list of sites, usually
       <code class="varname">MASTER_SITES</code>. If the package has multiple
       <code class="varname">DISTFILES</code> or multiple
       <code class="varname">PATCHFILES</code> from different sites, you can
       set
       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
       to the list of URLs where the file
       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
       (including the suffix) can be found.</p>
 <pre class="programlisting">
 DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
 DISTFILES+=     foo-file.tar.gz
 SITES.foo-file.tar.gz= \
 http://www.somewhere.com/somehow/ \
 http://www.somewhereelse.com/mirror/somehow/
 </pre>
 <p>When actually fetching the distfiles, each item from
       <code class="varname">MASTER_SITES</code> or
       <code class="varname">SITES.*</code> gets the name of each distfile
       appended to it, without an intermediate slash. Therefore,
       all site values have to end with a slash or other separator
       character. This allows for example to set
       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
       that gets the name of the distfile as a parameter. In this
       case, the definition would look like:</p>
 <pre class="programlisting">
 MASTER_SITES=   http://www.example.com/download.cgi?file=
 </pre>
 <p> The exception to this rule are URLs starting with a dash.
       In that case the URL is taken as is, fetched and the result stored
       under the name of the distfile.</p>
 <p>There are some predefined values for
       <code class="varname">MASTER_SITES</code>, which can be used in
       packages.  The names of the variables should speak for
       themselves.</p>
 <pre class="programlisting">
 ${MASTER_SITE_APACHE}
 ${MASTER_SITE_BACKUP}
 ${MASTER_SITE_CYGWIN}
 ${MASTER_SITE_DEBIAN}
 ${MASTER_SITE_FREEBSD}
 ${MASTER_SITE_FREEBSD_LOCAL}
 ${MASTER_SITE_GENTOO}
 ${MASTER_SITE_GNOME}
 ${MASTER_SITE_GNU}
 ${MASTER_SITE_GNUSTEP}
 ${MASTER_SITE_IFARCHIVE}
 ${MASTER_SITE_KDE}
 ${MASTER_SITE_MOZILLA}
 ${MASTER_SITE_MYSQL}
 ${MASTER_SITE_OPENOFFICE}
 ${MASTER_SITE_PERL_CPAN}
 ${MASTER_SITE_PGSQL}
 ${MASTER_SITE_R_CRAN}
 ${MASTER_SITE_SOURCEFORGE}
 ${MASTER_SITE_SOURCEFORGE_JP}
 ${MASTER_SITE_SUNSITE}
 ${MASTER_SITE_SUSE}
 ${MASTER_SITE_TEX_CTAN}
 ${MASTER_SITE_XCONTRIB}
 ${MASTER_SITE_XEMACS}
 </pre>
 <p>Some explanations for the less self-explaining ones:
       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
       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
       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>
 <p>If you choose one of these predefined sites, you may
       want to specify a subdirectory of that site. Since these
       macros may expand to more than one actual site, you
       <span class="emphasis"><em>must</em></span> use the following construct to
       specify a subdirectory:</p>
 <pre class="programlisting">
 MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
 MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
 </pre>
 <p>Note the trailing slash after the subdirectory
       name.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
 <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
       all the distfiles exist in a local directory
       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
       user). If the files do not exist, they are fetched using
       commands of the form</p>
 <pre class="programlisting">
 ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
 </pre>
 <p>where <code class="literal">${site}</code> varies through
       several possibilities in turn: first,
       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
       sites specified in either <code class="varname">SITES.file</code> if
       defined, else <code class="varname">MASTER_SITES</code> or
       <code class="varname">PATCH_SITES</code>, as applies, then finally the
       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
       all except the first and the last can be optionally sorted
       by the user, via setting either
       <code class="varname">MASTER_SORT_RANDOM</code>, and
       <code class="varname">MASTER_SORT_AWK</code> or
       <code class="varname">MASTER_SORT_REGEX</code>.</p>
 <p> The specific command and arguments used depend on the
       <code class="varname">FETCH_USING</code> parameter. The example above is
       for <code class="literal">FETCH_USING=custom</code>.</p>
 <p>The distfiles mirror run by the NetBSD Foundation uses the
       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
       distfiles, if they are freely distributable.  Packages setting
       <code class="varname">NO_SRC_ON_FTP</code> (usually to
       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
       mirrored.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
 <p>After the distfile(s) are fetched, their checksum is
     generated and compared with the checksums stored in the
     distinfo file. If the checksums don't match, the build is
     aborted. This is to ensure the same distfile is used for
     building, and that the distfile wasn't changed, e.g. by some
     malign force, deliberately changed distfiles on the master
     distribution site or network lossage.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
 <p>When the distfiles are present on the local system, they
     need to be extracted, as they usually come in the form of some
     compressed archive format.</p>
 <p>By default, all <code class="varname">DISTFILES</code> are
     extracted. If you only need some of them, you can set the
     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
     files.</p>
 <p>Extracting the files is usually done by a little
     program, <code class="filename">mk/extract/extract</code>, which
     already knows how to extract various archive formats, so most
     likely you will not need to change anything here. But if you
     need, the following variables may help you:</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
 <dd><p>Use these variables to override the default
       options for an extract command, which are defined in
       <code class="filename">mk/extract/extract</code>.</p></dd>
 <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
 <dd><p>This variable can be set to
       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
       (which is the default value), <code class="literal">pax</code>, or an
       absolute pathname pointing to the command with which tar
       archives should be extracted.  It is preferred to choose bsdtar over gtar
       if NetBSD's pax-as-tar is not good enough.</p></dd>
 </dl></div>
 <p>If the <code class="filename">extract</code> program doesn't
     serve your needs, you can also override the
     <code class="varname">EXTRACT_CMD</code> variable, which holds the
     command used for extracting the files. This command is
     executed in the <code class="filename">${WRKSRC}</code>
     directory. During execution of this command, the shell
     variable <code class="varname">extract_file</code> holds the absolute
     pathname of the file that is going to be extracted.</p>
 <p>And if that still does not suffice, you can override the
     <code class="varname">do-extract</code> target in the package
     Makefile.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
 <p>After extraction, all the patches named by the
     <code class="varname">PATCHFILES</code>, those present in the patches
     subdirectory of the package as well as in
     $LOCALPATCHES/$PKGPATH (e.g.
     <code class="filename">/usr/local/patches/graphics/png</code>) are
     applied.  Patchfiles ending in <code class="filename">.Z</code> or
     <code class="filename">.gz</code> are uncompressed before they are
     applied, files ending in <code class="filename">.orig</code> or
     <code class="filename">.rej</code> are ignored. Any special options to
     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
     <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>
 <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
     it fail if the patches apply with some lines of fuzz. Please
     fix (regen) the patches so that they apply cleanly. The
     rationale behind this is that patches that don't apply cleanly
     may end up being applied in the wrong place, and cause severe
     harm there.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
 <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>.
     </p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
 <p>This phase creates wrapper programs for the compilers and
     linkers. The following variables can be used to tweak the
     wrappers.</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
 <dd><p>The command used to print progress
       messages. Does nothing by default. Set to
       <code class="literal">${ECHO}</code> to see the progress
       messages.</p></dd>
 <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
 <dd><p>This variable can be set to
       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
       depending on whether you want additional information in the
       wrapper log file.</p></dd>
 <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
 <dd><p>This variable can be set to
       <code class="literal">yes</code> or <code class="literal">no</code>, depending
       on whether the wrapper should use its cache, which will
       improve the speed. The default value is
       <code class="literal">yes</code>, but is forced to
       <code class="literal">no</code> if the platform does not support
       it.</p></dd>
 <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
 <dd><p>A list of reordering commands. A reordering
       command has the form
       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
       It ensures that that
       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
       </p></dd>
 <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
 <dd><p>A list of transformation commands. [TODO:
       investigate further]</p></dd>
 </dl></div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
 <p>Most pieces of software need information on the header
     files, system calls, and library routines which are available
     on the platform they run on. The process of determining this
     information is known as configuration, and is usually
     automated. In most cases, a script is supplied with the
     distfiles, and its invocation results in generation of header
     files, Makefiles, etc.</p>
 <p>If the package contains a configure script, this can be
     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
     script, you should set <code class="varname">GNU_CONFIGURE</code> to
     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
 <pre class="programlisting">
 .for d in ${CONFIGURE_DIRS}
         cd ${WRKSRC} \
         &amp;&amp; cd ${d} \
         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
 .endfor
 </pre>
 <p><code class="varname">CONFIGURE_DIRS</code> (default:
     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
     <code class="varname">WRKSRC</code>. In each of these directories, the
     configure script is run with the environment
     <code class="varname">CONFIGURE_ENV</code> and arguments
     <code class="varname">CONFIGURE_ARGS</code>. The variables
     <code class="varname">CONFIGURE_ENV</code>,
     <code class="varname">CONFIGURE_SCRIPT</code> (default:
     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
     package.</p>
 <p>If the program uses the Perl way of configuration (mainly Perl
     modules, but not only), i.e. a file called
     <code class="filename">Makefile.PL</code>, it should include
     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
 <p>If the program uses an <code class="filename">Imakefile</code>
     for configuration, the appropriate steps can be invoked by
     setting <code class="varname">USE_IMAKE</code> to
     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. (If you only want the package installed in
     <code class="varname">${X11PREFIX}</code> but xmkmf not being run, set
     <code class="varname">USE_X11BASE</code> instead.)  You can add variables to
     xmkmf's environment by adding them to the
     <code class="varname">SCRIPTS_ENV</code> variable.</p>
 <p>If the program uses <code class="filename">cmake</code>
     for configuration, the appropriate steps can be invoked by
     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
     You can add variables to cmake's environment by adding them to the
     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
     The top directory argument is given by the
     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
 <p>If there is no configure step at all, set
     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
 <p>For building a package, a rough equivalent of the
     following code is executed.</p>
 <pre class="programlisting">
 .for d in ${BUILD_DIRS}
         cd ${WRKSRC} \
         &amp;&amp; cd ${d} \
         &amp;&amp; env ${MAKE_ENV} \
             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                 -f ${MAKE_FILE} \
                 ${BUILD_TARGET}
 .endfor
 </pre>
 <p><code class="varname">BUILD_DIRS</code> (default:
     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
     <code class="varname">WRKSRC</code>. In each of these directories,
     <code class="varname">MAKE_PROGRAM</code> is run with the environment
     <code class="varname">MAKE_ENV</code> and arguments
     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
     <code class="varname">MAKE_ENV</code>,
     <code class="varname">BUILD_MAKE_FLAGS</code>,
     <code class="varname">MAKE_FILE</code> and
     <code class="varname">BUILD_TARGET</code> may all be changed by the
     package.</p>
 <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
     default value of <code class="varname">MAKE_FILE</code> is
     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
 <p>If there is no build step at all, set
     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
 <p>[TODO]</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
 <p>Once the build stage has completed, the final step is to
     install the software in public directories, so users can
     access the programs and files.</p>
 <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
     equivalent of the following code is executed. Additionally,
     before and after this code, much magic is performed to do
     consistency checks, registering the package, and so on.</p>
 <pre class="programlisting">
 .for d in ${INSTALL_DIRS}
         cd ${WRKSRC} \
         &amp;&amp; cd ${d} \
         &amp;&amp; env ${MAKE_ENV} \
             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                 -f ${MAKE_FILE} \
                 ${INSTALL_TARGET}
 .endfor
 </pre>
 <p>The variable's meanings are analogous to the ones in the
     <span class="emphasis"><em>build</em></span> phase.
     <code class="varname">INSTALL_DIRS</code> defaults to
     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
     defined.</p>
 <p>In the <span class="emphasis"><em>install</em></span> phase, the following
     variables are useful. They are all variations of the
     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
     permissions preset. <code class="varname">INSTALL</code> is the plain
     install command. The specialized variants, together with their
     intended use, are:</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
 <dd><p>directories that contain
       binaries</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
 <dd><p>directories that contain
       scripts</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
 <dd><p>directories that contain shared and static
       libraries</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
 <dd><p>directories that contain data
       files</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
 <dd><p>directories that contain man
       pages</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
 <dd><p>binaries that can be stripped from debugging
       symbols</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
 <dd><p>binaries that cannot be
       stripped</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
 <dd><p>game
       binaries</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
 <dd><p>shared and static
       libraries</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
 <dd><p>data files</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
 <dd><p>data files for
       games</p></dd>
 <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
 <dd><p>man pages</p></dd>
 </dl></div>
 <p>Some other variables are:</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
 <dd><p>A list of directories relative to
       <code class="varname">PREFIX</code> that are created by pkgsrc at the
       beginning of the <span class="emphasis"><em>install</em></span> phase.
       The package is supposed to create all needed directories itself
       before installing files to it and list all other directories here.
       </p></dd>
 </dl></div>
 <p>In the rare cases that a package shouldn't install anything,
     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
     mostly relevant for packages in the <code class="filename">regress</code>
     category.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
 <p>Once the install stage has completed, a binary package of
     the installed files can be built.  These binary packages can be
     used for quick installation without previous compilation, e.g. by
     the <span class="command"><strong>make bin-install</strong></span> or by using
     <span class="command"><strong>pkg_add</strong></span>.</p>
 <p>By default, the binary packages are created in
     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
     one for each category in the <code class="varname">CATEGORIES</code>
     variable.  <code class="varname">PACKAGES</code> defaults to
     <code class="filename">pkgsrc/packages</code>.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
 <p>Once you're finished with a package, you can clean the work
     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
     to clean the work directories of all dependencies too, use
     <span class="command"><strong>make clean-depends</strong></span>.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term">pre/post-*</span></dt>
 <dd><p>For any of the main targets described in the
 	  previous section, two auxiliary targets exist with
 	  <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
 	  prefix for the main target's name.  These targets are
 	  invoked before and after the main target is called,
 	  allowing extra configuration or installation steps be
 	  performed from a package's Makefile, for example, which
 	  a program's configure script or install target
 	  omitted.</p></dd>
 <dt><span class="term">do-*</span></dt>
 <dd><p>Should one of the main targets do the wrong thing,
 	  and should there be no variable to fix this, you can
 	  redefine it with the do-* target.  (Note that redefining
 	  the target itself instead of the do-* target is a bad
 	  idea, as the pre-* and post-* targets won't be called
 	  anymore, etc.) You will not usually need to do
 	  this.</p></dd>
 <dt><span class="term">reinstall</span></dt>
 <dd>
 <p>If you did a <span class="command"><strong>make install</strong></span> and
 	  you noticed some file was not installed properly, you
 	  can repeat the installation with this target, which will
 	  ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
 <p>This is the default value of
 	  <code class="varname">DEPENDS_TARGET</code> except in the case of
 	  <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
 	  package</strong></span>, where the defaults are
 	  <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
 	  respectively.</p>
 </dd>
 <dt><span class="term">deinstall</span></dt>
 <dd>
 <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
 	  current directory, effectively de-installing the
 	  package. The following variables can be used to tune the
 	  behaviour:</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
 <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
 <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
 <dd><p>Remove all packages that require (depend on)
 		the given package.  This can be used to remove any
 		packages that may have been pulled in by a given
 		package, e.g. if <span class="command"><strong>make deinstall
 		DEINSTALLDEPENDS=1</strong></span> is done in
 		<code class="filename">pkgsrc/x11/kde</code>, this is
 		likely to remove whole KDE. Works by adding
 		<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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
 		command line.</p></dd>
 </dl></div>
 </dd>
 <dt><span class="term">bin-install</span></dt>
 <dd><p>Install a binary package from local disk and via FTP
 	  from a list of sites (see the
 	  <code class="varname">BINPKG_SITES</code> variable), and do a
 	  <span class="command"><strong>make package</strong></span> if no binary package is
 	  available anywhere.  The arguments given to
 	  <span class="command"><strong>pkg_add</strong></span> can be set via
 	  <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
 	  operation, etc.</p></dd>
 <dt><span class="term">update</span></dt>
 <dd>
 <p>This target causes the current package to be
 	  updated to the latest version.  The package and all
 	  depending packages first get de-installed, then current
 	  versions of the corresponding packages get compiled and
 	  installed.  This is similar to manually noting which
 	  packages are currently installed, then performing a
 	  series of <span class="command"><strong>make deinstall</strong></span> and
 	  <span class="command"><strong>make install</strong></span> (or whatever
 	  <code class="varname">UPDATE_TARGET</code> is set to) for these
 	  packages.</p>
 <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
 	  resume package updating in case a previous <span class="command"><strong>make
 	  update</strong></span> was interrupted for some reason.
 	  However, in this case, make sure you don't call
 	  <span class="command"><strong>make clean</strong></span> or otherwise remove the
 	  list of dependent packages in <code class="varname">WRKDIR</code>.
 	  Otherwise, you lose the ability to automatically update
 	  the current package along with the dependent packages
 	  you have installed.</p>
 <p>Resuming an interrupted <span class="command"><strong>make
 	  update</strong></span> will only work as long as the package
 	  tree remains unchanged.  If the source code for one of
 	  the packages to be updated has been changed, resuming
 	  <span class="command"><strong>make update</strong></span> will most certainly
 	  fail!</p>
 <p>The following variables can be used either on the
 	  command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
 	  alter the behaviour of <span class="command"><strong>make
 	  update</strong></span>:</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
 <dd><p>Install target to recursively use for the
 		updated package and the dependent packages.
 		Defaults to <code class="varname">DEPENDS_TARGET</code> if
 		set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
 		<span class="command"><strong>make update</strong></span>.  Other good
 		targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
 		<span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
 		<span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
 		endless loop!</p></dd>
 <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
 <dd><p>Don't clean up after updating.  Useful if
 		you want to leave the work sources of the updated
 		packages around for inspection or other purposes.
 		Be sure you eventually clean up the source tree
 		(see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
 		or you may run into troubles with old source code
 		still lying around on your next
 		<span class="command"><strong>make</strong></span> or <span class="command"><strong>make
 		update</strong></span>.</p></dd>
 <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
 <dd><p>Deinstall each package before installing
 		(making <code class="varname">DEPENDS_TARGET</code>). This
 		may be necessary if the
 		<span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
 		called after interrupting a running <span class="command"><strong>make
 		update</strong></span>.</p></dd>
 <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
 <dd><p>Allows you to disable recursion and hardcode
 		the target for packages.  The default is
 		<span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
 		facilitating a recursive update of prerequisite
 		packages.  Only set
 		<code class="varname">DEPENDS_TARGET</code> if you want to
 		disable recursive updates. Use
 		<code class="varname">UPDATE_TARGET</code> instead to just
 		set a specific target for each package to be
 		installed during <span class="command"><strong>make update</strong></span>
 		(see above).</p></dd>
 </dl></div>
 </dd>
 <dt><span class="term">clean-update</span></dt>
 <dd>
 <p>Clean the source tree for all packages that would
 	  get updated if <span class="command"><strong>make update</strong></span> was called
 	  from the current directory.  This target should not be
 	  used if the current package (or any of its depending
 	  packages) have already been de-installed (e.g., after
 	  calling <span class="command"><strong>make update</strong></span>) or you may lose
 	  some packages you intended to update. As a rule of
 	  thumb: only use this target <span class="emphasis"><em>before</em></span>
 	  the first time you run <span class="command"><strong>make update</strong></span>
 	  and only if you have a dirty package tree (e.g., if you
 	  used <code class="varname">NOCLEAN</code>).</p>
 <p>If you are unsure about whether your tree is
 	  clean, you can either perform a <span class="command"><strong>make
 	  clean</strong></span> at the top of the tree, or use the
 	  following sequence of commands from the directory of the
 	  package you want to update (<span class="emphasis"><em>before</em></span>
 	  running <span class="command"><strong>make update</strong></span> for the first
 	  time, otherwise you lose all the packages you wanted to
 	  update!):</p>
 <pre class="screen">
 <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
 	  </pre>
 <p>The following variables can be used either on the
 	  command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
 	  <span class="command"><strong>make clean-update</strong></span>:</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
 <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
 		reconstruct the list of directories to update for
 		this package.  Only use this if <span class="command"><strong>make
 		update</strong></span> successfully installed all
 		packages you wanted to update.  Normally, this is
 		done automatically on <span class="command"><strong>make
 		update</strong></span>, but may have been suppressed by
 		the <code class="varname">NOCLEAN</code> variable (see
 		above).</p></dd>
 </dl></div>
 </dd>
 <dt><span class="term">replace</span></dt>
 <dd>
 <p>Update the installation of the current package.  This
 	  differs from update in that it does not replace dependent
 	  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
 	  target to work.</p>
 <p><span class="emphasis"><em>Be careful when using this
 	  target!</em></span> There are no guarantees that dependent
 	  packages will still work, in particular they will most
 	  certainly break if you <span class="command"><strong>make replace</strong></span> a
 	  library package whose shared library major version changed
 	  between your installed version and the new one.  For this
 	  reason, this target is not officially supported and only
 	  recommended for advanced users.</p>
 </dd>
 <dt><span class="term">info</span></dt>
 <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
 	  package. You can use this to check which version of a
 	  package is installed.</p></dd>
 <dt><span class="term">index</span></dt>
 <dd>
 <p>This is a top-level command, i.e. it should be used in
 	  the <code class="filename">pkgsrc</code> directory.  It creates a
 	  database of all packages in the local pkgsrc tree, including
 	  dependencies, comment, maintainer, and some other useful
 	  information.  Individual entries are created by running
 	  <span class="command"><strong>make describe</strong></span> in the packages'
 	  directories.  This index file is saved as
 	  <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
 	  verbose format by running <span class="command"><strong>make
 	  print-index</strong></span>.  You can search in it with
 	  <span class="command"><strong>make search
 	  key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
 	  extract a list of all packages that depend on a particular
 	  one by running <span class="command"><strong>make show-deps
 	  PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
 <p>Running this command takes a very long time, some
 	  hours even on fast machines!</p>
 </dd>
 <dt><span class="term">readme</span></dt>
 <dd>
 <p>This target generates a
 	  <code class="filename">README.html</code> file, which can be
 	  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
 	  contain references to any packages which are in the
 	  <code class="varname">PACKAGES</code> directory on the local
 	  host. The generated files can be made to refer to URLs
 	  based on <code class="varname">FTP_PKG_URL_HOST</code> and
 	  <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
 	  wanted to generate <code class="filename">README.html</code>
 	  files which pointed to binary packages on the local
 	  machine, in the directory
 	  <code class="filename">/usr/packages</code>, set
 	  <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
 	  <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
 	  <code class="varname">${PACKAGES}</code> directory and its
 	  subdirectories will be searched for all the binary
 	  packages.</p>
 <p>The target can be run at the toplevel or in category
 	  directories, in which case it descends recursively.</p>
 </dd>
 <dt><span class="term">readme-all</span></dt>
 <dd><p>This is a top-level command, run it in
 	  <code class="filename">pkgsrc</code>.  Use this target to create a
 	  file <code class="filename">README-all.html</code> which contains a
 	  list of all packages currently available in the NetBSD
 	  Packages Collection, together with the category they belong
 	  to and a short description. This file is compiled from the
 	  <code class="filename">pkgsrc/*/README.html</code> files, so be sure
 	  to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
 	  readme</strong></span>.</p></dd>
 <dt><span class="term">cdrom-readme</span></dt>
 <dd><p>This is very much the same as the
 	  <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
 	  used when generating a pkgsrc tree to be written to a
 	  CD-ROM.  This target also produces
 	  <code class="filename">README.html</code> files, and can be made
 	  to refer to URLs based on
 	  <code class="varname">CDROM_PKG_URL_HOST</code> and
 	  <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
 <dt><span class="term">show-distfiles</span></dt>
 <dd><p>This target shows which distfiles and patchfiles
 	  are needed to build the package
 	  (<code class="varname">ALLFILES</code>, which contains all
 	  <code class="varname">DISTFILES</code> and
 	  <code class="varname">PATCHFILES</code>, but not
 	  <code class="filename">patches/*</code>).</p></dd>
 <dt><span class="term">show-downlevel</span></dt>
 <dd><p>This target shows nothing if the package is not
 	  installed. If a version of this package is installed,
 	  but is not the version provided in this version of
 	  pkgsrc, then a warning message is displayed. This target
 	  can be used to show which of your installed packages are
 	  downlevel, and so the old versions can be deleted, and
 	  the current ones added.</p></dd>
 <dt><span class="term">show-pkgsrc-dir</span></dt>
 <dd><p>This target shows the directory in the pkgsrc
 	  hierarchy from which the package can be built and
 	  installed. This may not be the same directory as the one
 	  from which the package was installed. This target is
 	  intended to be used by people who may wish to upgrade
 	  many packages on a single host, and can be invoked from
 	  the top-level pkgsrc Makefile by using the
 	  <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
 <dt><span class="term">show-installed-depends</span></dt>
 <dd><p>This target shows which installed packages match
 	  the current package's <code class="varname">DEPENDS</code>. Useful
 	  if out of date dependencies are causing build
 	  problems.</p></dd>
 <dt><span class="term">check-shlibs</span></dt>
 <dd><p>After a package is installed, check all its
 	  binaries and (on ELF platforms) shared libraries to see
 	  if they find the shared libs they need.  Run by default
 	  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>
 <dt><span class="term">print-PLIST</span></dt>
 <dd>
 <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
 	  upgraded pkg, this prints out an attempt to generate a
 	  new <code class="filename">PLIST</code> from a <span class="command"><strong>find
 	  -newer work/.extract_done</strong></span>.  An attempt is made
 	  to care for shared libs etc., but it is
 	  <span class="emphasis"><em>strongly</em></span> recommended to review the
 	  result before putting it into
 	  <code class="filename">PLIST</code>. On upgrades, it's useful to
 	  diff the output of this command against an already
 	  existing <code class="filename">PLIST</code> file.</p>
 <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
 	  other methods that don't update file access times, be
 	  sure to add these files manually to your
 	  <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
 	  -newer</span>&#8221;</span> command used by this target won't catch
 	  them!</p>
 <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
 	  information on this target.</p>
 </dd>
 <dt><span class="term">bulk-package</span></dt>
 <dd>
 <p>Used to do bulk builds. If an appropriate binary
 	  package already exists, no action is taken. If not, this
 	  target will compile, install and package it (and its
 	  depends, if <code class="varname">PKG_DEPENDS</code> is set
 	  properly. See <a class="xref" href="#binary.configuration" title="7.3.1. Configuration">Section 7.3.1, &#8220;Configuration&#8221;</a>).
 	  After creating the binary package, the sources, the
 	  just-installed package and its required packages are
 	  removed, preserving free disk space.</p>
 <p><span class="emphasis"><em>Beware that this target may deinstall
 	  all packages installed on a system!</em></span></p>
 </dd>
 <dt><span class="term">bulk-install</span></dt>
 <dd>
 <p>Used during bulk-installs to install required
 	  packages. If an up-to-date binary package is available,
 	  it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
 	  <span class="command"><strong>make bulk-package</strong></span> will be executed,
 	  but the installed binary won't be removed.</p>
 <p>A binary package is considered
 	  <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
 	  <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>None of the package's files
 	      (<code class="filename">Makefile</code>, ...) were modified
 	      since it was built.</p></li>
 <li class="listitem"><p>None of the package's required (binary)
 	      packages were modified since it was built.</p></li>
 </ul></div>
 <p><span class="emphasis"><em>Beware that this target may deinstall
 	  all packages installed on a system!</em></span></p>
 </dd>
 </dl></div>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
 <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
 <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
 <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
 </dl>
 </div>
 <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
 by pkgsrc and also for individual packages to define what commands
 are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
 or for later run-time of an installed packaged (such as
 <code class="varname">DEPENDS</code>).
 If the native system provides an adequate tool, then in many cases, a pkgsrc
 package will not be used.</p>
 <p>When building a package, the replacement tools are
 made available in a directory (as symlinks or wrapper scripts)
 that is early in the executable search path. Just like the buildlink
 system, this helps with consistent builds.</p>
 <p>A tool may be needed to help build a specific package. For example,
 perl, GNU make (gmake) or yacc may be needed.</p>
 <p>Also a tool may be needed, for example, because the native system's supplied
 tool may be inefficient for building a package with pkgsrc.
 For example, a package may need GNU awk, bison (instead of
 yacc) or a better sed.</p>
 <p>The tools used by a package can be listed by running
 <span class="command"><strong>make show-tools</strong></span>.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
 <p>The default set of tools used by pkgsrc is defined in
 <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
 such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
 <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
 These can be seen by running:
 <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
 <p>If a package needs a specific program to build
 then the <code class="varname">USE_TOOLS</code> variable can be used
 to define the tools needed.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
 <p>In the following examples, the :run means that it is needed at
 run-time (and becomes a DEPENDS).
 The default is a build dependency which can be set with
 :build. (So in this example, it is the same as gmake:build
 and pkg-config:build.)</p>
 <pre class="programlisting">
 USE_TOOLS+=     gmake perl:run pkg-config
 </pre>
 <p>When using the tools framework, a
 <code class="varname">TOOLS_PATH.foo</code> variable is defined
 which contains the full path to the appropriate tool. For example,
 <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
 on Linux systems.</p>
 <p>If you always need a pkgsrc version of the
 tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
 </p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
 <p>When improving or porting pkgsrc to a new platform, have a look
 at (or create) the corresponding platform specific make file fragment under
 <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
 the name of the common tools. For example:</p>
 <pre class="programlisting">
 .if exists(/usr/bin/bzcat)
 TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
 .elif exists(/usr/bin/bzip2)
 TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
 .endif
 TOOLS_PLATFORM.true?=           true                    # shell builtin
 </pre>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
 <div class="qandaset">
-<a name="idm77762608"></a><dl>
+<a name="idm76234800"></a><dl>
 <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
 </dt>
 <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
 	tools?</a>
 </dt>
 <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
 	package is using while being built? I want to know whether it
 	uses sed or not.</a>
 </dt>
 </dl>
 <table border="0" style="width: 100%;">
 <colgroup>
 <col align="left" width="1%">
 <col>
 </colgroup>
 <tbody>
 <tr class="question">
 <td align="left" valign="top">
-<a name="tools.new"></a><a name="idm77762224"></a><p><b>18.4.1.</b></p>
+<a name="tools.new"></a><a name="idm76234416"></a><p><b>18.4.1.</b></p>
 </td>
 <td align="left" valign="top"><p>How do I add a new tool?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><p>TODO</p></td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="tools.listall"></a><a name="idm77761072"></a><p><b>18.4.2.</b></p>
+<a name="tools.listall"></a><a name="idm76233264"></a><p><b>18.4.2.</b></p>
 </td>
 <td align="left" valign="top"><p>How do I get a list of all available
 	tools?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><p>TODO</p></td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="tools.used"></a><a name="idm77760048"></a><p><b>18.4.3.</b></p>
+<a name="tools.used"></a><a name="idm76232240"></a><p><b>18.4.3.</b></p>
 </td>
 <td align="left" valign="top"><p>How can I get a list of all the tools that a
 	package is using while being built? I want to know whether it
 	uses sed or not.</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
 	to do it.)</p></td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#portability-of-packages">19.1.1. Portability of packages</a></span></dt>
 <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>
 <dt><span class="sect2"><a href="#user-interaction">19.1.3. User interaction</a></span></dt>
 <dt><span class="sect2"><a href="#handling-licenses">19.1.4. Handling licenses</a></span></dt>
 <dt><span class="sect2"><a href="#restricted-packages">19.1.5. Restricted packages</a></span></dt>
 <dt><span class="sect2"><a href="#dependencies">19.1.6. Handling dependencies</a></span></dt>
 <dt><span class="sect2"><a href="#conflicts">19.1.7. Handling conflicts with other packages</a></span></dt>
 <dt><span class="sect2"><a href="#not-building-packages">19.1.8. Packages that cannot or should not be built</a></span></dt>
 <dt><span class="sect2"><a href="#undeletable-packages">19.1.9. Packages which should not be deleted, once installed</a></span></dt>
 <dt><span class="sect2"><a href="#security-handling">19.1.10. Handling packages with security problems</a></span></dt>
 <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.11. How to handle incrementing versions when fixing an existing package</a></span></dt>
 <dt><span class="sect2"><a href="#fixes.subst">19.1.12. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
 </dl></dd>
 <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>
 <dd><dl>
 <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
 <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>
 </dl></dd>
 <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>
 <dd><dl>
 <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
 <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
 <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
 <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
 <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
 <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
 <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
 </dl></dd>
 <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>
 <dd><dl>
 <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
 <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
 <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>
 <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
 </dl></dd>
 <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>
 <dd><dl>
 <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
 <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
 <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
 <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
 <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
 <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
 <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
 <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
 <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
 <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
 <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
 <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
 <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
 <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
 <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
 <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
 <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
 <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
     emulation</a></span></dt>
 <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
 <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
 </dl>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="portability-of-packages"></a>19.1.1. Portability of packages</h3></div></div></div>
 <p>One appealing feature of pkgsrc is that it runs on many
     different platforms. As a result, it is important to ensure,
     where possible, that packages in pkgsrc are portable. This
     chapter mentions some particular details you should pay
     attention to while working on pkgsrc.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <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>
 </h3></div></div></div>
 <p>The pkgsrc user can configure pkgsrc by overriding several
     variables in the file pointed to by <code class="varname">MAKECONF</code>,
     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
     want to use those variables in the preprocessor directives of
     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
     <code class="literal">.for</code>), you need to include the file
     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
     loads the user preferences.</p>
 <p>But note that some variables may not be completely defined
     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
     included, as they may contain references to variables that are
     not yet defined. In shell commands this is no problem, since
     variables are actually macros, which are only expanded when they
     are used. But in the preprocessor directives mentioned above and
     in dependency lines (of the form <code class="literal">target:
     dependencies</code>) the variables are expanded at load
     time.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 <h3 class="title">Note</h3>
 <p>Currently there is no exhaustive list of all
     variables that tells you whether they can be used at load time
     or only at run time, but it is in preparation.</p>
 </div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="user-interaction"></a>19.1.3. User interaction</h3></div></div></div>
 <p>Occasionally, packages require interaction from the user,
     and this can be in a number of ways:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>When fetching the distfiles, some packages require user
 	interaction such as entering username/password or accepting a
 	license on a web page.</p></li>
 <li class="listitem"><p>When extracting the distfiles, some packages may ask for
 	passwords.</p></li>
 <li class="listitem"><p>help to configure the package before it is built</p></li>
 <li class="listitem"><p>help during the build process</p></li>
 <li class="listitem"><p>help during the installation of a package</p></li>
 </ul></div>
 <p>The <code class="varname">INTERACTIVE_STAGE</code> definition is
     provided to notify the pkgsrc mechanism of an interactive stage
     which will be needed, and this should be set in the package's
     <code class="filename">Makefile</code>, e.g.:</p>
 <pre class="programlisting">
 INTERACTIVE_STAGE=      build
     </pre>
 <p>Multiple interactive stages can be specified:</p>
 <pre class="programlisting">
 INTERACTIVE_STAGE=      configure install
     </pre>
 <p>The user can then decide to skip this package by setting the
     <code class="varname">BATCH</code> variable.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="handling-licenses"></a>19.1.4. Handling licenses</h3></div></div></div>
 <p>Authors of software can choose the licence under which
     software can be copied.  This is due to copyright law, and reasons
     for license choices are outside the scope of pkgsrc.  The pkgsrc
     system recognizes that there are a number of licenses which some
     users may find objectionable or difficult or impossible to comply
     with.  The Free Software Foundation has declared some licenses
     "Free", and the Open Source Initiative has a definition of "Open
     Source".  The pkgsrc system, as a policy choice, does not label
     packages which have licenses that are Free or Open Source.
     However, packages without a license meeting either of those tests
     are labeled with a license tag denoting the license.  Note that a
     package with no license to copy trivially does not meet either the
     Free or Open Source test.</p>
 <p>For packages which are not Free or Open Source, pkgsrc will
     not build the package unless the user has indicated to pkgsrc that
     packages with that particular license may be built.  Note that
     this documentation avoids the term "accepted the license".  The
     pkgsrc system is merely providing a mechanism to avoid
     accidentally building a package with a non-free license;
     judgement and responsibility remain with the user.  (Installation
     of binary packages are not currently subject to this mechanism;
     this is a bug.)</p>
 <p>One might want to only install packages with a BSD license,
     or the GPL, and not the other.  The free licenses are added to the
     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
     user can override the default by setting the
     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
     of "+=".  The licenses accepted by default are:
     </p>
 <pre class="programlisting">
 	apache-1.1 apache-2.0
 	arphic-public
 	artistic artistic-2.0
 	boost-license
 	cc-by-sa-v3.0
 	cc0-1.0-universal
 	cddl-1.0
 	cpl-1.0
 	epl-v1.0
 	gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
 	gnu-gpl-v1
 	gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
 	gnu-gpl-v3 gnu-lgpl-v3
 	ibm-public-license-1.0
 	ipafont
 	isc
 	lppl-1.3c
 	lucent
 	miros
 	mit
 	mpl-1.0 mpl-1.1 mpl-2.0
 	mplusfont
 	ofl-v1.0 ofl-v1.1
 	original-bsd modified-bsd 2-clause-bsd
 	php
 	png-license
 	postgresql-license
 	public-domain
 	python-software-foundation
 	qpl-v1.0
 	sgi-free-software-b-v2.0
 	sleepycat-public
 	unlicense
 	x11
 	zlib
 	zpl
     </pre>
 <p>
     </p>
 <p>The license tag mechanism is intended to address
     copyright-related issues surrounding building, installing and
     using a package, and not to address redistribution issues (see
     <code class="varname">RESTRICTED</code> and
     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
     Packages with redistribution restrictions should set these
     tags.</p>
 <p>Denoting that a package may be copied according to a
     particular license is done by placing the license in
     <code class="filename">pkgsrc/licenses</code> and setting the
     <code class="varname">LICENSE</code> variable to a string identifying the
     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>
 <pre class="programlisting">
 LICENSE=        xv-license
     </pre>
 <p>When trying to build, the user will get a notice that the
     package is covered by a license which has not been placed in the
     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
 <pre class="programlisting">
 <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
 ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
 ===&gt;     To view the license, enter "/usr/bin/make show-license".
 ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
 ===&gt;     ACCEPTABLE_LICENSES+=xv-license
 *** Error code 1
     </pre>
 <p>The license can be viewed with <span class="command"><strong>make
     show-license</strong></span>, and if the user so chooses, the line
     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
     convey to pkgsrc that it should not in the future fail because of
     that license:</p>
 <pre class="programlisting">
 ACCEPTABLE_LICENSES+=xv-license
     </pre>
 <p>When adding a package with a new license, the following steps
     are required:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
 <p>Check if the file can avoid the -license filename tag as described above by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.html" target="_top">Various Licenses and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name | Open Source Initiative</a>.  If this is the case, additionally add the license filename to:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
 <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
 <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
 </ul></div>
 <p>with the proper syntax as demonstrated in those files, respectively.</p>
 </li>
 <li class="listitem"><p>The license text should be added to <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known licenses can be seen in this directory.</p></li>
 </ol></div>
 <p>When the license changes (in a way other than formatting),
     please make sure that the new license has a different name (e.g.,
     append the version number if it exists, or the date).  Just
     because a user told pkgsrc to build programs under a previous
     version of a license does not mean that pkgsrc should build
     programs under the new licenses.  The higher-level point is that
     pkgsrc does not evaluate licenses for reasonableness; the only
     test is a mechanistic test of whether a particular text has been
     approved by either of two bodies.</p>
 <p>The use of <code class="varname">LICENSE=shareware</code>,
     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
     is deprecated because it does not crisply refer to a particular
     license text.  Another problem with such usage is that it does not
     enable a user to tell pkgsrc to proceed for a single package
     without also telling pkgsrc to proceed for all packages with that
     tag.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="restricted-packages"></a>19.1.5. Restricted packages</h3></div></div></div>
 <p>Some licenses restrict how software may be re-distributed.
     Because a license tag is required unless the package is Free or
     Open Source, all packages with restrictions should have license
     tags.  By declaring the restrictions, package tools can
     automatically refrain from e.g. placing binary packages on FTP
     sites.</p>
 <p>There are four restrictions that may be encoded, which are
     the cross product of sources (distfiles) and binaries not being
     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
     language in any license, and because non-Free licenses tend to be
     different from each other, pkgsrc adopts a definition of FTP and
     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
     should not be made available over the Internet at no charge.
     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
     made available on some kind of media, together with other source
     and binary packages, and which is sold for a distribution charge.
     </p>
 <p>In order to encode these restrictions, the package system
     defines five make variables that can be set to note these
     restrictions:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem">
 <p><code class="varname">RESTRICTED</code></p>
 <p>This variable should be set whenever a restriction
 	exists (regardless of its kind).  Set this variable to a
 	string containing the reason for the restriction.  It should
 	be understood that those wanting to understand the restriction
 	will have to read the license, and perhaps seek advice of
 	counsel.</p>
 </li>
 <li class="listitem">
 <p><code class="varname">NO_BIN_ON_CDROM</code></p>
 <p>Binaries may not be placed on CD-ROM containing other
 	binary packages, for which a distribution charge may be made.
 	In this case, set this variable to
 	<code class="varname">${RESTRICTED}</code>.</p>
 </li>
 <li class="listitem">
 <p><code class="varname">NO_BIN_ON_FTP</code></p>
 <p>Binaries may not made available on the Internet without
 	charge.  In this case, set this variable to
 	<code class="varname">${RESTRICTED}</code>.  If this variable is set,
 	binary packages will not be included on ftp.NetBSD.org.</p>
 </li>
 <li class="listitem">
 <p><code class="varname">NO_SRC_ON_CDROM</code></p>
 <p>Distfiles may not be placed on CD-ROM, together with
 	other distfiles, for which a fee may be charged.  In this
 	case, set this variable to <code class="varname">${RESTRICTED}</code>.
 	</p>
 </li>
 <li class="listitem">
 <p><code class="varname">NO_SRC_ON_FTP</code></p>
 <p>Distfiles may not made available via FTP at no charge.
 	In this case, set this variable to
 	<code class="varname">${RESTRICTED}</code>.  If this variable is set,
 	the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
 </li>
 </ul></div>
 <p>Please note that packages will to be removed from pkgsrc
     when the distfiles are not distributable and cannot be obtained
     for a period of one full quarter branch. Packages with manual /
     interactive fetch must have a maintainer and it is his/her
     responsibility to ensure this.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="dependencies"></a>19.1.6. Handling dependencies</h3></div></div></div>
 <p>Your package may depend on some other package being present
     - and there are various ways of expressing this dependency.
     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
     <code class="varname">DEPENDS</code> definitions, the
     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
     via <code class="filename">buildlink3.mk</code>, which is the preferred way
     to handle dependencies, and which uses the variables named above.
     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
 <p>The basic difference between the two variables is as
     follows: The <code class="varname">DEPENDS</code> definition registers
     that pre-requisite in the binary package so it will be pulled in
     when the binary package is later installed, whilst the
     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
     dependency that is only needed for building the package.</p>
 <p>This means that if you only need a package present whilst
     you are building, it should be noted as a
     <code class="varname">BUILD_DEPENDS</code>.</p>
 <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
     <code class="varname">DEPENDS</code> definition is:</p>
 <pre class="programlisting">
 &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
     </pre>
 <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
     may include any of the wildcard version numbers recognized by
     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
 <p>If your package needs another package's binaries or
 	libraries to build and run, and if that package has a
 	<code class="filename">buildlink3.mk</code> file available, use it:</p>
 <pre class="programlisting">
 .include "../../graphics/jpeg/buildlink3.mk"
 	</pre>
 </li>
 <li class="listitem">
 <p>If your package needs another package's binaries or
 	libraries only for building, and if that package has a
 	<code class="filename">buildlink3.mk</code> file available, use it:</p>
 <pre class="programlisting">
 .include "../../graphics/jpeg/buildlink3.mk"
 	</pre>
 <p>but set
 	<code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
 	to make it a build dependency only. This case is rather
 	rare.</p>
 </li>
 <li class="listitem">
 <p>If your package needs binaries from another package to build,
 	use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
 <pre class="programlisting">
 BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
 	</pre>
 </li>
 <li class="listitem"><p>If your package needs a library with which to link and
 	there is no <code class="filename">buildlink3.mk</code> file
 	available, create one. Using
 	<code class="varname">DEPENDS</code> won't be sufficient because the
 	include files and libraries will be hidden from the compiler.</p></li>
 <li class="listitem">
 <p>If your package needs some executable to be able to run
 	correctly and if there's no
 	<code class="filename">buildlink3.mk</code> file, this is specified
 	using the <code class="varname">DEPENDS</code> variable. The
 	<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
 	be able to execute the latex binary from the teTeX package
 	when it runs, and that is specified:</p>
 <pre class="programlisting">
 DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
 	</pre>
 </li>
 <li class="listitem">
 <p>You can use wildcards in package dependencies. Note that
 	such wildcard dependencies are retained when creating binary
 	packages. The dependency is checked when installing the binary
 	package and any package which matches the pattern will be
 	used. Wildcard dependencies should be used with care.</p>
 <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
 	<span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
 	such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
 	<span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
 <p>Wildcards can also be used to specify that a package
 	will only build against a certain minimum version of a
 	pre-requisite:</p>
 <pre class="programlisting">
 DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
 	</pre>
 <p>This means that the package will build using version 6.0
 	of ImageMagick or newer. Such a dependency may be warranted
 	if, for example, the command line options of an executable
 	have changed.</p>
 <p>If you need to depend on minimum versions of libraries,
 	see the buildlink section of the pkgsrc guide.</p>
 <p>For security fixes, please update the package
 	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
 	information.</p>
 </li>
 </ol></div>
 <p>If your package needs files from another package to build,
     add the relevant distribution files to
     <code class="varname">DISTFILES</code>, so they will be extracted
     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.
     (It relies on the jpeg sources being present in source form
     during the build.)</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="conflicts"></a>19.1.7. Handling conflicts with other packages</h3></div></div></div>
 <p>Your package may conflict with other packages a user might
     already have installed on his system, e.g. if your package
     installs the same set of files as another package in the pkgsrc
     tree.</p>
 <p>In this case you can set <code class="varname">CONFLICTS</code> to a
     space-separated list of packages (including version string) your
     package conflicts with.</p>
 <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>
     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>
     install the same shared library, thus you set in
     <code class="filename">pkgsrc/x11/Xaw3d/Makefile</code>:</p>
 <pre class="programlisting">
 CONFLICTS=      Xaw-Xpm-[0-9]*
     </pre>
 <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
 <pre class="programlisting">
 CONFLICTS=      Xaw3d-[0-9]*
     </pre>
 <p>Packages will automatically conflict with other packages
     with the name prefix and a different version
     string. <span class="quote">&#8220;<span class="quote">Xaw3d-1.5</span>&#8221;</span> e.g. will automatically
     conflict with the older version <span class="quote">&#8220;<span class="quote">Xaw3d-1.3</span>&#8221;</span>.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="not-building-packages"></a>19.1.8. Packages that cannot or should not be built</h3></div></div></div>
 <p>There are several reasons why a package might be
     instructed to not build under certain circumstances.  If the
     package builds and runs on most platforms, the exceptions
     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
     the package builds and runs on a small handful of platforms,
     set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
     (OS-version-platform) that can use glob-style
     wildcards.</p>
 <p>Some packages are tightly bound to a specific version of an
     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
     backwards compatible with other versions of the OS, and should be
     uploaded to a version specific directory on the FTP server.  Mark
     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
     the package system internals, but may be used in the
     future.</p>
 <p>If the package should be skipped (for example, because it
     provides functionality already provided by the system), set
     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
     the package should fail because some preconditions are not met,
     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
     message.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="undeletable-packages"></a>19.1.9. Packages which should not be deleted, once installed</h3></div></div></div>
 <p>To ensure that a package may not be deleted, once it has been
     installed, the <code class="varname">PKG_PRESERVE</code> definition should
     be set in the package Makefile. This will be carried into any
     binary package that is made from this pkgsrc entry. A
     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="security-handling"></a>19.1.10. Handling packages with security problems</h3></div></div></div>
 <p>When a vulnerability is found, this should be noted in
     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
     and after committing that file, ask pkgsrc-security@NetBSD.org to
     update the file on ftp.NetBSD.org.</p>
 <p>After fixing the vulnerability by a patch, its
     <code class="varname">PKGREVISION</code> should be increased (this is of
     course not necessary if the problem is fixed by using a newer
     release of the software), and the pattern in the
     pkg-vulnerabilities file must be updated.</p>
 <p>Also, if the fix should be applied to the stable pkgsrc
     branch, be sure to submit a pullup request!</p>
 <p>Binary packages already on ftp.NetBSD.org will be handled
     semi-automatically by a weekly cron job.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="bumping-pkgrevision"></a>19.1.11. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
 <p>When making fixes to an existing package it can be useful
     to change the version number in <code class="varname">PKGNAME</code>. To
     avoid conflicting with future versions by the original author, a
     <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
     on package versions by setting <code class="varname">PKGREVISION=1</code>
     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
 <pre class="programlisting">
 DISTNAME=       foo-17.42
 PKGREVISION=    9
     </pre>
 <p>will result in a <code class="varname">PKGNAME</code> of
     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
     <code class="varname">PKGNAME_NOREV</code>.</p>
 <p>When a new release of the package is released, the
     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
     minor release of the above package, things should be like:</p>
 <pre class="programlisting">
 DISTNAME=       foo-17.43
     </pre>
 <p><code class="varname">PKGREVISION</code> should be incremented for any
     non-trivial change in the resulting binary package.  Without a
     <code class="varname">PKGREVISION</code> bump, someone with the previous
     version installed has no way of knowing that their package is out
     of date.  Thus, changes without increasing
     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
     trivial that no reasonable person would want to upgrade", and this
     is the rough test for when increasing
     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
     changes that do not merit increasing
     <code class="varname">PKGREVISION</code> are:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
       or comments in Makefile.</p></li>
 <li class="listitem"><p>
       Changing build variables if the resulting binary package is the same.</p></li>
 <li class="listitem"><p>
       Changing <code class="filename">DESCR</code>.</p></li>
 <li class="listitem"><p>
       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
 </ul></div>
 <p>Examples of changes that do merit an increase to
     <code class="varname">PKGREVISION</code> include:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>
       Security fixes</p></li>
 <li class="listitem"><p>
       Changes or additions to a patch file</p></li>
 <li class="listitem"><p>
       Changes to the <code class="filename">PLIST</code></p></li>
 <li class="listitem"><p>A dependency is changed or renamed.</p></li>
 </ul></div>
 <p>PKGREVISION must also be incremented when dependencies have ABI
     changes.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="fixes.subst"></a>19.1.12. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
 <p>When you want to replace the same text in multiple files
     or when the replacement text varies, patches alone cannot help.
     This is where the SUBST framework comes in. It provides an
     easy-to-use interface for replacing text in files.
     Example:</p>
 <pre class="programlisting">
 SUBST_CLASSES+=                 fix-paths
 SUBST_STAGE.fix-paths=          pre-configure
 SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
 SUBST_FILES.fix-paths=          src/*.c
 SUBST_FILES.fix-paths+=         scripts/*.sh
 SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
 SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
     </pre>
 <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
     that are used to identify the different SUBST blocks that are
     defined. The SUBST framework is heavily used by pkgsrc, so it is
     important to always use the <code class="literal">+=</code> operator with
     this variable. Otherwise some substitutions may be
     skipped.</p>
 <p>The remaining variables of each SUBST block are
     parameterized with the identifier from the first line
     (<code class="literal">fix-paths</code> in this case.) They can be seen as
     parameters to a function call.</p>
 <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
     which the replacement will take place. All combinations of
     <code class="literal">pre-</code>, <code class="literal">do-</code> and
     <code class="literal">post-</code> together with a phase name are
     possible, though only few are actually used. Most commonly used
     are <code class="literal">post-patch</code> and
     <code class="literal">pre-configure</code>. Of these two,
     <code class="literal">pre-configure</code> should be preferred because
     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
     have the state after applying the patches but before making any
     other changes. This is especially useful when you are debugging
     a package in order to create new patches for it. Similarly,
     <code class="literal">post-build</code> is preferred over
     <code class="literal">pre-install</code>, because the install phase should
     generally be kept as simple as possible. When you use
     <code class="literal">post-build</code>, you have the same files in the
     working directory that will be installed later, so you can check
     if the substitution has succeeded.</p>
 <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
     that is printed just before the substitution is done.</p>
 <p><code class="varname">SUBST_FILES.*</code> is the list of shell
     globbing patterns that specifies the files in which the
     substitution will take place. The patterns are interpreted
     relatively to the <code class="varname">WRKSRC</code> directory.</p>
 <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
     command should be prefixed with <code class="literal">-e</code>, so that
     all SUBST blocks look uniform.</p>
 <p>There are some more variables, but they are so seldomly
     used that they are only documented in the
     <code class="filename">mk/subst.mk</code> file.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="fixes.fetch"></a>19.2. Fixing problems in the <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
 <p>If you need to download from a dynamic URL you can set
     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
     with the name of each file to download as an argument, expecting
     it to output the URL of the directory from which to download
     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
     example of this usage.</p>
 <p>If the download can't be automated, because the user must
     submit personal information to apply for a password, or must pay
     for the source, or whatever, you can set
     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
     displayed to the user before aborting the build. Example:</p>
 <pre class="programlisting">
 FETCH_MESSAGE=  "Please download the files"
 FETCH_MESSAGE+= "    "${DISTFILES:Q}
 FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
     </pre>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
 <p>Sometimes authors of a software package make some
     modifications after the software was released, and they put up a
     new distfile without changing the package's version number. If a
     package is already in pkgsrc at that time, the checksum will
     no longer match. The contents of the new distfile should be
     compared against the old one before changing anything, to make
     sure the distfile was really updated on purpose, and that
     no trojan horse or so crept in.
     Please mention that the distfiles were compared and what was found
     in your commit message.</p>
 <p>Then, the correct way to work around this is to
     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
     usually based on <code class="varname">PKGNAME_NOREV</code>. All
     <code class="varname">DISTFILES</code> and
     <code class="varname">PATCHFILES</code> for this package will be put in that
     subdirectory of the local distfiles directory.
     (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.)
     In case this
     happens more often, <code class="varname">PKGNAME</code> can be used (thus
     including the <code class="filename">nbX</code> suffix) or a date stamp
     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
 <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's name does not contain a version and the distfile is apt to change. In cases where the likelihood of this is very small, <code class="varname">DIST_SUBDIR</code> might not be required. Additionally, <code class="varname">DIST_SUBDIR</code> must not be removed unless the distfile name changes, even if a package is being moved or renamed.</p>
 <p>Do not forget regenerating the <code class="filename">distinfo</code> file
     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
     path in the filenames.
     Also, increase the PKGREVISION if the installed package is different.
     Furthermore, a mail to the package's authors seems appropriate
     telling them that changing distfiles after releases without
     changing the file names is not good practice.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="fixes.configure"></a>19.3. Fixing problems in the <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
 <p>pkgsrc supports many different machines, with different
     object formats like a.out and ELF, and varying abilities to do
     shared library and dynamic loading at all. To accompany this,
     varying commands and options have to be passed to the
     compiler, linker, etc. to get the Right Thing, which can be
     pretty annoying especially if you don't have all the machines
     at your hand to test things.  The
     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
     both static and dynamic libraries from a set of source files,
     thus being platform-independent.</p>
 <p>Here's how to use libtool in a package in seven simple
     steps:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
 	Makefile.</p></li>
 <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
 	${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
 	add it to the definition of <code class="varname">CC</code>, if only
 	libraries are being built in a given Makefile. This one command
 	will build both PIC and non-PIC library objects, so you need not
 	have separate shared and non-shared library rules.</p></li>
 <li class="listitem">
 <p>For the linking of the library, remove any
 	<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
 	-Bshareable</span>&#8221;</span> commands, and instead use:</p>
 <pre class="programlisting">
 ${LIBTOOL} --mode=link \
     ${CC} -o ${.TARGET:.a=.la} \
         ${OBJS:.o=.lo} \
         -rpath ${PREFIX}/lib \
         -version-info major:minor
 	</pre>
 <p>Note that the library is changed to have a
 	<code class="filename">.la</code> extension, and the objects are
 	changed to have a <code class="filename">.lo</code>
 	extension. Change <code class="varname">OBJS</code> as
 	necessary. This automatically creates all of the
 	<code class="filename">.a</code>,
 	<code class="filename">.so.major.minor</code>, and ELF symlinks (if
 	necessary) in the build directory. Be sure to include
 	<span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
 	minor are zero, as libtool will otherwise strip off the
 	shared library version.</p>
 <p>From the libtool manual:</p>
 <pre class="programlisting">
 So, libtool library versions are described by three integers:
 CURRENT
 The most recent interface number that this library implements.
 REVISION
 The implementation number of the CURRENT interface.
 AGE
 The difference between the newest and oldest interfaces that
 this library implements.  In other words, the library implements
 all the interface numbers in the range from number `CURRENT -
 AGE' to `CURRENT'.
 If two libraries have identical CURRENT and AGE numbers, then the
 dynamic linker chooses the library with the greater REVISION number.
 	</pre>
 <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
 	different results for a.out and ELF (excluding symlinks)
 	in only one case. An ELF library of the form
 	<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>
 	will have a symlink of
 	<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>
 	on an a.out platform. This is handled
 	automatically.</p>
 <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
 	directory of the library being built.</p>
 <p>In the <code class="filename">PLIST</code>, include only the
 	<code class="filename">.la</code> file, the other files will be
 	added automatically.</p>
 </li>
 <li class="listitem">
 <p>When linking shared object (<code class="filename">.so</code>)
 	files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
 	shared libraries, use <span class="quote">&#8220;<span class="quote">-module
 	-avoid-version</span>&#8221;</span> to prevent them getting version
 	tacked on.</p>
 <p>The <code class="filename">PLIST</code> file gets the
 	<code class="filename">foo.so</code> entry.</p>
 </li>
 <li class="listitem">
 <p>When linking programs that depend on these libraries
 	<span class="emphasis"><em>before</em></span> they are installed, preface
 	the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1+NetBSD-5.0.1+i386"><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-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
 	--mode=link</span>&#8221;</span>, and it will find the correct
 	libraries (static or shared), but please be aware that
 	libtool will not allow you to specify a relative path in
 	-L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
 	expects you to change that argument to be the
 	<code class="filename">.la</code> file. e.g.</p>
 <pre class="programlisting">
 ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
 	</pre>
 <p>should be changed to:</p>
 <pre class="programlisting">
 ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
 	</pre>
 <p>and it will do the right thing with the libraries.</p>
 </li>
 <li class="listitem">
 <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
 	or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
 	--mode=install</span>&#8221;</span>, and change the library name to
 	<code class="filename">.la</code>. e.g.</p>
 <pre class="programlisting">
 ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
 	</pre>
 <p>This will install the static <code class="filename">.a</code>,
 	shared library, any needed symlinks, and run
 	<a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
 </li>
 <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
 	the <code class="filename">.la</code>
 	file (this is a change from previous behaviour).</p></li>
 </ol></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
 <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
     package Makefile. This will override the package's own libtool
     in most cases.  For older libtool using packages,  libtool is
     made by ltconfig script during the do-configure step; you can
     check the libtool script location by doing <span class="command"><strong>make
     configure; find work*/ -name libtool</strong></span>.</p>
 <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
     package's libtool script(s), set it as appropriate.</p>
 <p>If you do not need <code class="filename">*.a</code> static
     libraries built and installed, then use
     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
 <p>If your package makes use of the platform-independent library
     for loading dynamic shared objects, that comes with libtool
     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
 <p>Some packages use libtool incorrectly so that the package
     may not work or build in some circumstances. Some of the more
     common errors are:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem">
 <p>The inclusion of a shared object (-module) as a dependent library in an
 	executable or library. This in itself isn't a problem if one of two things
 	has been done:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>The shared object is named correctly, i.e.
 	    <code class="filename">libfoo.la</code>, not
 	    <code class="filename">foo.la</code></p></li>
 <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
 </ol></div>
 </li>
 <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
 	The function lt_dlinit() should be called and the macro
 	<code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
 	executables.</p></li>
 </ul></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
 <p>If a package needs GNU autoconf or automake to be executed
     to regenerate the configure script and Makefile.in makefile
     templates, then they should be executed in a pre-configure
     target.</p>
 <p>For packages that need only autoconf:</p>
 <pre class="programlisting">
 AUTOCONF_REQD=  2.50            # if default version is not good enough
 USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
 ...
 pre-configure:
         cd ${WRKSRC} &amp;&amp; autoconf
 ...
     </pre>
 <p>and for packages that need automake and autoconf:</p>
 <pre class="programlisting">
 AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
 USE_TOOLS+=     automake        # use "automake14" for automake-1.4
 ...
 pre-configure:
         set -e; cd ${WRKSRC}; \
         aclocal; autoheader; automake -a --foreign -i; autoconf
 ...
     </pre>
 <p>Packages which use GNU Automake will almost certainly
     require GNU Make.</p>
 <p>There are times when the configure process makes
     additional changes to the generated files, which then causes
     the build process to try to re-execute the automake sequence.
     This is prevented by touching various files in the configure
     stage. If this causes problems with your package you can set
     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
     Makefile.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
 <p>Compilers for the C, C++, and Fortran languages comes with
     the NetBSD base system.  By default, pkgsrc assumes that a package
     is written in C and will hide all other compilers (via the wrapper
     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
 <p>To declare which language's compiler a package needs, set
     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
     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
     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
     written in C++, usually need a C compiler for the configure
     phase.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
 <p>If a program is written in Java, use the Java framework in
     pkgsrc.  The package must include
     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
     provides the following variables:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
       dependency on the JDK is added.  If
       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
       there is only a runtime dependency on the JDK.  The default is
       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
       JDK.</p></li>
 <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
       a package needs a Java2 implementation.  The supported values
       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
       <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
       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
       above. This variable is not set by default.</p></li>
 <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
       automatically set to the runtime location of the used Java
       implementation dependency. It may be used to set
       <code class="varname">JAVA_HOME</code> to a good value if the program
       needs this variable to be defined.
       </p></li>
 </ul></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
 <p>If your package contains interpreted perl scripts, add
     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
     that you want adjusted.  Every occurrence of
     <code class="filename">*/bin/perl</code> will be replaced with the full
     path to the perl executable.</p>
 @@ -8773,2222 +8773,2222 @@ pre-configure:
 /* BSD-specific code goes here */
 #else
 /* non-BSD-specific code goes here */
 #endif
 </pre>
 <p>If this distinction is not fine enough, you can also test
 	for the following macros.</p>
 <pre class="programlisting">
 Cygwin      __CYGWIN__
 DragonFly   __DragonFly__
 FreeBSD     __FreeBSD__
 Haiku       __HAIKU__
 Interix     __INTERIX
 IRIX        __sgi (TODO: get a definite source for this)
 Linux       linux, __linux, __linux__
 MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
 Minix3      __minix
 NetBSD      __NetBSD__
 OpenBSD     __OpenBSD__
 Solaris     sun, __sun
 </pre>
 </div>
 <div class="sect3">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
 <pre class="programlisting">
 i386        i386, __i386, __i386__
 MIPS        __mips
 SPARC       sparc, __sparc
 </pre>
 </div>
 <div class="sect3">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
 <pre class="programlisting">
 GCC         __GNUC__ (major version), __GNUC_MINOR__
 MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
 SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
 SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
 </pre>
 </div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
 <p>Some source files trigger bugs in the compiler, based on
         combinations of compiler version and architecture and almost
         always relation to optimisation being enabled.  Common symptoms
         are gcc internal errors or never finishing compiling a
 	file.</p>
 <p>Typically, a workaround involves testing the
         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
         optimisation for that combination of file,
 	<code class="varname">MACHINE_ARCH</code> and compiler, and documenting it
 	in <code class="filename">pkgsrc/doc/HACKS</code>. See that file for a
 	number of examples.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
 </h3></div></div></div>
 <p>This error message often means that a package did not
 	link to a shared library it needs. The following functions are
 	known to cause this error message over and over.</p>
 <div class="informaltable">
 <a name="undefined-reference-functions"></a><table border="1">
 <colgroup>
 <col>
 <col>
 <col>
 </colgroup>
 <thead><tr>
 <th>Function</th>
 <th>Library</th>
 <th>Affected platforms</th>
 </tr></thead>
 <tbody>
 <tr>
 <td>accept, bind, connect</td>
 <td>-lsocket</td>
 <td>Solaris</td>
 </tr>
 <tr>
 <td>crypt</td>
 <td>-lcrypt</td>
 <td>DragonFly, NetBSD</td>
 </tr>
 <tr>
 <td>dlopen, dlsym</td>
 <td>-ldl</td>
 <td>Linux</td>
 </tr>
 <tr>
 <td>gethost*</td>
 <td>-lnsl</td>
 <td>Solaris</td>
 </tr>
 <tr>
 <td>inet_aton</td>
 <td>-lresolv</td>
 <td>Solaris</td>
 </tr>
 <tr>
 <td>nanosleep, sem_*, timer_*</td>
 <td>-lrt</td>
 <td>Solaris</td>
 </tr>
 <tr>
 <td>openpty</td>
 <td>-lutil</td>
 <td>Linux</td>
 </tr>
 </tbody>
 </table>
 </div>
 <p>To fix these linker errors, it is often sufficient to say
     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
     -l<em class="replaceable"><code>foo</code></em></code> to the package
     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
     bmake</strong></span>.</p>
 <div class="sect3">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
 <p>When you are using the SunPro compiler, there is another
 possibility. That compiler cannot handle the following code:</p>
 <pre class="programlisting">
 extern int extern_func(int);
 static inline int
 inline_func(int x)
+{
         return extern_func(x);
+}
 int main(void)
+{
         return 0;
+}
 </pre>
 <p>It generates the code for <code class="function">inline_func</code> even if
 that function is never used. This code then refers to
 <code class="function">extern_func</code>, which can usually not be resolved. To
 solve this problem you can try to tell the package to disable inlining
 of functions.</p>
 </div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
 <p>Sometimes packages fail to build because the compiler runs
     into an operating system specific soft limit.  With the
     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
     to unlimit the resources.  Currently, the allowed values are
     <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).
     Setting this variable is similar to running the shell builtin
     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
     segment size or maximum stack size of a process, respectively, to
     their hard limits.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="fixes.install"></a>19.6. Fixing problems in the <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
 <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
     with some operating systems cannot create more than one
     directory at a time. As such, you should call
     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
 <pre class="programlisting">
 ${INSTALL_DATA_DIR} ${PREFIX}/dir1
 ${INSTALL_DATA_DIR} ${PREFIX}/dir2
     </pre>
 <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
     dir2</code></span>&#8221;</span> to the
     <code class="varname">INSTALLATION_DIRS</code> variable, which will
     automatically do the right thing.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
 <p>In general, documentation should be installed into
     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
     includes the version number of the package).</p>
 <p>Many modern packages using GNU autoconf allow to set the
     directory where HTML documentation is installed with the
     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
     is needed because otherwise the documentation ends up in
     <code class="filename">${PREFIX}/share/doc/html</code> or other
     places.</p>
 <p>An exception to the above is that library API documentation
     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
     browsers (devhelp) should be left at their default location, which
     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
     documentation can be recognized from files ending in
     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
     (It is also acceptable to install such files in
     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
     <code class="filename">.devhelp*</code> file must be directly in that
     directory then, no additional subdirectory level is allowed in
     this case. This is usually achieved by using
     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
     though.)</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
 <p>Certain packages, most of them in the games category, install
     a score file that allows all users on the system to record their
     highscores.  In order for this to work, the binaries need to be
     installed setgid and the score files owned by the appropriate
     group and/or owner (traditionally the "games" user/group).  Set
     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
     following variables, documented in more detail in
     <code class="filename">mk/defaults/mk.conf</code>, control this
     behaviour: <code class="varname">GAMEDATAMODE</code>,
     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.</p>
 <p>A package should therefore never hard code file ownership or
     access permissions but rely on <code class="varname">INSTALL_GAME</code> and
     <code class="varname">INSTALL_GAME_DATA</code> to set these
     correctly.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
 <p><code class="varname">DESTDIR</code> support means that a package
     installs into a staging directory, not the final location of the
     files. Then a binary package is created which can be used for
     installation as usual. There are two ways: Either the package must
     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
       set to <span class="quote">&#8220;<span class="quote">none</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>, or
       <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
       the inclusion.</p></li>
 <li class="listitem"><p>All installation operations have to be prefixed with
       <code class="filename">${DESTDIR}</code>.</p></li>
 <li class="listitem"><p>automake gets this DESTDIR mostly right
       automatically. Many manual rules and pre/post-install often are
       incorrect; fix them.</p></li>
 <li class="listitem"><p>If files are installed with special owner/group
       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
 <li class="listitem"><p>In general, packages should support
       <code class="varname">UNPRIVILEGED</code> to be able to use
       DESTDIR.</p></li>
 </ul></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
 <p>Your package may also contain scripts with hardcoded paths to
       other interpreters besides (or as well as) perl.  To correct the
       full pathname to the script interpreter, you need to set the
       following definitions in your <code class="filename">Makefile</code> (we
     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
 <pre class="programlisting">
 REPLACE_INTERPRETER+=   tcl
 REPLACE.tcl.old=        .*/bin/tclsh
 REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
 REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
 # relative to ${WRKSRC}, just as in REPLACE_PERL
     </pre>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 <h3 class="title">Note</h3>
 <p>Before March 2006, these variables were called
     <code class="varname">_REPLACE.*</code> and
     <code class="varname">_REPLACE_FILES.*</code>.</p>
 </div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
 <p>Makefiles of packages providing perl5 modules should include
     the Makefile fragment
     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
     <span class="command"><strong>do-configure</strong></span> target for the standard perl
     configuration for such modules as well as various hooks to tune
     this configuration.  See comments in this file for
     details.</p>
 <p>Perl5 modules will install into different places depending
     on the version of perl used during the build process.  To
     address this, pkgsrc will append lines to the
     <code class="filename">PLIST</code> corresponding to the files listed in
     the installed <code class="filename">.packlist</code> file generated by
     most perl5 modules.  This is invoked by defining
     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
     e.g.:</p>
 <pre class="programlisting">
 PERL5_PACKLIST= auto/Pg/.packlist
     </pre>
 <p>The perl5 config variables
     <code class="varname">installarchlib</code>,
     <code class="varname">installscript</code>,
     <code class="varname">installvendorbin</code>,
     <code class="varname">installvendorscript</code>,
     <code class="varname">installvendorarch</code>,
     <code class="varname">installvendorlib</code>,
     <code class="varname">installvendorman1dir</code>, and
     <code class="varname">installvendorman3dir</code> represent those
     locations in which components of perl5 modules may be installed,
     provided as variable with uppercase and prefixed with
     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
     and may be used by perl5 packages that don't have a packlist.
     These variables are also substituted for in the
     <code class="filename">PLIST</code> as uppercase prefixed with
     <code class="varname">PERL5_SUB_</code>.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
 <p>Some packages install info files or use the
     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
     commands.  <code class="varname">INFO_FILES</code> should be defined in
     the package Makefile so that <code class="filename">INSTALL</code> and
     <code class="filename">DEINSTALL</code> scripts will be generated to
     handle registration of the info files in the Info directory
     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
     files registration is either provided by the system, or by a
     special purpose package automatically added as dependency if
     needed.</p>
 <p><code class="varname">PKGINFODIR</code> is the directory under
     <code class="filename">${PREFIX}</code> where info files are primarily
     located. <code class="varname">PKGINFODIR</code> defaults to
     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
 <p>The info files for the package should be listed in the
     package <code class="filename">PLIST</code>; however any split info files
     need not be listed.</p>
 <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
     should be noted with the <code class="varname">TEXINFO_REQD</code>
     variable in the package <code class="filename">Makefile</code>. By
     default, a minimum version of 3.12 is required. If the system
     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
     does not match the required minimum, a build dependency on the
     <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
     be added automatically.</p>
 <p>The build and installation process of the software provided
     by the package should not use the
     <span class="command"><strong>install-info</strong></span> command as the registration of
     info files is the task of the package
     <code class="filename">INSTALL</code> script, and it must use the
     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
 <p>To achieve this goal, the pkgsrc infrastructure creates
     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
     in <code class="varname">PATH</code>.</p>
 <p>The script overriding <span class="command"><strong>install-info</strong></span> has
     no effect except the logging of a message. The script overriding
     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
 <p>All packages that install manual pages should install them
     into the same directory, so that there is one common place to look
     for them. In pkgsrc, this place is
     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
     should be used in packages. The default for
     <code class="varname">PKGMANDIR</code> is
     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 <h3 class="title">Note</h3>
 <p>The support for a custom <code class="varname">PKGMANDIR</code>
     is far from complete.</p>
 </div>
 <p>The <code class="filename">PLIST</code> files can just use
     <code class="filename">man/</code> as the top level directory for the man
     page file entries, and the pkgsrc framework will convert as
     needed. In all other places, the correct
     <code class="varname">PKGMANDIR</code> must be used.</p>
 <p>Packages that are
     configured with <code class="varname">GNU_CONFIGURE</code> set as
     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
     <code class="filename">./configure</code>
     --mandir switch to set where the man pages should be installed.
     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
 <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
     Or if the <code class="filename">./configure</code> script uses
     a non-standard use of --mandir, you can set
     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
 <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
     information on installation of compressed manual pages.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
 <p>If a package installs <code class="filename">.schemas</code> or
     <code class="filename">.entries</code> files, used by GConf,
     you need to take some extra steps to make sure they get registered
     in the database:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
 	instead of its <code class="filename">buildlink3.mk</code> file.  This
 	takes care of rebuilding the GConf database at installation and
 	deinstallation time, and tells the package where to install
 	GConf data files using some standard configure arguments.  It
 	also disallows any access to the database directly from the
 	package.</p></li>
 <li class="listitem"><p>Ensure that the package installs its
 	<code class="filename">.schemas</code> files under
 	<code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
 	installed under <code class="filename">${PREFIX}/etc</code>, you will
 	need to manually patch the package.</p></li>
 <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
 	directory, as they will be handled automatically.  See
 	<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>
 <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
 	your <code class="filename">Makefile</code> with a list of all
 	<code class="filename">.schemas</code> files installed by the package, if
 	any.  Names must not contain any directories in them.</p></li>
 <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
 	your <code class="filename">Makefile</code> with a
 	list of all <code class="filename">.entries</code> files installed by the
 	package, if any. Names must not contain any directories in
 	them.</p></li>
 </ol></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
 <p>If a package installs <code class="filename">.omf</code> files, used by
     scrollkeeper/rarian, you need to take some extra steps to make sure they
     get registered in the database:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Include
 	<code class="filename">../../mk/omf-scrollkeeper.mk</code>
 	instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
 	takes care of rebuilding the scrollkeeper database at
 	installation and deinstallation time, and disallows any access
 	to it directly from the package.</p></li>
 <li class="listitem"><p>Check the PLIST and remove any entries under the
 	<code class="filename">libdata/scrollkeeper</code> directory, as they
 	will be handled automatically.</p></li>
 <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
 	the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
 	print-PLIST</strong></span> does this automatically.)</p></li>
 </ol></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
 <p>If a package installs font files, you will need to rebuild
     the fonts database in the directory where they get installed at
     installation and deinstallation time.  This can be automatically
     done by using the pkginstall framework.</p>
 <p>You can list the directories where fonts are installed in the
     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
     variables, where <em class="replaceable"><code>type</code></em> can be one of
     <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>.
     Also make sure that the database file
     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
 <p>Note that you should not create new directories for fonts;
     instead use the standard ones to avoid that the user needs to
     manually configure his X server to find them.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
 <p>If a package installs GTK2 immodules or loaders, you need to
     take some extra steps to get them registered in the GTK2 database
     properly:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Include
       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
       <code class="filename">buildlink3.mk</code> file.  This takes care of
       rebuilding the database at installation and deinstallation time.</p></li>
 <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
       your package installs GTK2 immodules.</p></li>
 <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
       GTK2 loaders.</p></li>
 <li class="listitem">
 <p>Patch the package to not touch any of the GTK2
       databases directly.  These are:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
 <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
 </ul></div>
 </li>
 <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
       any entries under the <code class="filename">libdata/gtk-2.0</code>
       directory, as they will be handled automatically.</p></li>
 </ol></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
 <p>If a package installs SGML or XML data files that need to be
     registered in system-wide catalogs (like DTDs, sub-catalogs,
     etc.), you need to take some extra steps:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Include
 	<code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
 	your <code class="filename">Makefile</code>, which takes care of
 	registering those files in system-wide catalogs at
 	installation and deinstallation time.</p></li>
 <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
 	any SGML catalogs installed by the package.</p></li>
 <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
 	any XML catalogs installed by the package.</p></li>
 <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
 	to be added to the SGML catalog.  These come in groups of
 	three strings; see xmlcatmgr(1) for more information
 	(specifically, arguments recognized by the 'add' action).
 	Note that you will normally not use this variable.</p></li>
 <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
 	to be added to the XML catalog.  These come in groups of three
 	strings; see xmlcatmgr(1) for more information (specifically,
 	arguments recognized by the 'add' action).  Note that you will
 	normally not use this variable.</p></li>
 </ol></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
 <p>If a package provides extensions to the MIME database by
     installing <code class="filename">.xml</code> files inside
     <code class="filename">${PREFIX}/share/mime/packages</code>, you
     need to take some extra steps to ensure that the database is kept
     consistent with respect to these new files:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Include
 	<code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
 	(avoid using the <code class="filename">buildlink3.mk</code> file from
 	this same directory, which is reserved for inclusion from
 	other <code class="filename">buildlink3.mk</code> files).  It takes
 	care of rebuilding the MIME database at installation and
 	deinstallation time, and disallows any access to it directly
 	from the package.</p></li>
 <li class="listitem"><p>Check the PLIST and remove any entries under the
 	<code class="filename">share/mime</code> directory,
 	<span class="emphasis"><em>except</em></span> for files saved under
 	<code class="filename">share/mime/packages</code>.  The former are
 	handled automatically by
 	the update-mime-database program, but the latter are
 	package-dependent and must be removed by the package that
 	installed them in the first place.</p></li>
 <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
 	from the PLIST.  They will be handled by the shared-mime-info
 	package.</p></li>
 </ol></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
 <p>If a package uses intltool during its build, add
     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
     which forces it to use the intltool package provided by pkgsrc,
     instead of the one bundled with the distribution file.</p>
 <p>This tracks intltool's build-time dependencies and uses the
     latest available version; this way, the package benefits of any
     bug fixes that may have appeared since it was released.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
 <p>If a package contains a rc.d script, it won't be copied into
     the startup directory by default, but you can enable it, by adding
     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
     into <code class="filename">/etc/rc.d</code> when a package is installed, and
     it will automatically remove the scripts when the package is
     deinstalled.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
 <p>If a package installs TeX packages into the texmf tree,
     the <code class="filename">ls-R</code> database of the tree needs to be
     updated.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 <h3 class="title">Note</h3>
 <p>Except the main TeX packages such as kpathsea,
     packages should install files
     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
 </div>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Include
       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
       takes care of rebuilding the <code class="filename">ls-R</code>
       database at installation and deinstallation time.</p></li>
 <li class="listitem">
 <p>If your package installs files into a texmf
       tree other than the one
       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
       trees that need database update.</p>
 <p>If your package also installs font map files that need
       to be registered using <span class="command"><strong>updmap</strong></span>,
       include <code class="filename">../../print/tex-tetex/map.mk</code> and
       set <code class="varname">TEX_MAP_FILES</code> and/or
       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
       be run automatically at installation/deinstallation to
       enable/disable font map files for TeX output
       drivers.</p>
 </li>
 <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
       databases are included in <code class="filename">PLIST</code>, as
       they will be removed only by the kpathsea package.</p></li>
 </ol></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
     emulation</h3></div></div></div>
 <p>There are some packages that provide libraries and
     executables for running binaries from a one operating system
     on a different one (if the latter supports it).  One example
     is running Linux binaries on NetBSD.</p>
 <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>
     helps in extracting and packaging Linux rpm packages.</p>
 <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
     if all libraries for each installed executable can be found by
     the dynamic linker.  Since the standard dynamic linker is run,
     this fails for emulation packages, because the libraries used
     by the emulation are not in the standard directories.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
 <p>If a package installs images under the
     <code class="filename">share/icons/hicolor</code> and/or updates the
     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
     database, you need to take some extra steps to make sure that the
     shared theme directory is handled appropriately and that the cache
     database is rebuilt:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Include
 	<code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
 <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
 	entry that refers to the theme cache.</p></li>
 <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
 	  directories from the <code class="filename">share/icons/hicolor</code>
 	  hierarchy because they will be handled automatically.</p></li>
 </ol></div>
 <p>The best way to verify that the PLIST is correct with
       respect to the last two points is to regenerate it using
       <span class="command"><strong>make print-PLIST</strong></span>.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
 <p>If a package installs <code class="filename">.desktop</code> files
       under <code class="filename">share/applications</code> and these include
       MIME information (MimeType key), you need to take extra steps to
       ensure that they are registered into the MIME database:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Include
 	  <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
 <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
 	  <code class="filename">share/applications/mimeinfo.cache</code> file.
 	  It will be handled automatically.</p></li>
 </ol></div>
 <p>The best way to verify that the PLIST is correct with
       respect to the last point is to regenerate it using <span class="command"><strong>make
       print-PLIST</strong></span>.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
 <p>In some cases one does not have the time to solve a problem
   immediately. In this case, one can plainly mark a package as broken.  For
   this, one just sets the variable <code class="varname">BROKEN</code> to the
   reason why the package is broken (similar to the
   <code class="varname">RESTRICTED</code> variable).  A user trying to build
   the package will immediately be shown this message, and the build
   will not be even tried.</p>
 <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
   intervals.</p>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
 <p>To check out all the gotchas when building a package, here are
   the steps that I do in order to get a package working.  Please note
   this is basically the same as what was explained in the previous
   sections, only with some debugging aids.</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <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>
 <li class="listitem">
 <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>,
       create a directory for a new package, change into it, then run
       <span class="command"><strong>url2pkg</strong></span>:</p>
 <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>
 <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>
 <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
 </li>
 <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
 <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
 <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
 <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
       configure step to the package's
       <code class="filename">Makefile</code>.</p></li>
 <li class="listitem">
 <p>Make the package compile, doing multiple rounds of</p>
 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
 <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
 <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
 <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
 <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
 <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
 <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
 <p>Doing this step as non-root user will ensure that no files
       are modified that shouldn't be, especially during the build
       phase.  <span class="command"><strong>mkpatches</strong></span>,
       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
       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.</p>
 </li>
 <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
       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>
 <li class="listitem">
 <p>Generate a <code class="filename">PLIST</code>:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
 <p>You usually need to be <code class="username">root</code> to do
       this.  Look if there are any files left:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
 <p>If this reveals any files that are missing in
       <code class="filename">PLIST</code>, add them.</p>
 </li>
 <li class="listitem">
 <p>Now that the <code class="filename">PLIST</code> is OK, install the
       package again and make a binary package:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
 </li>
 <li class="listitem">
 <p>Delete the installed package:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
 </li>
 <li class="listitem">
 <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
       command, which shouldn't find anything now:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
 </li>
 <li class="listitem">
 <p>Reinstall the binary package:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
 </li>
 <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
 <li class="listitem">
 <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
       reports:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
 </li>
 <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>
 </ul></div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
 <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
 <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
 <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
 <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
 <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
 <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
 </dl>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
 <p>Our policy is that we accept binaries only from pkgsrc
 	developers to guarantee that the packages don't contain any
 	trojan horses etc. This is not to annoy anyone but rather to
 	protect our users! You're still free to put up your home-made
 	binary packages and tell the world where to get them. NetBSD
 	developers doing bulk builds and wanting to upload them please
 	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>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
 <p>First, check that your package is complete, compiles and
 	runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
 	document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
 	archive that contains all files that make up the package.
 	Finally, send this package to the pkgsrc bug tracking system,
 	either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
 	that, go to the web page
 	<a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
 	which contains some instructions and a link to a form where you
 	can submit packages.  The
 	<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
 	also available as a substitute for either of the above two tools.
 	</p>
 <p>In the form of the problem report, the category should be
 	<span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
 	and version number, and the description field should contain a
 	short description of your package (contents of the COMMENT
 	variable or DESCR file are OK). The uuencoded package data should
 	go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
 <p>If you want to submit several packages, please send a
 	separate PR for each one, it's easier for us to track things
 	that way.</p>
 <p>Alternatively, you can also import new packages into
 	pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
 	homepage at <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">http://pkgsrc-wip.sourceforge.net/</a>
 	for details.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
 <p>Please note all package additions, updates, moves, and
 	removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
 	important to keep this file up to date and conforming to the
 	existing format, because it will be used by scripts to
 	automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
 	sites. Additionally, check the
 	<code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
 	for the package you updated or removed, in case it was mentioned
 	there.</p>
 <p>When the <code class="varname">PKGREVISION</code> of a package is
 	bumped, the change should appear in
 	<code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
 	related or otherwise relevant. Mass bumps that result from a
 	dependency being updated should not be mentioned. In all other
 	cases it's the developer's decision.</p>
 <p>There is a make target that helps in creating proper
   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
   file is up-to-date (to avoid having to resolve conflicts later-on)
   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
   For new packages, or package moves or removals, set the
   <code class="varname">CTYPE</code> variable on the command line to "Added",
   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
   not the same as your NetBSD login name. The target also automatically
   removes possibly existing entries for the package in the
   <code class="filename">TODO</code> file. Don't forget to commit
   the changes, e.g. by using <span class="command"><strong>make changes-entry-commit</strong></span>!
   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
   makes the cvs commands use the main repository.
   </p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
 <p>This section is only of interest for pkgsrc developers with write
   access to the pkgsrc repository.</p>
 <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
 Start by adding the directory and then files in the directory. Don't
 forget to add the new package to the category's
 <code class="filename">Makefile</code>. Make sure you don't forget any files;
 you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
 <pre class="programlisting">
 <code class="prompt">$</code> cd .../pkgsrc/category
 <code class="prompt">$</code> cvs add pkgname
 <code class="prompt">$</code> cd pkgname
 <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
 <code class="prompt">$</code> cvs add patches/p*
 <code class="prompt">$</code> cvs status | less
 <code class="prompt">$</code> cvs commit
 <code class="prompt">$</code> cd ..
 <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
 <code class="prompt">$</code> cvs commit Makefile
 </pre>
 <p>The commit message of the initial import should include part of the
   <code class="filename">DESCR</code> file, so people reading the mailing lists know
   what the package is/does.</p>
 <p>Also mention the new package in
 <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
 <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
 much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
 <p>Please always put a concise, appropriate and relevant summary of the
   changes between old and new versions into the commit log when updating
   a package. There are various reasons for this:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
   or its information may be overwritten by newer information.</p></li>
 <li class="listitem"><p>Having the change information between old and new versions in our CVS
   repository is very useful for people who use either cvs or anoncvs.</p></li>
 <li class="listitem"><p>Having the change information between old and new versions in our CVS
   repository is very useful for people who read the pkgsrc-changes mailing
   list, so that they can make tactical decisions about when to upgrade
   the package.</p></li>
 </ul></div>
 <p>Please also recognize that, just because a new version of a package
   has been released, it should not automatically be upgraded in the CVS
   repository.  We prefer to be conservative in the packages that are
   included in pkgsrc - development or beta packages are not really the
   best thing for most places in which pkgsrc is used. Please use your
   judgement about what should go into pkgsrc, and bear in mind that
   stability is to be preferred above new and possibly untested features.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
 <p>Renaming packages is not recommended.</p>
 <p>When renaming packages, be sure to fix any references to old name
   in other Makefiles, options, buildlink files, etc.</p>
 <p>Also When renaming a package, please define
   <code class="varname">SUPERSEDES</code> to the package name and dewey version
   pattern(s) of the previous package name.
   This may be repeated for multiple renames.
   The new package would be an exact replacement.
 </p>
 <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
   not be an exact replacement but is a suggestion for the replaced
   functionality.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
 <p>It is preferred that packages are not renamed or moved, but if needed
   please follow these steps.
 </p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
 <li class="listitem">
 <p>Remove all CVS dirs.</p>
 <p>Alternatively to the first two steps you can also do:</p>
 <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>
 <p>and use that for further work.</p>
 </li>
 <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
 <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
 instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
 <li class="listitem"><p>In the modified package's Makefile, consider setting
 <code class="varname">PREV_PKGPATH</code> to the previous category/package
 pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
 for doing an update using pkgsrc building; for example, it can
 search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
 (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
 new <code class="varname">PKGPATH</code> for that moved package.  Note that
 it may have multiple matches, so the tool should also check on the
 <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
 probably has no value unless <code class="varname">SUPERSEDES</code> is not
 set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
 <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
 place.</p></li>
 <li class="listitem">
 <p>Check if any package depends on it:
 </p>
 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
 <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
 </li>
 <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
 <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
 <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
 <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
 <li class="listitem">
 <p>Commit the changed and removed files:</p>
 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
 <p>(and any packages from step 5, of course).</p>
 </li>
 </ol></div>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
 <p>This section contains the answers to questions that may
 	arise when you are writing a package. If you don't find your
 	question answered here, first have a look in the other chapters,
 	and if you still don't have the answer, ask on the
 	<code class="literal">pkgsrc-users</code> mailing list.</p>
 <div class="qandaset">
-<a name="idm77207344"></a><dl>
+<a name="idm77764400"></a><dl>
 <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
 	MAKEFLAGS, .MAKEFLAGS and
 	MAKE_FLAGS?</a>
 </dt>
 <dt>22.2. <a href="#devfaq.make">What is the difference between
 	MAKE, GMAKE and
 	MAKE_PROGRAM?</a>
 </dt>
 <dt>22.3. <a href="#devfaq.cc">What is the difference between
 	CC, PKG_CC and
 	PKGSRC_COMPILER?</a>
 </dt>
 <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
 	BUILDLINK_LDFLAGS,
 	BUILDLINK_LDADD and
 	BUILDLINK_LIBS?</a>
 </dt>
 <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
 	VARNAME=BUILDLINK_PREFIX.foo
 	say it's empty?</a>
 </dt>
 <dt>22.6. <a href="#devfaq.master_sites">What does
 	${MASTER_SITE_SOURCEFORGE:=package/} mean? I
 	don't understand the := inside
 	it.</a>
 </dt>
 <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
 	developers?</a>
 </dt>
 <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
 	documentation?</a>
 </dt>
 <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
 do?</a>
 </dt>
 </dl>
 <table border="0" style="width: 100%;">
 <colgroup>
 <col align="left" width="1%">
 <col>
 </colgroup>
 <tbody>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.makeflags"></a><a name="idm77206960"></a><p><b>22.1.</b></p>
+<a name="devfaq.makeflags"></a><a name="idm77764016"></a><p><b>22.1.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
 	<code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
 	<code class="varname">MAKE_FLAGS</code>?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
 	to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
 	<code class="varname">MAKE_FLAGS</code> are the flags that are passed to
 	the <code class="varname">MAKE_PROGRAM</code> when building the
 	package. [FIXME: What is .MAKEFLAGS for?]</p></td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.make"></a><a name="idm77202864"></a><p><b>22.2.</b></p>
+<a name="devfaq.make"></a><a name="idm77759920"></a><p><b>22.2.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
 	<code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
 	<code class="varname">MAKE_PROGRAM</code>?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
 	<a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
 	infrastructure. <code class="varname">GMAKE</code> is the path to GNU
 	Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
 	use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
 	Make program that is used for building the
 	package.</p></td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.cc"></a><a name="idm77198512"></a><p><b>22.3.</b></p>
+<a name="devfaq.cc"></a><a name="idm77755568"></a><p><b>22.3.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
 	<code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
 	<code class="varname">PKGSRC_COMPILER</code>?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
 	compiler, which can be configured by the pkgsrc user.
 	<code class="varname">PKG_CC</code> is the path to the compiler wrapper.
 	<code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
 	path to a compiler, but the type of compiler that should be
 	used. See <code class="filename">mk/compiler.mk</code> for more
 	information about the latter variable.</p></td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.bl3flags"></a><a name="idm77194288"></a><p><b>22.4.</b></p>
+<a name="devfaq.bl3flags"></a><a name="idm77751344"></a><p><b>22.4.</b></p>
 </td>
 <td align="left" valign="top"><p>What is the difference between
 	<code class="varname">BUILDLINK_LDFLAGS</code>,
 	<code class="varname">BUILDLINK_LDADD</code> and
 	<code class="varname">BUILDLINK_LIBS</code>?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><p>[FIXME]</p></td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.bl3prefix"></a><a name="idm77192112"></a><p><b>22.5.</b></p>
+<a name="devfaq.bl3prefix"></a><a name="idm77749168"></a><p><b>22.5.</b></p>
 </td>
 <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
 	VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
 	say it's empty?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><p>For optimization reasons, some variables are only
 	available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
 	<span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
 	<span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
 	command.</p></td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.master_sites"></a><a name="idm77189040"></a><p><b>22.6.</b></p>
+<a name="devfaq.master_sites"></a><a name="idm77746096"></a><p><b>22.6.</b></p>
 </td>
 <td align="left" valign="top"><p>What does
 	<code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
 	don't understand the <code class="literal">:=</code> inside
 	it.</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
 	assignment operator, like you might expect at first sight.
 	Instead, it is a degenerate form of
 	<code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
 	which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which you
 	may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
 	case of <code class="varname">MASTER_SITE_*</code>,
 	<em class="replaceable"><code>old_string</code></em> is the empty string and
 	<em class="replaceable"><code>new_string</code></em> is
 	<code class="literal">package/</code>. That's where the
 	<code class="literal">:</code> and the <code class="literal">=</code> fall
 	together.</p></td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.mailinglists"></a><a name="idm77172784"></a><p><b>22.7.</b></p>
+<a name="devfaq.mailinglists"></a><a name="idm77738032"></a><p><b>22.7.</b></p>
 </td>
 <td align="left" valign="top"><p>Which mailing lists are there for package
 	developers?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
 <dd><p>This is a list for technical discussions related
 	to pkgsrc development, e.g. soliciting feedback for changes to
 	pkgsrc infrastructure, proposed new features, questions related
 	to porting pkgsrc to a new platform, advice for maintaining a
 	package, patches that affect many packages, help requests moved
 	from pkgsrc-users when an infrastructure bug is found,
 	etc.</p></dd>
 <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
 <dd><p>All bug reports in category "pkg" sent with
 	<a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
 	directly; use one of the other mailing
 	lists.</p></dd>
 </dl></div></td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.documentation"></a><a name="idm77168944"></a><p><b>22.8.</b></p>
+<a name="devfaq.documentation"></a><a name="idm77734192"></a><p><b>22.8.</b></p>
 </td>
 <td align="left" valign="top"><p>Where is the pkgsrc
 	documentation?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top">
 <p>There are many places where you can find
 	documentation about pkgsrc:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>The pkgsrc guide (this document) is a collection
 	of chapters that explain large parts of pkgsrc, but some
 	chapters tend to be outdated. Which ones they are is hard to
 	say.</p></li>
 <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
 	about certain features, announcements of new parts of the pkgsrc
 	infrastructure and sometimes even announcements that a certain
 	feature has been marked as obsolete. The benefit here is that
 	each message has a date appended to it.</p></li>
 <li class="listitem"><p>Many of the files in the
 	<code class="filename">mk/</code> directory start with a comment that
 	describes the purpose of the file and how it can be used by the
 	pkgsrc user and package authors. An easy way to find this
 	documentation is to run <span class="command"><strong>bmake
 	help</strong></span>.</p></li>
 <li class="listitem"><p>The CVS log messages are a rich source of
 	information, but they tend to be highly abbreviated, especially
 	for actions that occur often. Some contain a detailed
 	description of what has changed, but they are geared towards the
 	other pkgsrc developers, not towards an average pkgsrc user.
 	They also only document <span class="emphasis"><em>changes</em></span>, so if you
 	don't know what has been before, these messages may not be worth
 	too much to you.</p></li>
 <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
 	documented</span>&#8221;</span>, that is the documentation exists only in the
 	mind of the developer who wrote the code. To get this
 	information, use the <span class="command"><strong>cvs annotate</strong></span> command
 	to see who has written it and ask on the
 	<code class="literal">tech-pkg</code> mailing list, so that others can
 	find your questions later (see above). To be sure that the
 	developer in charge reads the mail, you may CC him or
 	her.</p></li>
 </ul></div>
 </td>
 </tr>
 <tr class="question">
 <td align="left" valign="top">
-<a name="devfaq.too-much-time"></a><a name="idm77162416"></a><p><b>22.9.</b></p>
+<a name="devfaq.too-much-time"></a><a name="idm77727664"></a><p><b>22.9.</b></p>
 </td>
 <td align="left" valign="top"><p>I have a little time to kill.  What shall I
 do?</p></td>
 </tr>
 <tr class="answer">
 <td align="left" valign="top"></td>
 <td align="left" valign="top">
 <p>This is not really an FAQ yet, but here's the answer
 anyway.</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
     <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
     will tell you about newer versions of installed packages that are
     available, but not yet updated in pkgsrc.</p></li>
 <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
     &mdash; it contains a list of suggested new packages and a list of
     cleanups and enhancements for pkgsrc that would be nice to
     have.</p></li>
 <li class="listitem"><p>Review packages for which review was requested on
     the <a class="ulink" href="http://pkgsrc-wip.sourceforge.net/" target="_top">pkgsrc-wip</a> review
     mailing list.</p></li>
 </ul></div>
 </td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
 <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
 <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
 <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
 </dl>
 </div>
 <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
 site</a>:</p>
 <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
   environment, an intuitive and attractive desktop for users, and the
   GNOME development platform, an extensive framework for building
   applications that integrate into the rest of the desktop.</p></blockquote></div>
 <p>pkgsrc provides a seamless way to automatically build and install
 a complete GNOME environment <span class="emphasis"><em>under many different
 platforms</em></span>.  We can say with confidence that pkgsrc is one of
 the most advanced build and packaging systems for GNOME due to its
 included technologies buildlink3, the wrappers and tools framework and
 automatic configuration file management.  Lots of efforts are put into
 achieving a completely clean deinstallation of installed software
 components.</p>
 <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
 the above also means that great efforts are put into making GNOME work
 under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
 pkgsrc as its preferred packaging system, contributing lots of
 portability fixes to make GNOME build and install under it.</p>
 <p>This chapter is aimed at pkgsrc developers and other people
 interested in helping our GNOME porting and packaging efforts.  It
 provides instructions on how to manage the existing packages and some
 important information regarding their internals.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 <h3 class="title">We need your help!</h3>
 <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
   and GNOME and are willing to learn new exciting stuff, please jump
   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
   work</a> list!  There is still a long way to go to get a
   fully-functional GNOME desktop under NetBSD and we need your help to
   achieve it!</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
 <p>pkgsrc includes three GNOME-related meta packages:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <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
     the core GNOME desktop environment.  It only includes the necessary
     bits to get it to boot correctly, although it may lack important
     functionality for daily operation.  The idea behind this package is
     to let end users build their own configurations on top of this one,
     first installing this meta package to achieve a functional setup and
     then adding individual applications.</p></li>
 <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
     complete installation of the GNOME platform and desktop as defined
     by the GNOME project; this is based on the components distributed in
     the <code class="filename">platform/x.y/x.y.z/sources</code> and
     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
     official FTP server.  Developer-only tools found in those
     directories are not installed unless required by some other
     component to work properly.  Similarly, packages from the bindings
     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
     in unless required as a dependency for an end-user component.  This
     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>
 <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>:
     Installs all the tools required to build a GNOME component when
     fetched from the CVS repository.  These are required to let the
     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
 </ul></div>
 <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
 sorted in a way that eases updates: a package may depend on other
 packages listed before it but not on any listed after it.  It is very
 important to keep this order to ease updates so... <span class="emphasis"><em>do not
 change it to alphabetical sorting!</em></span></p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
 <p>Almost all GNOME applications are written in C and use a common
 set of tools as their build system.  Things get different with the new
 bindings to other languages (such as Python), but the following will
 give you a general idea on the minimum required tools:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem">
 <p>Almost all GNOME applications use the GNU Autotools as their
     build system.  As a general rule you will need to tell this to your
     package:</p>
 <pre class="programlisting">
 GNU_CONFIGURE=yes
 USE_LIBTOOL=yes
 USE_TOOLS+=gmake
 </pre>
 </li>
 <li class="listitem">
 <p>If the package uses pkg-config to detect dependencies, add this
     tool to the list of required utilities:</p>
 <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
 <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
     the end of the build process to ensure that you did not miss to
     specify any dependency in your package and that the version
     requirements are all correct.</p>
 </li>
 <li class="listitem"><p>If the package uses intltool, be sure to add
     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
     to handle dependencies and to force the package to use the latest
     available version.</p></li>
 <li class="listitem">
 <p>If the package uses gtk-doc (a documentation generation
     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
     tool is rather big and the distfile should come with pregenerated
     documentation anyway; if it does not, it is a bug that you ought to
     report.  For such packages you should disable gtk-doc (unless it is
     the default):</p>
 <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
 <p>The default location of installed HTML files
     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
     and should not be changed unless the package insists on installing
     them somewhere else.  Otherwise programs as
     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
     do that with an entry similar to:</p>
 <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
 </li>
 </ul></div>
 <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
 files under the installation prefix to maintain databases.  In this
 context, shared means that those exact same directories and files are
 used among several different packages, leading to conflicts in the
 <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
 handle the most common cases, so you have to forget about using
 <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
 omitting shared files from them.  If you find yourself doing those,
 <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
 <p>The following table lists the common situations that result in
 using shared directories or files.  For each of them, the appropriate
 solution is given.  After applying the solution be sure to
 <span class="emphasis"><em>regenerate the package's file list</em></span> with
 <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
 <div class="table">
 <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
 <div class="table-contents"><table summary="PLIST handling for GNOME packages" border="1">
 <colgroup>
 <col>
 <col>
 </colgroup>
 <thead><tr>
 <th>If the package...</th>
 <th>Then...</th>
 </tr></thead>
 <tbody>
 <tr>
 <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
 <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>
 </tr>
 <tr>
 <td>Installs icons under the
         <code class="filename">share/icons/hicolor</code> hierarchy or updates
         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
 <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>
 </tr>
 <tr>
 <td>Installs files under
         <code class="filename">share/mime/packages</code>.</td>
 <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>
 </tr>
 <tr>
 <td>Installs <code class="filename">.desktop</code> files under
         <code class="filename">share/applications</code> and these include MIME
         information.</td>
 <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>
 </tr>
 </tbody>
 </table></div>
 </div>
 <br class="table-break">
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
 <p>When seeing GNOME as a whole, there are two kinds of
 updates:</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term">Major update</span></dt>
 <dd>
 <p>Given that there is still a very long way for GNOME 3 (if it
       ever appears), we consider a major update one that goes from a
       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
       where <code class="literal">Y</code> is even and greater than
       <code class="literal">X</code>.  These are hard to achieve because they
       introduce lots of changes in the components' code and almost all
       GNOME distfiles are updated to newer versions.  Some of them can
       even break API and ABI compatibility with the previous major
       version series.  As a result, the update needs to be done all at
       once to minimize breakage.</p>
 <p>A major update typically consists of around 80 package
       updates and the addition of some new ones.</p>
 </dd>
 <dt><span class="term">Minor update</span></dt>
 <dd>
 <p>We consider a minor update one that goes from a
       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
       one where <code class="literal">Y</code> is greater than
       <code class="literal">X</code>.  These are easy to achieve because they do
       not update all GNOME components, can be done in an incremental way
       and do not break API nor ABI compatibility.</p>
 <p>A minor update typically consists of around 50 package
       updates, although the numbers here may vary a lot.</p>
 </dd>
 </dl></div>
 <p>In order to update the GNOME components in pkgsrc to a new stable
 release (either major or minor), the following steps should be
 followed:</p>
 <div class="orderedlist"><ol class="orderedlist" type="1">
 <li class="listitem">
 <p>Get a list of all the tarballs that form the new release by
     using the following commands.  These will leave the full list of the
     components' distfiles into the <code class="filename">list.txt</code>
     file:</p>
 <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
     awk '{ print $9 }' &gt;list.txt</code></strong>
 <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
 </li>
 <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
     bump their version to the release you are updating them to.  The
     three meta packages should be always consistent with versioning.
     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
     in them.</p></li>
 <li class="listitem">
 <p>For each meta package, update all its
     <code class="varname">DEPENDS</code> lines to match the latest versions as
     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
     newer version (even if found in the FTP) because the meta packages
     are supposed to list the exact versions that form a specific GNOME
     release.  Exceptions are permitted here if a newer version solves a
     serious issue in the overall desktop experience; these typically
     come in the form of a revision bump in pkgsrc, not in newer versions
     from the developers.</p>
 <p>Packages not listed in the <code class="filename">list.txt</code> file
     should be updated to the latest version available (if found in
     pkgsrc).  This is the case, for example, of the dependencies on the
     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>
 </li>
 <li class="listitem">
 <p>Generate a patch from the modified meta packages and extract the
     list of "new" lines.  This will provide you an outline on what
     packages need to be updated in pkgsrc and in what order:</p>
 <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>
 </li>
 <li class="listitem"><p>For major desktop updates it is recommended to zap all your
     installed packages and start over from scratch at this point.</p></li>
 <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
     of <code class="filename">todo.txt</code> and update the packages listed in
     it in order.  For major desktop updates none of these should be
     committed until the entire set is completed because there are chances
     of breaking not-yet-updated packages.</p></li>
 <li class="listitem"><p>Once the packages are up to date and working, commit them to
     the tree one by one with appropriate log messages.  At the end,
     commit the three meta package updates and all the corresponding
     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
     <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>
 </ol></div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
 <p>GNOME is a very big component in pkgsrc which approaches 100
 packages.  Please, it is very important that you always, always,
 <span class="strong"><strong>always</strong></span> feed back any portability
 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
 their attention on portability issues and to ensure that future versions
 can be built out-of-the box on NetBSD.  The less custom patches in
 pkgsrc, the easier further updates are.  Those developers in charge of
 issuing major GNOME updates will be grateful if you do that.</p>
 <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
 Bugzilla</a>.  Not all components use these to track bugs, but most
 of them do.  Do not be short on your reports: always provide detailed
 explanations of the current failure, how it can be improved to achieve
 maximum portability and, if at all possible, provide a patch against CVS
 head.  The more verbose you are, the higher chances of your patch being
 accepted.</p>
 <p>Also, please avoid using preprocessor magic to fix portability
 issues.  While the FreeBSD GNOME people are doing a great job in porting
 GNOME to their operating system, the official GNOME sources are now
 plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
 and similar macros.  This hurts portability.  Please see our patching
 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
 details.</p>
 </div>
 </div>
 </div>
 <div class="part">
 <div class="titlepage"><div><div><h1 class="title">
 <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
 <div class="partintro">
 <div></div>
 <p>This part of the guide deals with everything
 	from the infrastructure that is behind the interfaces described
 	in the developer's guide. A casual package maintainer should not
 	need anything from this part.</p>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
 <dd><dl>
 <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
 <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
 <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
 <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
 <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
 <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
 <dd><dl>
 <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>
 <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>
 </dl></dd>
 </dl></dd>
 <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
 <dd><dl>
 <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
 <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
 <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
 <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
 </dl></dd>
 </dl></dd>
 <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
 <dd><dl>
 <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
 <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
 </dl></dd>
 </dl>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
 <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
 <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
 <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
 <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
 <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
 </dl></dd>
 <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
 <dd><dl>
 <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>
 <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>
 </dl></dd>
 </dl>
 </div>
 <p>The pkgsrc infrastructure consists of many small Makefile
 	fragments. Each such fragment needs a properly specified
 	interface. This chapter explains how such an interface looks
 	like.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
 <p>Whenever a variable is defined in the pkgsrc
 	infrastructure, the location and the way of definition provide
 	much information about the intended use of that variable.
 	Additionally, more documentation may be found in a header
 	comment or in this pkgsrc guide.</p>
 <p>A special file is
 	<code class="filename">mk/defaults/mk.conf</code>, which lists all
 	variables that are intended to be user-defined. They are either
 	defined using the <code class="literal">?=</code> operator or they are
 	left undefined because defining them to anything would
 	effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
 	overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
 	file.</p>
 <p>Outside this file, the following conventions apply:
 	Variables that are defined using the <code class="literal">?=</code>
 	operator may be overridden by a package.</p>
 <p>Variables that are defined using the <code class="literal">=</code>
 	operator may be used read-only at run-time.</p>
 <p>Variables whose name starts with an underscore must not be
 	accessed outside the pkgsrc infrastructure at all. They may
 	change without further notice.</p>
 <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
 <h3 class="title">Note</h3>
 <p>These conventions are currently not applied
 	consistently to the complete pkgsrc
 	infrastructure.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
 <p>All variables that contain lists of things should default
 	to being empty. Two examples that do not follow this rule are
 	<code class="varname">USE_LANGUAGES</code> and
 	<code class="varname">DISTFILES</code>. These variables cannot simply be
 	modified using the <code class="literal">+=</code> operator in package
 	<code class="filename">Makefile</code>s (or other files included by
 	them), since there is no guarantee whether the variable is
 	already set or not, and what its value is. In the case of
 	<code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
 	the default value and just define it as in the following
 	example.</p>
 <pre class="programlisting">
 DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
 </pre>
 <p>Because of the selection of this default value, the same
 	value appears in many package Makefiles. Similarly for
 	<code class="varname">USE_LANGUAGES</code>, but in this case the default
 	value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
 	doesn't stand out. Nevertheless it is mentioned in many
 	files.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
 <p>Variable evaluation takes place either at load time or at
 	runtime, depending on the context in which they occur. The
 	contexts where variables are evaluated at load time are:</p>
 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
 <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
 	and <code class="literal">!=</code> operators,</p></li>
 <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
 	<code class="literal">.for</code>,</p></li>
 <li class="listitem"><p>Dependency lines.</p></li>
 </ul></div>
 <p>A special exception are references to the iteration
 	variables of <code class="literal">.for</code> loops, which are expanded
 	inline, no matter in which context they appear.</p>
 <p>As the values of variables may change during load time,
 	care must be taken not to evaluate them by accident. Typical
 	examples for variables that should not be evaluated at load time
 	are <code class="varname">DEPENDS</code> and
 	<code class="varname">CONFIGURE_ARGS</code>. To make the effect more
 	clear, here is an example:</p>
 <pre class="programlisting">
 CONFIGURE_ARGS=         # none
 CFLAGS=                 -O
 CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
 CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
 CFLAGS+=                -Wall
 	</pre>
 <p>This code shows how the use of the <code class="literal">:=</code>
 	operator can quickly lead to unexpected results. The first
 	paragraph is fairly common code. The second paragraph evaluates
 	the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
 	<code class="literal">CFLAGS=-O</code>. In the third paragraph, the
 	<code class="literal">-Wall</code> is appended to the
 	<code class="varname">CFLAGS</code>, but this addition will not appear in
 	<code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
 	paragraphs from above typically occur in completely unrelated
 	files.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
 <p>After all the files have been loaded, the values of the
 	variables cannot be changed anymore. Variables that are used in
 	the shell commands are expanded at this point.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
 <p>There are many ways in which the definition and use of a
 	variable can be restricted in order to detect bugs and
 	violations of the (mostly unwritten) policies. See the
 	<code class="literal">pkglint</code> developer's documentation for further
 	details.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
 <p>Most of the <code class="filename">.mk</code> files fall into one
 	of the following classes. Cases where a file falls into more
 	than one class should be avoided as it often leads to subtle
 	bugs.</p>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
 <p>In a traditional imperative programming language some of
 	the <code class="filename">.mk</code> files could be described as
 	procedures. They take some input parameters and&mdash;after
 	inclusion&mdash;provide a result in output parameters. Since all
 	variables in <code class="filename">Makefile</code>s have global scope
 	care must be taken not to use parameter names that have already
 	another meaning. For example, <code class="varname">PKGNAME</code> is a
 	bad choice for a parameter name.</p>
 <p>Procedures are completely evaluated at preprocessing time.
 	That is, when calling a procedure all input parameters must be
 	completely resolvable. For example,
 	<code class="varname">CONFIGURE_ARGS</code> should never be an input
 	parameter since it is very likely that further text will be
 	added after calling the procedure, which would effectively apply
 	the procedure to only a part of the variable. Also, references
 	to other variables wit will be modified after calling the
 	procedure.</p>
 <p>A procedure can declare its output parameters either as
 	suitable for use in preprocessing directives or as only
 	available at runtime. The latter alternative is for variables
 	that contain references to other runtime variables.</p>
 <p>Procedures shall be written such that it is possible to
 	call the procedure more than once. That is, the file must not
 	contain multiple-inclusion guards.</p>
 <p>Examples for procedures are
 	<code class="filename">mk/bsd.options.mk</code> and
 	<code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
 	that the parameters are evaluated at load time, they should be
 	assigned using the <code class="literal">:=</code> operator, which should
 	be used only for this purpose.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
 <p>Action files take some input parameters and may define
 	runtime variables. They shall not define loadtime variables.
 	There are action files that are included implicitly by the
 	pkgsrc infrastructure, while other must be included
 	explicitly.</p>
 <p>An example for action files is
 	<code class="filename">mk/subst.mk</code>.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
 <p>Package <code class="filename">Makefile</code>s usually consist of
 	a set of variable definitions, and include the file
 	<code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
 	Before that, they may also include various other
 	<code class="filename">*.mk</code> files if they need to query the
 	availability of certain features like the type of compiler or
 	the X11 implementation. Due to the heavy use of preprocessor
 	directives like <code class="literal">.if</code> and
 	<code class="literal">.for</code>, the order in which the files are loaded
 	matters.</p>
 <p>This section describes at which point the various files
 	are loaded and gives reasons for that order.</p>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
 </h3></div></div></div>
 <p>The very first action in <code class="filename">bsd.prefs.mk</code>
 	is to define some essential variables like
 	<code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
 	<code class="varname">MACHINE_ARCH</code>.</p>
 <p>Then, the user settings are loaded from the file specified
 	in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
 	After that, those variables
 	that have not been overridden by the user are loaded from
 	<code class="filename">mk/defaults/mk.conf</code>.</p>
 <p>After the user settings, the system settings and platform
 	settings are loaded, which may override the user
 	settings.</p>
 <p>Then, the tool definitions are loaded. The tool wrappers
 	are not yet in effect. This only happens when building a
 	package, so the proper variables must be used instead of the
 	direct tool names.</p>
 <p>As the last steps, some essential variables from the
 	wrapper and the package system flavor are loaded, as well as the
 	variables that have been cached in earlier phases of a package
 	build.</p>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
 </h3></div></div></div>
 <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
 <p>Then, the various <code class="filename">*-vars.mk</code> files are
 	loaded, which fill default values for those variables that have
 	not been defined by the package. These variables may later
 	be used even in unrelated files.</p>
 <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
 	provides the target <code class="literal">error-check</code> that is added
 	as a special dependency to all other targets that use
 	<code class="varname">DELAYED_ERROR_MSG</code> or
 	<code class="varname">DELAYED_WARNING_MSG</code>.</p>
 <p>Then, the package-specific hacks from
 	<code class="filename">hacks.mk</code> are included.</p>
 <p>Then, various other files follow. Most of them don't have
 	any dependencies on what they need to have included before or
 	after them, though some do.</p>
 <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
 	<code class="varname">PKG_SKIP_REASON</code> is then executed, which
 	restricts the use of these variables to all the files that have
 	been included before. Appearances in later files will be
 	silently ignored.</p>
 <p>Then, the files for the main targets are included, in the
 	order of later execution, though the actual order should not
 	matter.</p>
 <p>At last, some more files are included that don't set any
 	interesting variables but rather just define make targets to be
 	executed.</p>
 </div>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#regression.descr">25.1. The regression tests framework</a></span></dt>
 <dt><span class="sect1"><a href="#regression.run">25.2. Running the regression tests</a></span></dt>
 <dt><span class="sect1"><a href="#regression.new">25.3. Adding a new regression test</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#regression.fun.override">25.3.1. Overridable functions</a></span></dt>
 <dt><span class="sect2"><a href="#regression.fun.helper">25.3.2. Helper functions</a></span></dt>
 </dl></dd>
 </dl>
 </div>
 <p>The pkgsrc infrastructure consists of a large codebase,
 	and there are many corners where every little bit of a file is
 	well thought out, making pkgsrc likely to fail as soon as
 	anything is changed near those parts. To prevent most changes
 	from breaking anything, a suite of regression tests should go
 	along with every important part of the pkgsrc infrastructure.
 	This chapter describes how regression tests work in pkgsrc and
 	how you can add new tests.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="regression.descr"></a>25.1. The regression tests framework</h2></div></div></div>
 <p></p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="regression.run"></a>25.2. Running the regression tests</h2></div></div></div>
 <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
 	provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
 	can simply run that command, which will run all tests in the
 	<code class="filename">regress</code> category.</p>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="regression.new"></a>25.3. Adding a new regression test</h2></div></div></div>
 <p>Every directory in the <code class="filename">regress</code>
 	category that contains a file called <code class="filename">spec</code>
 	is considered a regression test. This file is a shell program
 	that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
 	The following functions can be overridden to suit your
 	needs.</p>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="regression.fun.override"></a>25.3.1. Overridable functions</h3></div></div></div>
 <p>These functions do not take any parameters. They are all
 	called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, so you should be careful
 	to check the exitcodes of any commands you run in the
 	test.</p>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">do_setup()</code></span></dt>
 <dd><p>This function prepares the environment for the
 	test. By default it does nothing.</p></dd>
 <dt><span class="term"><code class="varname">do_test()</code></span></dt>
 <dd><p>This function runs the actual test. By default,
 	it calls <code class="varname">TEST_MAKE</code> with the arguments
 	<code class="varname">MAKEARGS_TEST</code> and writes its output including
 	error messages into the file
 	<code class="varname">TEST_OUTFILE</code>.</p></dd>
 <dt><span class="term"><code class="varname">check_result()</code></span></dt>
 <dd><p>This function is run after the test and is
 	typically used to compare the actual output from the one that is
 	expected. It can make use of the various helper functions from
 	the next section.</p></dd>
 <dt><span class="term"><code class="varname">do_cleanup()</code></span></dt>
 <dd><p>This function cleans everything up after the
 	test has been run. By default it does nothing.</p></dd>
 </dl></div>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="regression.fun.helper"></a>25.3.2. Helper functions</h3></div></div></div>
 <div class="variablelist"><dl class="variablelist">
 <dt><span class="term"><code class="varname">exit_status(expected)</code></span></dt>
 <dd><p>This function compares the exitcode of the
 	<span class="command"><strong>do_test()</strong></span> function with its first parameter.
 	If they differ, the test will fail.</p></dd>
 <dt><span class="term"><code class="varname">output_require(regex...)</code></span></dt>
 <dd><p>This function checks for each of its parameters
 	if the output from <span class="command"><strong>do_test()</strong></span> matches the
 	extended regular expression. If it does not, the test will
 	fail.</p></dd>
 <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
 <dd><p>This function checks for each of its parameters
 	if the output from <span class="command"><strong>do_test()</strong></span> does
 	<span class="emphasis"><em>not</em></span> match the extended regular expression.
 	If any of the regular expressions matches, the test will
 	fail.</p></dd>
 </dl></div>
 </div>
 </div>
 </div>
 <div class="chapter">
 <div class="titlepage"><div><div><h2 class="title">
 <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt>
 <dt><span class="sect1"><a href="#porting.compiler">26.2. Adding support for a new compiler</a></span></dt>
 </dl>
 </div>
 <p>The pkgsrc system has already been ported to many
 	operating systems, hardware architectures and compilers. This
 	chapter explains the necessary steps to make pkgsrc even more
 	portable.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
 <p>To port pkgsrc to a new operating system (called
 	<code class="literal">MyOS</code> in this example), you need to touch the
 	following files:</p>
 <div class="variablelist"><dl class="variablelist">
 <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>
 <dd><p>This file contains some basic definitions, for
 	example the name of the C
 	compiler.</p></dd>
 <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
 <dd><p>Insert code that defines the variables
 	<code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
 	<code class="varname">LOWER_OS_VERSION</code>,
 	<code class="varname">LOWER_VENDOR</code>,
 	<code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
 	<code class="varname">APPEND_ELF</code>, and the other variables that
 	appear in this file.</p></dd>
 <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
 <dd><p>This file contains the platform-specific
 	definitions that are used by pkgsrc. Start by copying one of the
 	other files and edit it to your
 	needs.</p></dd>
 <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.pkg.dist</code></span></dt>
 <dd><p>This file contains a list of directories,
 	together with their permission bits and ownership. These
 	directories will be created automatically with every package
 	that explicitly sets <code class="varname">USE_MTREE</code>. This feature will
 	be removed.</p></dd>
 <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.x11.dist</code></span></dt>
 <dd><p>Just copy one of the pre-existing x11.dist files
 	to your
 	<code class="filename"><em class="replaceable"><code>MyOS</code></em>.x11.dist</code>.</p></dd>
 <dt><span class="term"><code class="filename">mk/tools/bootstrap.mk</code></span></dt>
 <dd><p>On some operating systems, the tools that are
 	provided with the base system are not good enough for pkgsrc.
 	For example, there are many versions of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that have a
 	narrow limit on the line length they can process. Therefore
 	pkgsrc brings its own tools, which can be enabled
 	here.</p></dd>
 <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
 <dd><p>This file defines the paths to all the tools
 	that are needed by one or the other package in pkgsrc, as well
 	as by pkgsrc itself. Find out where these tools are on your
 	platform and add them.</p></dd>
 </dl></div>
 <p>Now, you should be able to build some basic packages, like
 	<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>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="porting.compiler"></a>26.2. Adding support for a new compiler</h2></div></div></div>
 <p>TODO</p>
 </div>
 </div>
 </div>
 <div class="appendix">
 <div class="titlepage"><div><div><h1 class="title">
 <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
 <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
 <dd><dl>
 <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
 <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
 <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
 <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>
 </dl></dd>
 <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
 </dl>
 </div>
 <p>We checked to find a piece of software that wasn't in the packages
     collection, and picked GNU bison. Quite why someone would want to have
     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
     present in the tree is beyond us, but it's useful for the purposes of
     this exercise.</p>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="example-files"></a>A.1. files</h2></div></div></div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
 <pre class="programlisting">
 # $NetBSD$
+#
 DISTNAME=       bison-1.25
 CATEGORIES=     devel
 MASTER_SITES=   ${MASTER_SITE_GNU}
 MAINTAINER=     pkgsrc-users@NetBSD.org
 HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
 COMMENT=        GNU yacc clone
 GNU_CONFIGURE=  yes
 INFO_FILES=     yes
 .include "../../mk/bsd.pkg.mk"
 </pre>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
 <pre class="programlisting">
 GNU version of yacc.  Can make re-entrant parsers, and numerous other
 improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
 of the NetBSD source tree is beyond me.
 </pre>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
 <pre class="programlisting">
 @comment $NetBSD$
 bin/bison
 man/man1/bison.1.gz
 share/bison.simple
 share/bison.hairy
 </pre>
 </div>
 <div class="sect2">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
 </h3></div></div></div>
 <p>The NetBSD package system comes with
         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
 	which helps to check the contents of these
 	files. After installation it is quite easy to use, just change to the
 	directory of the package you wish to examine and execute
 	<span class="command"><strong>pkglint</strong></span>:</p>
 <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
 looks fine.</pre>
 <p>Depending on the supplied command line arguments (see pkglint(1)),
 	more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
 	-Wall</strong></span> for a very thorough check.</p>
 </div>
 </div>
 <div class="sect1">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
 <p>Create the directory where the package lives,
       plus any auxiliary directories:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
 <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
 <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
       <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>)
       then continue with fetching the distfile:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
 &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
 &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
 Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
 ftp: Error retrieving file: 500 Internal error
 &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
 Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
 ftp: Error retrieving file: 500 Internal error
 &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
 Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
 Successfully retrieved file.</pre>
 <p>Generate the checksum of the distfile into
       <code class="filename">distinfo</code>:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
 <p>Now compile:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
 &gt;&gt; Checksum OK for bison-1.25.tar.gz.
 ===&gt;  Extracting for bison-1.25
 ===&gt;  Patching for bison-1.25
 ===&gt;   Ignoring empty patch directory
 ===&gt;  Configuring for bison-1.25
 creating cache ./config.cache
 checking for gcc... cc
 checking whether we are using GNU C... yes
 checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
 checking how to run the C preprocessor... cc -E
 checking for minix/config.h... no
 checking for POSIXized ISC... no
 checking whether cross-compiling... no
 checking for ANSI C header files... yes
 checking for string.h... yes
 checking for stdlib.h... yes
 checking for memory.h... yes
 checking for working const... yes
 checking for working alloca.h... no
 checking for alloca... yes
 checking for strerror... yes
 updating cache ./config.cache
 creating ./config.status
 creating Makefile
 ===&gt;  Building for bison-1.25
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 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
 ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
 rm -f bison.s1
 sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
 <p>Everything seems OK, so install the files:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
 &gt;&gt; Checksum OK for bison-1.25.tar.gz.
 ===&gt;  Installing for bison-1.25
 sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
 rm -f /usr/pkg/bin/bison
 cd /usr/pkg/share; rm -f bison.simple bison.hairy
 rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
 install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
 /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
 /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
 cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
 /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
 ===&gt;  Registering installation for bison-1.25</pre>
 <p>You can now use bison, and also - if you decide so - remove it with
       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
       binary package, do this now:</p>
 <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
 &gt;&gt; Checksum OK for bison-1.25.tar.gz.
 ===&gt;  Building package for bison-1.25
 Creating package bison-1.25.tgz
 Registering depends:.
 Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
 <p>Now that you don't need the source and object files

 @@ -3728,2001 +3728,2001 @@ broken and couldn't have ever worked, bu
 quite large, I didn't want to fix it. So I added the following to the package
 Makefile and tried again:
 CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
 BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
 The latter line is needed because the package expects the library libIDL.so,
 but only libIDL-2.so is available. So I told the compiler wrapper to rewrite
 that on the fly.
 The next problem was related to a recent change of the FreeType interface. I
 looked up in www/seamonkey which patch files were relevant for this issue and
 copied them to the patches directory. Then I retried, fixed the patches so that
 they applied cleanly and retried again. This time, everything worked.
 .2.1.3. Installing the package
 $ bmake CHECK_FILES=no install
 [...]
 $ bmake print-PLIST >PLIST
 $ bmake deinstall
 $ bmake install
 Chapter 11. Package components - files, directories and contents
 Table of Contents
 .1. Makefile
 .2. distinfo
 .3. patches/*
 .3.1. Structure of a single patch file
 .3.2. Creating patch files
 .3.3. Sources where the patch files come from
 .3.4. Patching guidelines
 .3.5. Feedback to the author
 .4. Other mandatory files
 .5. Optional files
 .5.1. Files affecting the binary package
 .5.2. Files affecting the build process
 .5.3. Files affecting nothing at all
 .6. work*
 .7. files/*
 Whenever you're preparing a package, there are a number of files involved which
 are described in the following sections.
 .1. Makefile
 Building, installation and creation of a binary package are all controlled by
 the package's Makefile. The Makefile describes various things about a package,
 for example from where to get it, how to configure, build, and install it.
 A package Makefile contains several sections that describe the package.
 In the first section there are the following variables, which should appear
 exactly in the order given here. The order and grouping of the variables is
 mostly historical and has no further meaning.
   * DISTNAME is the basename of the distribution file to be downloaded from the
     package's website.
   * PKGNAME is the name of the package, as used by pkgsrc. You only need to
     provide it if DISTNAME (which is the default) is not a good name for the
     package in pkgsrc. Usually it is the pkgsrc directory name together with
     the version number. It must match the regular expression ^[A-Za-z0-9]
     [A-Za-z0-9-_.+]*$, that is, it starts with a letter or digit, and contains
     only letters, digits, dashes, underscores, dots and plus signs.
   * SVR4_PKGNAME is the name of the package file to create if the PKGNAME isn't
     unique on a SVR4 system. The default is PKGNAME, which may be shortened
     when you use pkgtools/gensolpkg. Only add SVR4_PKGNAME if PKGNAME does not
     produce an unique package name on a SVR4 system. The length of SVR4_PKGNAME
     is limited to 5 characters.
   * CATEGORIES is a list of categories which the package fits in. You can
     choose any of the top-level directories of pkgsrc for it.
     Currently the following values are available for CATEGORIES. If more than
     one is used, they need to be separated by spaces:
     archivers     cross         geography     meta-pkgs     security
     audio         databases     graphics      misc          shells
     benchmarks    devel         ham           multimedia    sysutils
     biology       editors       inputmethod   net           textproc
     cad           emulators     lang          news          time
     chat          finance       mail          parallel      wm
     comms         fonts         math          pkgtools      www
     converters    games         mbone         print         x11
   * MASTER_SITES, DYNAMIC_MASTER_SITES, DIST_SUBDIR, EXTRACT_SUFX and DISTFILES
     are discussed in detail in Section 17.5, "The fetch phase".
 The second section contains information about separately downloaded patches, if
 any.
   * PATCHFILES: Name(s) of additional files that contain distribution patches.
     There is no default. pkgsrc will look for them at PATCH_SITES. They will
     automatically be uncompressed before patching if the names end with .gz or
     .Z.
   * PATCH_SITES: Primary location(s) for distribution patch files (see
     PATCHFILES below) if not found locally.
 The third section contains the following variables.
   * MAINTAINER is the email address of the person who feels responsible for
     this package, and who is most likely to look at problems or questions
     regarding this package which have been reported with send-pr(1). Other
     developers may contact the MAINTAINER before making changes to the package,
     but are not required to do so. When packaging a new program, set MAINTAINER
     to yourself. If you really can't maintain the package for future updates,
     set it to <pkgsrc-users@NetBSD.org>.
   * OWNER should be used instead of MAINTAINER when you do not want other
     developers to update or change the package without contacting you first. A
     package Makefile should contain one of MAINTAINER or OWNER, but not both.
   * HOMEPAGE is a URL where users can find more information about the package.
   * COMMENT is a one-line description of the package (should not include the
     package name).
 Other variables that affect the build:
   * WRKSRC: The directory where the interesting distribution files of the
     package are found. The default is ${WRKDIR}/${DISTNAME}, which works for
     most packages.
     If a package doesn't create a subdirectory for itself (most GNU software
     does, for instance), but extracts itself in the current directory, you
     should set WRKSRC=${WRKDIR}.
     If a package doesn't create a subdirectory with the name of DISTNAME but
     some different name, set WRKSRC to point to the proper name in ${WRKDIR},
     for example WRKSRC=${WRKDIR}/${DISTNAME}/unix. See lang/tcl and x11/tk for
     other examples.
     The name of the working directory created by pkgsrc is taken from the
     WRKDIR_BASENAME variable. By default, its value is work. If you want to use
     the same pkgsrc tree for building different kinds of binary packages, you
     can change the variable according to your needs. Two other variables handle
     common cases of setting WRKDIR_BASENAME individually. If OBJHOSTNAME is
     defined in mk.conf, the first component of the host's name is attached to
     the directory name. If OBJMACHINE is defined, the platform name is
     attached, which might look like work.i386 or work.sparc.
 Please pay attention to the following gotchas:
   * Add MANCOMPRESSED if man pages are installed in compressed form by the
     package. For packages using BSD-style makefiles which honor MANZ, there is
     MANCOMPRESSED_IF_MANZ.
   * Replace /usr/local with "${PREFIX}" in all files (see patches, below).
   * If the package installs any info files, see Section 19.6.7, "Packages
     installing info files".
 .2. distinfo
 The distinfo file contains the message digest, or checksum, of each distfile
 needed for the package. This ensures that the distfiles retrieved from the
 Internet have not been corrupted during transfer or altered by a malign force
 to introduce a security hole. Due to recent rumor about weaknesses of digest
 algorithms, all distfiles are protected using both SHA1 and RMD160 message
 digests, as well as the file size.
 The distinfo file also contains the checksums for all the patches found in the
 patches directory (see Section 11.3, "patches/*").
 To regenerate the distinfo file, use the make makedistinfo or make mdi command.
 Some packages have different sets of distfiles depending on the platform, for
 example lang/openjdk7. These are kept in the same distinfo file and care should
 be taken when upgrading such a package to ensure distfile information is not
 lost.
 .3. patches/*
 Many packages still don't work out-of-the box on the various platforms that are
 supported by pkgsrc. Therefore, a number of custom patch files are needed to
 make the package work. These patch files are found in the patches/ directory.
 In the patch phase, these patches are applied to the files in WRKSRC directory
 after extracting them, in alphabetic order.
 .3.1. Structure of a single patch file
 The patch-* files should be in diff -bu format, and apply without a fuzz to
 avoid problems. (To force patches to apply with fuzz you can set
 PATCH_FUZZ_FACTOR=-F2). Furthermore, each patch should contain only changes for
 a single file, and no file should be patched by more than one patch file. This
 helps to keep future modifications simple.
 Each patch file is structured as follows: In the first line, there is the RCS
 Id of the patch itself. The second line should be empty for aesthetic reasons.
 After that, there should be a comment for each change that the patch does.
 There are a number of standard cases:
   * Patches for commonly known vulnerabilities should mention the vulnerability
     ID (CAN, CVE).
   * Patches that change source code should mention the platform and other
     environment (for example, the compiler) that the patch is needed for.
 In all, the patch should be commented so that any developer who knows the code
 of the application can make some use of the patch. Special care should be taken
 for the upstream developers, since we generally want that they accept our
 patches, so we have less work in the future.
 .3.2. Creating patch files
 One important thing to mention is to pay attention that no RCS IDs get stored
 in the patch files, as these will cause problems when later checked into the
 NetBSD CVS tree. Use the pkgdiff command from the pkgtools/pkgdiff package to
 avoid these problems.
 For even more automation, we recommend using mkpatches from the same package to
 make a whole set of patches. You just have to backup files before you edit them
 to filename.orig, e.g. with cp -p filename filename.orig or, easier, by using
 pkgvi again from the same package. If you upgrade a package this way, you can
 easily compare the new set of patches with the previously existing one with
 patchdiff. The files in patches are replaced by new files, so carefully check
 if you want to take all the changes.
 When you have finished a package, remember to generate the checksums for the
 patch files by using the make makepatchsum command, see Section 11.2,
 "distinfo".
 When adding a patch that corrects a problem in the distfile (rather than e.g.
 enforcing pkgsrc's view of where man pages should go), send the patch as a bug
 report to the maintainer. This benefits non-pkgsrc users of the package, and
 usually makes it possible to remove the patch in future version.
 The file names of the patch files are usually of the form patch-
 path_to_file__with__underscores.c. Many packages still use the previous
 convention patch-[a-z][a-z], but new patches should be of the form containing
 the filename. mkpatches included in pkgtools/pkgdiff takes care of the name
 automatically.
 .3.3. Sources where the patch files come from
 If you want to share patches between multiple packages in pkgsrc, e.g. because
 they use the same distfiles, set PATCHDIR to the path where the patch files can
 be found, e.g.:
 PATCHDIR= ${.CURDIR}/../xemacs/patches
 Patch files that are distributed by the author or other maintainers can be
 listed in PATCHFILES.
 If it is desired to store any patches that should not be committed into pkgsrc,
 they can be kept outside the pkgsrc tree in the $LOCALPATCHES directory. The
 directory tree there is expected to have the same "category/package" structure
 as pkgsrc, and patches are expected to be stored inside these dirs (also known
 as $LOCALPATCHES/$PKGPATH). For example, if you want to keep a private patch
 for pkgsrc/graphics/png, keep it in $LOCALPATCHES/graphics/png/mypatch. All
 files in the named directory are expected to be patch files, and they are
 applied after pkgsrc patches are applied.
 .3.4. Patching guidelines
 When fixing a portability issue in the code do not use preprocessor magic to
 check for the current operating system nor platform. Doing so hurts portability
 to other platforms because the OS-specific details are not abstracted
 appropriately.
 The general rule to follow is: instead of checking for the operating system the
 application is being built on, check for the specific features you need. For
 example, instead of assuming that kqueue is available under NetBSD and using
 the __NetBSD__ macro to conditionalize kqueue support, add a check that detects
 kqueue itself ? yes, this generally involves patching the configure script.
 There is absolutely nothing that prevents some OSes from adopting interfaces
 from other OSes (e.g. Linux implementing kqueue), something that the above
 checks cannot take into account.
 Of course, checking for features generally involves more work on the
 developer's side, but the resulting changes are cleaner and there are chances
 they will work on many other platforms. Not to mention that there are higher
 chances of being later integrated into the mainstream sources. Remember: It
 doesn't work unless it is right!
 Some typical examples:
 Table 11.1. Patching examples
 +-------------------------------------------------------------------------------------------+
 |  Where  |        Incorrect         |                       Correct                        |
 |---------+--------------------------+------------------------------------------------------|
 |         |case ${target_os} in      |                                                      |
 |configure|netbsd*) have_kvm=yes ;;  |AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)|
 |script   |*)       have_kvm=no  ;;  |                                                      |
 |         |esac                      |                                                      |
 |---------+--------------------------+------------------------------------------------------|
 |C source |#if defined(__NetBSD__)   |#if defined(HAVE_SYS_EVENT_H)                         |
 |file     |#  include <sys/event.h>  |#  include <sys/event.h>                              |
 |         |#endif                    |#endif                                                |
 |---------+--------------------------+------------------------------------------------------|
 |         |int                       |int                                                   |
 |         |monitor_file(...)         |monitor_file(...)                                     |
 |         |{                         |{                                                     |
 |         |#if defined(__NetBSD__)   |#if defined(HAVE_KQUEUE)                              |
 |C source |        int fd = kqueue();|        int fd = kqueue();                            |
 |file     |        ...               |        ...                                           |
 |         |#else                     |#else                                                 |
 |         |        ...               |        ...                                           |
 |         |#endif                    |#endif                                                |
 |         |}                         |}                                                     |
 +-------------------------------------------------------------------------------------------+
 For more information, please read the Making packager-friendly software article
 (part 1, part 2). It summarizes multiple details on how to make software easier
 to package; all the suggestions in it were collected from our experience in
 pkgsrc work, so they are possibly helpful when creating patches too.
 .3.5. Feedback to the author
 Always, always, always feed back any portability fixes or improvements you do
 to a package to the mainstream developers. This is the only way to get their
 attention on portability issues and to ensure that future versions can be built
 out-of-the box on NetBSD. Furthermore, any user that gets newer distfiles will
 get the fixes straight from the packaged code.
 This generally involves cleaning up the patches (because sometimes the patches
 that are added to pkgsrc are quick hacks), filing bug reports in the
 appropriate trackers for the projects and working with the mainstream authors
 to accept your changes. It is extremely important that you do it so that the
 packages in pkgsrc are kept simple and thus further changes can be done without
 much hassle.
 When you have done this, please add a URL to the upstream bug report to the
 patch comment.
 Support the idea of free software!
 .4. Other mandatory files
 DESCR
     A multi-line description of the piece of software. This should include any
     credits where they are due. Please bear in mind that others do not share
     your sense of humour (or spelling idiosyncrasies), and that others will
     read everything that you write here.
 PLIST
     This file governs the files that are installed on your system: all the
     binaries, manual pages, etc. There are other directives which may be
     entered in this file, to control the creation and deletion of directories,
     and the location of inserted files. See Chapter 13, PLIST issues for more
     information.
 .5. Optional files
 .5.1. Files affecting the binary package
 INSTALL
     This shell script is invoked twice by pkg_add(1). First time after package
     extraction and before files are moved in place, the second time after the
     files to install are moved in place. This can be used to do any custom
     procedures not possible with @exec commands in PLIST. See pkg_add(1) and
     pkg_create(1) for more information. See also Section 15.1, "Files and
     directories outside the installation prefix". Please note that you can
     modify variables in it easily by using FILES_SUBST in the package's
     Makefile:
     FILES_SUBST+=  SOMEVAR="somevalue"
     replaces "@SOMEVAR@" with "somevalue" in the INSTALL. By default,
     substitution is performed for PREFIX, LOCALBASE, X11BASE, VARBASE, and a
     few others, type make help topic=FILES_SUBST for a complete list.
 DEINSTALL
     This script is executed before and after any files are removed. It is this
     script's responsibility to clean up any additional messy details around the
     package's installation, since all pkg_delete knows is how to delete the
     files created in the original distribution. See pkg_delete(1) and
     pkg_create(1) for more information. The same methods to replace variables
     can be used as for the INSTALL file.
 MESSAGE
     This file is displayed after installation of the package. Useful for things
     like legal notices on almost-free software and hints for updating config
     files after installing modules for apache, PHP etc. Please note that you
     can modify variables in it easily by using MESSAGE_SUBST in the package's
     Makefile:
     MESSAGE_SUBST+=  SOMEVAR="somevalue"
     replaces "${SOMEVAR}" with "somevalue" in MESSAGE. By default, substitution
     is performed for PKGNAME, PKGBASE, PREFIX, LOCALBASE, X11PREFIX, X11BASE,
     PKG_SYSCONFDIR, ROOT_GROUP, and ROOT_USER.
     You can display a different or additional files by setting the MESSAGE_SRC
     variable. Its default is MESSAGE, if the file exists.
 ALTERNATIVES
     FIXME: There is no documentation on the alternatives framework.
 .5.2. Files affecting the build process
 Makefile.common
     This file contains arbitrary things that could also go into a Makefile, but
     its purpose is to be used by more than one package. This file should only
     be used when the packages that will use the file are known in advance. For
     other purposes it is often better to write a *.mk file and give it a good
     name that describes what it does.
 buildlink3.mk
     This file contains the dependency information for the buildlink3 framework
     (see Chapter 14, Buildlink methodology).
 hacks.mk
     This file contains workarounds for compiler bugs and similar things. It is
     included automatically by the pkgsrc infrastructure, so you don't need an
     extra .include line for it.
 options.mk
     This file contains the code for the package-specific options (see
     Chapter 16, Options handling) that can be selected by the user. If a
     package has only one or two options, it is equally acceptable to put the
     code directly into the Makefile.
 .5.3. Files affecting nothing at all
 README*
     These files do not take place in the creation of a package and thus are
     purely informative to the package developer.
 TODO
     This file contains things that need to be done to make the package even
     better.
 .6. work*
 When you type make, the distribution files are unpacked into the directory
 denoted by WRKDIR. It can be removed by running make clean. Besides the
 sources, this directory is also used to keep various timestamp files. The
 directory gets removed completely on clean. The default is ${.CURDIR}/work or $
 {.CURDIR}/work.${MACHINE_ARCH} if OBJMACHINE is set.
 .7. files/*
 If you have any files that you wish to be placed in the package prior to
 configuration or building, you could place these files here and use a ${CP}
 command in the "pre-configure" target to achieve this. Alternatively, you could
 simply diff the file against /dev/null and use the patch mechanism to manage
 the creation of this file.
 If you want to share files in this way with other packages, set the FILESDIR
 variable to point to the other package's files directory, e.g.:
 FILESDIR=${.CURDIR}/../xemacs/files
 Chapter 12. Programming in Makefiles
 Table of Contents
 .1. Caveats
 .2. Makefile variables
 .2.1. Naming conventions
 .3. Code snippets
 .3.1. Adding things to a list
 .3.2. Converting an internal list into an external list
 .3.3. Passing variables to a shell command
 .3.4. Quoting guideline
 .3.5. Workaround for a bug in BSD Make
 Pkgsrc consists of many Makefile fragments, each of which forms a well-defined
 part of the pkgsrc system. Using the make(1) system as a programming language
 for a big system like pkgsrc requires some discipline to keep the code correct
 and understandable.
 The basic ingredients for Makefile programming are variables (which are
 actually macros) and shell commands. Among these shell commands may even be
 more complex ones like awk(1) programs. To make sure that every shell command
 runs as intended it is necessary to quote all variables correctly when they are
 used.
 This chapter describes some patterns, that appear quite often in Makefiles,
 including the pitfalls that come along with them.
 .1. Caveats
   * When you are creating a file as a target of a rule, always write the data
     to a temporary file first and finally rename that file. Otherwise there
     might occur an error in the middle of generating the file, and when the
     user runs make(1) for the second time, the file exists and will not be
     regenerated properly. Example:
     wrong:
             @echo "line 1" > ${.TARGET}
             @echo "line 2" >> ${.TARGET}
             @false
     correct:
             @echo "line 1" > ${.TARGET}.tmp
             @echo "line 2" >> ${.TARGET}.tmp
             @false
             @mv ${.TARGET}.tmp ${.TARGET}
     When you run make wrong twice, the file wrong will exist, although there
     was an error message in the first run. On the other hand, running make
     correct gives an error message twice, as expected.
     You might remember that make(1) sometimes removes ${.TARGET} in case of
     error, but this only happens when it is interrupted, for example by
     pressing ^C. This does not happen when one of the commands fails (like
     false(1) above).
 .2. Makefile variables
 Makefile variables contain strings that can be processed using the five
 operators ``='', ``+='', ``?='', ``:='', and ``!='', which are described in the
 make(1) man page.
 When a variable's value is parsed from a Makefile, the hash character ``#'' and
 the backslash character ``\'' are handled specially. If a backslash is followed
 by a newline, any whitespace immediately in front of the backslash, the
 backslash, the newline, and any whitespace immediately behind the newline are
 replaced with a single space. A backslash character and an immediately
 following hash character are replaced with a single hash character. Otherwise,
 the backslash is passed as is. In a variable assignment, any hash character
 that is not preceded by a backslash starts a comment that continues upto the
 end of the logical line.
 Note: Because of this parsing algorithm the only way to create a variable
 consisting of a single backslash is using the ``!='' operator, for example:
 BACKSLASH!=echo "\\".
 So far for defining variables. The other thing you can do with variables is
 evaluating them. A variable is evaluated when it is part of the right side of
 the ``:='' or the ``!='' operator, or directly before executing a shell command
 which the variable is part of. In all other cases, make(1) performs lazy
 evaluation, that is, variables are not evaluated until there's no other way.
 The ``modifiers'' mentioned in the man page also evaluate the variable.
 Some of the modifiers split the string into words and then operate on the
 words, others operate on the string as a whole. When a string is split into
 words, it is split as you would expect it from sh(1).
 No rule without exception?the .for loop does not follow the shell quoting rules
 but splits at sequences of whitespace.
 There are several types of variables that should be handled differently.
 Strings and two types of lists.
   * Strings can contain arbitrary characters. Nevertheless, you should restrict
     yourself to only using printable characters. Examples are PREFIX and
     COMMENT.
   * Internal lists are lists that are never exported to any shell command.
     Their elements are separated by whitespace. Therefore, the elements
     themselves cannot have embedded whitespace. Any other characters are
     allowed. Internal lists can be used in .for loops. Examples are DEPENDS and
     BUILD_DEPENDS.
   * External lists are lists that may be exported to a shell command. Their
     elements can contain any characters, including whitespace. That's why they
     cannot be used in .for loops. Examples are DISTFILES and MASTER_SITES.
 .2.1. Naming conventions
   * All variable names starting with an underscore are reserved for use by the
     pkgsrc infrastructure. They shall not be used by package Makefiles.
   * In .for loops you should use lowercase variable names for the iteration
     variables.
   * All list variables should have a ``plural'' name, e.g. PKG_OPTIONS or
     DISTFILES.
 .3. Code snippets
 This section presents you with some code snippets you should use in your own
 code. If you don't find anything appropriate here, you should test your code
 and add it here.
 .3.1. Adding things to a list
 STRING=                 foo * bar `date`
 INT_LIST=               # empty
 ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
 EXT_LIST=               # empty
 ANOTHER_EXT_LIST=       a=b c=d
 INT_LIST+=              ${STRING}               # 1
 INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
 EXT_LIST+=              ${STRING:Q}             # 3
 EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
 When you add a string to an external list (example 3), it must be quoted. In
 all other cases, you must not add a quoting level. You must not merge internal
 and external lists, unless you are sure that all entries are correctly
 interpreted in both lists.
 .3.2. Converting an internal list into an external list
 EXT_LIST=       # empty
 .for i in ${INT_LIST}
 EXT_LIST+=      ${i:Q}""
 .endfor
 This code converts the internal list INT_LIST into the external list EXT_LIST.
 As the elements of an internal list are unquoted they must be quoted here. The
 reason for appending "" is explained below.
 .3.3. Passing variables to a shell command
 Sometimes you may want to print an arbitrary string. There are many ways to get
 it wrong and only few that can handle every nastiness.
 STRING=         foo bar <    > * `date` $$HOME ' "
 EXT_LIST=       string=${STRING:Q} x=second\ item
 all:
         echo ${STRING}                  # 1
         echo "${STRING}"                # 2
         echo "${STRING:Q}"              # 3
         echo ${STRING:Q}                # 4
         echo x${STRING:Q} | sed 1s,.,,  # 5
         printf "%s\\n" ${STRING:Q}""    # 6
         env ${EXT_LIST} /bin/sh -c 'echo "$$string"; echo "$$x"'
 Example 1 leads to a syntax error in the shell, as the characters are just
 copied.
 Example 2 leads to a syntax error too, and if you leave out the last "
 character from ${STRING}, date(1) will be executed. The $HOME shell variable
 would be evaluated, too.
 Example 3 outputs each space character preceded by a backslash (or not),
 depending on the implementation of the echo(1) command.
 Example 4 handles correctly every string that does not start with a dash. In
 that case, the result depends on the implementation of the echo(1) command. As
 long as you can guarantee that your input does not start with a dash, this form
 is appropriate.
 Example 5 handles even the case of a leading dash correctly.
 Example 6 also works with every string and is the light-weight solution, since
 it does not involve a pipe, which has its own problems.
 The EXT_LIST does not need to be quoted because the quoting has already been
 done when adding elements to the list.
 As internal lists shall not be passed to the shell, there is no example for it.
 .3.4. Quoting guideline
 There are many possible sources of wrongly quoted variables. This section lists
 some of the commonly known ones.
   * Whenever you use the value of a list, think about what happens to leading
     or trailing whitespace. If the list is a well-formed shell expression, you
     can apply the :M* modifier to strip leading and trailing whitespace from
     each word. The :M operator first splits its argument according to the rules
     of the shell, and then creates a new list consisting of all words that
     match the shell glob expression *, that is: all. One class of situations
     where this is needed is when adding a variable like CPPFLAGS to
     CONFIGURE_ARGS. If the configure script invokes other configure scripts, it
     strips the leading and trailing whitespace from the variable and then
     passes it to the other configure scripts. But these configure scripts
     expect the (child) CPPFLAGS variable to be the same as the parent CPPFLAGS.
     That's why we better pass the CPPFLAGS value properly trimmed. And here is
     how we do it:
     CPPFLAGS=               # empty
     CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
     CPPFLAGS+=              ${MY_CPPFLAGS}
     CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
     all:
             echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
             echo x${CONFIGURE_ARGS}x        # properly trimmed
   * The example above contains one bug: The ${PREFIX} is a properly quoted
     shell expression, but there is the C compiler after it, which also expects
     a properly quoted string (this time in C syntax). The version above is
     therefore only correct if ${PREFIX} does not have embedded backslashes or
     double quotes. If you want to allow these, you have to add another layer of
     quoting to each variable that is used as a C string literal. You cannot use
     the :Q operator for it, as this operator only works for the shell.
   * Whenever a variable can be empty, the :Q operator can have surprising
     results. Here are two completely different cases which can be solved with
     the same trick.
     EMPTY=                  # empty
     empty_test:
             for i in a ${EMPTY:Q} c; do \
                 echo "$$i"; \
             done
     for_test:
     .for i in a:\ a:\test.txt
             echo ${i:Q}
             echo "foo"
     .endfor
     The first example will only print two of the three lines we might have
     expected. This is because ${EMPTY:Q} expands to the empty string, which the
     shell cannot see. The workaround is to write ${EMPTY:Q}"". This pattern can
     be often found as ${TEST} -z ${VAR:Q} or as ${TEST} -f ${FNAME:Q} (both of
     these are wrong).
     The second example will only print three lines instead of four. The first
     line looks like a:\ echo foo. This is because the backslash of the value a:
     \ is interpreted as a line-continuation by make(1), which makes the second
     line the arguments of the echo(1) command from the first line. To avoid
     this, write ${i:Q}"".
 .3.5. Workaround for a bug in BSD Make
 The pkgsrc bmake program does not handle the following assignment correctly. In
 case _othervar_ contains a ``-'' character, one of the closing braces is
 included in ${VAR} after this code executes.
 VAR:=   ${VAR:N${_othervar_:C/-//}}
 For a more complex code snippet and a workaround, see the package regress/
 make-quoting, testcase bug1.
 Chapter 13. PLIST issues
 Table of Contents
 .1. RCS ID
 .2. Semi-automatic PLIST generation
 .3. Tweaking output of make print-PLIST
 .4. Variable substitution in PLIST
 .5. Man page compression
 .6. Changing PLIST source with PLIST_SRC
 .7. Platform-specific and differing PLISTs
 .8. Sharing directories between packages
 The PLIST file contains a package's "packing list", i.e. a list of files that
 belong to the package (relative to the ${PREFIX} directory it's been installed
 in) plus some additional statements - see the pkg_create(1) man page for a full
 list. This chapter addresses some issues that need attention when dealing with
 the PLIST file (or files, see below!).
 .1. RCS ID
 Be sure to add a RCS ID line as the first thing in any PLIST file you write:
 @comment $NetBSD$
 .2. Semi-automatic PLIST generation
 You can use the make print-PLIST command to output a PLIST that matches any new
 files since the package was extracted. See Section 17.17, "Other helpful
 targets" for more information on this target.
 .3. Tweaking output of make print-PLIST
 If you have used any of the *-dirs packages, as explained in Section 13.8,
 "Sharing directories between packages", you may have noticed that make
 print-PLIST outputs a set of @comments instead of real @dirrm lines. You can
 also do this for specific directories and files, so that the results of that
 command are very close to reality. This helps a lot during the update of
 packages.
 The PRINT_PLIST_AWK variable takes a set of AWK patterns and actions that are
 used to filter the output of print-PLIST. You can append any chunk of AWK
 scripting you like to it, but be careful with quoting.
 For example, to get all files inside the libdata/foo directory removed from the
 resulting PLIST:
 PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
 And to get all the @dirrm lines referring to a specific (shared) directory
 converted to @comments:
 PRINT_PLIST_AWK+=       /^@dirrm share\/specific/ { print "@comment " $$0; next; }
 .4. Variable substitution in PLIST
 A number of variables are substituted automatically in PLISTs when a package is
 installed on a system. This includes the following variables:
 ${MACHINE_ARCH}, ${MACHINE_GNU_ARCH}
     Some packages like emacs and perl embed information about which
     architecture they were built on into the pathnames where they install their
     files. To handle this case, PLIST will be preprocessed before actually
     used, and the symbol "${MACHINE_ARCH}" will be replaced by what uname -p
     gives. The same is done if the string ${MACHINE_GNU_ARCH} is embedded in
     PLIST somewhere - use this on packages that have GNU autoconf-created
     configure scripts.
     Legacy note
     There used to be a symbol "$ARCH" that was replaced by the output of uname
     -m, but that's no longer supported and has been removed.
 ${OPSYS}, ${LOWER_OPSYS}, ${OS_VERSION}
     Some packages want to embed the OS name and version into some paths. To do
     this, use these variables in the PLIST:
       + ${OPSYS} - output of "uname -s"
       + ${LOWER_OPSYS} - lowercase common name (eg. "solaris")
       + ${OS_VERSION} - "uname -r"
 For a complete list of values which are replaced by default, please look in
 bsd.pkg.mk (and search for PLIST_SUBST).
 If you want to change other variables not listed above, you can add variables
 and their expansions to this variable in the following way, similar to
 MESSAGE_SUBST (see Section 11.5, "Optional files"):
 PLIST_SUBST+=   SOMEVAR="somevalue"
 This replaces all occurrences of "${SOMEVAR}" in the PLIST with "somevalue".
 The PLIST_VARS variable can be used to simplify the common case of
 conditionally including some PLIST entries. It can be done by adding
 PLIST_VARS+=foo and setting the corresponding PLIST.foo variable to yes if the
 entry should be included. This will substitute "${PLIST.foo}" in the PLIST with
 either """" or ""@comment "". For example, in Makefile:
 PLIST_VARS+=    foo
 .if condition
 PLIST.foo=      yes
 .else
 And then in PLIST:
 @comment $NetBSD$
 bin/bar
 man/man1/bar.1
 ${PLIST.foo}bin/foo
 ${PLIST.foo}man/man1/foo.1
 ${PLIST.foo}share/bar/foo.data
 ${PLIST.foo}@dirrm share/bar
 .5. Man page compression
 Man pages should be installed in compressed form if MANZ is set (in
 bsd.own.mk), and uncompressed otherwise. To handle this in the PLIST file, the
 suffix ".gz" is appended/removed automatically for man pages according to MANZ
 and MANCOMPRESSED being set or not, see above for details. This modification of
 the PLIST file is done on a copy of it, not PLIST itself.
 .6. Changing PLIST source with PLIST_SRC
 To use one or more files as source for the PLIST used in generating the binary
 package, set the variable PLIST_SRC to the names of that file(s). The files are
 later concatenated using cat(1), and the order of things is important. The
 default for PLIST_SRC is ${PKGDIR}/PLIST.
 .7. Platform-specific and differing PLISTs
 Some packages decide to install a different set of files based on the operating
 system being used. These differences can be automatically handled by using the
 following files:
   * PLIST.common
   * PLIST.${OPSYS}
   * PLIST.${MACHINE_ARCH}
   * PLIST.${OPSYS}-${MACHINE_ARCH}
   * PLIST.common_end
 .8. Sharing directories between packages
 A "shared directory" is a directory where multiple (and unrelated) packages
 install files. These directories were problematic because you had to add
 special tricks in the PLIST to conditionally remove them, or have some
 centralized package handle them.
 In pkgsrc, it is now easy: Each package should create directories and install
 files as needed; pkg_delete will remove any directories left empty after
 uninstalling a package.
 If a package needs an empty directory to work, create the directory during
 installation as usual, and also add an entry to the PLIST:
 @pkgdir path/to/empty/directory
 Chapter 14. Buildlink methodology
 Table of Contents
 .1. Converting packages to use buildlink3
 .2. Writing buildlink3.mk files
 .2.1. Anatomy of a buildlink3.mk file
 .2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
         buildlink3.mk files
 .3. Writing builtin.mk files
 .3.1. Anatomy of a builtin.mk file
 .3.2. Global preferences for native or pkgsrc software
 Buildlink is a framework in pkgsrc that controls what headers and libraries are
 seen by a package's configure and build processes. This is implemented in a two
 step process:
 . Symlink headers and libraries for dependencies into BUILDLINK_DIR, which by
     default is a subdirectory of WRKDIR.
 . Create wrapper scripts that are used in place of the normal compiler tools
     that translate -I${LOCALBASE}/include and -L${LOCALBASE}/lib into
     references to BUILDLINK_DIR. The wrapper scripts also make native compiler
     on some operating systems look like GCC, so that packages that expect GCC
     won't require modifications to build with those native compilers.
 This normalizes the environment in which a package is built so that the package
 may be built consistently despite what other software may be installed. Please
 note that the normal system header and library paths, e.g. /usr/include, /usr/
 lib, etc., are always searched -- buildlink3 is designed to insulate the
 package build from non-system-supplied software.
 .1. Converting packages to use buildlink3
 The process of converting packages to use the buildlink3 framework ("bl3ifying"
 ) is fairly straightforward. The things to keep in mind are:
 . Ensure that the build always calls the wrapper scripts instead of the
     actual toolchain. Some packages are tricky, and the only way to know for
     sure is the check ${WRKDIR}/.work.log to see if the wrappers are being
     invoked.
 . Don't override PREFIX from within the package Makefile, e.g. Java VMs,
     standalone shells, etc., because the code to symlink files into $
     {BUILDLINK_DIR} looks for files relative to "pkg_info -qp pkgname".
 . Remember that only the buildlink3.mk files that you list in a package's
     Makefile are added as dependencies for that package.
 If a dependency on a particular package is required for its libraries and
 headers, then we replace:
 DEPENDS+=       foo>=1.1.0:../../category/foo
 with
 .include "../../category/foo/buildlink3.mk"
 The buildlink3.mk files usually define the required dependencies. If you need a
 newer version of the dependency when using buildlink3.mk files, then you can
 define it in your Makefile; for example:
 BUILDLINK_API_DEPENDS.foo+=   foo>=1.1.0
 .include "../../category/foo/buildlink3.mk"
 There are several buildlink3.mk files in pkgsrc/mk that handle special package
 issues:
   * bdb.buildlink3.mk chooses either the native or a pkgsrc Berkeley DB
     implementation based on the values of BDB_ACCEPTED and BDB_DEFAULT.
   * curses.buildlink3.mk: If the system comes with neither Curses nor NCurses,
     this will take care to install the devel/ncurses package.
   * krb5.buildlink3.mk uses the value of KRB5_ACCEPTED to choose between adding
     a dependency on Heimdal or MIT-krb5 for packages that require a Kerberos 5
     implementation.
   * motif.buildlink3.mk checks for a system-provided Motif installation or adds
     a dependency on x11/lesstif, x11/motif or x11/openmotif. The user can set
     MOTIF_TYPE to "dt", "lesstif", "motif" or "openmotif" to choose which Motif
     version will be used.
-  * readline.buildlink3.mk checks for a system-provided GNU readline or ediline
+  * readline.buildlink3.mk checks for a system-provided GNU readline or
-    (libedit) installation, or adds a dependency on devel/readline, devel/
+    editline (libedit) installation, or adds a dependency on devel/readline,
-    editline. The user can set READLINE_DEFAULT to choose readline
+    devel/editline. The user can set READLINE_DEFAULT to choose readline
     implementation. If your package really needs GNU readline library, its
     Makefile should include devel/readline/buildlink3.mk instead of
     readline.buildlink3.mk.
   * oss.buildlink3.mk defines several variables that may be used by packages
     that use the Open Sound System (OSS) API.
   * pgsql.buildlink3.mk will accept any of the Postgres versions in the
     variable PGSQL_VERSIONS_ACCEPTED and default to the version
     PGSQL_VERSION_DEFAULT. See the file for more information.
   * pthread.buildlink3.mk uses the value of PTHREAD_OPTS and checks for native
     pthreads or adds a dependency on devel/pth as needed.
   * xaw.buildlink3.mk uses the value of XAW_TYPE to choose a particular Athena
     widgets library.
 The comments in those buildlink3.mk files provide a more complete description
 of how to use them properly.
 .2. Writing buildlink3.mk files
 A package's buildlink3.mk file is included by Makefiles to indicate the need to
 compile and link against header files and libraries provided by the package. A
 buildlink3.mk file should always provide enough information to add the correct
 type of dependency relationship and include any other buildlink3.mk files that
 it needs to find headers and libraries that it needs in turn.
 To generate an initial buildlink3.mk file for further editing, Rene Hexel's
 pkgtools/createbuildlink package is highly recommended. For most packages, the
 following command will generate a good starting point for buildlink3.mk files:
 % cd pkgsrc/category/pkgdir
 % createbuildlink >buildlink3.mk
 .2.1. Anatomy of a buildlink3.mk file
 The following real-life example buildlink3.mk is taken from pkgsrc/graphics/
 tiff:
 # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
 BUILDLINK_TREE+=        tiff
 .if !defined(TIFF_BUILDLINK3_MK)
 TIFF_BUILDLINK3_MK:=
 BUILDLINK_API_DEPENDS.tiff+=    tiff>=3.6.1
 BUILDLINK_ABI_DEPENDS.tiff+=    tiff>=3.7.2nb1
 BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
 .include "../../devel/zlib/buildlink3.mk"
 .include "../../graphics/jpeg/buildlink3.mk"
 .endif # TIFF_BUILDLINK3_MK
 BUILDLINK_TREE+=        -tiff
 The header and footer manipulate BUILDLINK_TREE, which is common across all
 buildlink3.mk files and is used to track the dependency tree.
 The main section is protected from multiple inclusion and controls how the
 dependency on pkg is added. Several important variables are set in the section:
   * BUILDLINK_API_DEPENDS.pkg is the actual dependency recorded in the
     installed package; this should always be set using += to ensure that we're
     appending to any pre-existing list of values. This variable should be set
     to the first version of the package that had an backwards-incompatible API
     change.
   * BUILDLINK_PKGSRCDIR.pkg is the location of the pkg pkgsrc directory.
   * BUILDLINK_DEPMETHOD.pkg (not shown above) controls whether we use
     BUILD_DEPENDS or DEPENDS to add the dependency on pkg. The build dependency
     is selected by setting BUILDLINK_DEPMETHOD.pkg to "build". By default, the
     full dependency is used.
   * BUILDLINK_INCDIRS.pkg and BUILDLINK_LIBDIRS.pkg (not shown above) are lists
     of subdirectories of ${BUILDLINK_PREFIX.pkg} to add to the header and
     library search paths. These default to "include" and "lib" respectively.
   * BUILDLINK_CPPFLAGS.pkg (not shown above) is the list of preprocessor flags
     to add to CPPFLAGS, which are passed on to the configure and build phases.
     The "-I" option should be avoided and instead be handled using
     BUILDLINK_INCDIRS.pkg as above.
 The following variables are all optionally defined within this second section
 (protected against multiple inclusion) and control which package files are
 symlinked into ${BUILDLINK_DIR} and how their names are transformed during the
 symlinking:
   * BUILDLINK_FILES.pkg (not shown above) is a shell glob pattern relative to $
     {BUILDLINK_PREFIX.pkg} to be symlinked into ${BUILDLINK_DIR}, e.g. include/
     *.h.
   * BUILDLINK_FILES_CMD.pkg (not shown above) is a shell pipeline that outputs
     to stdout a list of files relative to ${BUILDLINK_PREFIX.pkg}. The
     resulting files are to be symlinked into ${BUILDLINK_DIR}. By default, this
     takes the +CONTENTS of a pkg and filters it through $
     {BUILDLINK_CONTENTS_FILTER.pkg}.
   * BUILDLINK_CONTENTS_FILTER.pkg (not shown above) is a filter command that
     filters +CONTENTS input into a list of files relative to $
     {BUILDLINK_PREFIX.pkg} on stdout. By default for overwrite packages,
     BUILDLINK_CONTENTS_FILTER.pkg outputs the contents of the include and lib
     directories in the package +CONTENTS, and for pkgviews packages, it outputs
     any libtool archives in lib directories.
   * BUILDLINK_FNAME_TRANSFORM.pkg (not shown above) is a list of sed arguments
     used to transform the name of the source filename into a destination
     filename, e.g. -e "s|/curses.h|/ncurses.h|g".
 This section can additionally include any buildlink3.mk needed for pkg's
 library dependencies. Including these buildlink3.mk files means that the
 headers and libraries for these dependencies are also symlinked into $
 {BUILDLINK_DIR} whenever the pkg buildlink3.mk file is included. Dependencies
 are only added for directly include buildlink3.mk files.
 When providing a buildlink3.mk and including other buildlink3.mk files in it,
 please only add necessary ones, i.e., those whose libraries or header files are
 automatically exposed when the package is use.
 In particular, if only an executable (bin/foo) is linked against a library,
 that library does not need to be propagated in the buildlink3.mk file.
 The following steps should help you decide if a buildlink3.mk file needs to be
 included:
   * Look at the installed header files: What headers do they include? The
     packages providing these files must be buildlinked.
   * Run ldd on all installed libraries and look against what other libraries
     they link. Some of the packages providing these probably need to be
     buildlinked; however, it's not automatic, since e.g. GTK on some systems
     pulls in the X libraries, so they will show up in the ldd output, while on
     others (like OS X) it won't. ldd output can thus only be used as a hint.
 .2.2. Updating BUILDLINK_API_DEPENDS.pkg and BUILDLINK_ABI_DEPENDS.pkg in
 buildlink3.mk files
 These two variables differ in that one describes source compatibility (API) and
 the other binary compatibility (ABI). The difference is that a change in the
 API breaks compilation of programs while changes in the ABI stop compiled
 programs from running.
 Changes to the BUILDLINK_API_DEPENDS.pkg variable in a buildlink3.mk file
 happen very rarely. One possible reason is that all packages depending on this
 already need a newer version. In case it is bumped see the description below.
 The most common example of an ABI change is that the major version of a shared
 library is increased. In this case, BUILDLINK_ABI_DEPENDS.pkg should be
 adjusted to require at least the new package version. Then the packages that
 depend on this package need their PKGREVISIONs increased and, if they have
 buildlink3.mk files, their BUILDLINK_ABI_DEPENDS.pkg adjusted, too. This is
 needed so pkgsrc will require the correct package dependency and not settle for
 an older one when building the source.
 See Section 19.1.6, "Handling dependencies" for more information about
 dependencies on other packages, including the BUILDLINK_ABI_DEPENDS and
 ABI_DEPENDS definitions.
 Please take careful consideration before adjusting BUILDLINK_API_DEPENDS.pkg or
 BUILDLINK_ABI_DEPENDS.pkg as we don't want to cause unneeded package deletions
 and rebuilds. In many cases, new versions of packages work just fine with older
 dependencies.
 Also it is not needed to set BUILDLINK_ABI_DEPENDS.pkg when it is identical to
 BUILDLINK_API_DEPENDS.pkg.
 .3. Writing builtin.mk files
 Some packages in pkgsrc install headers and libraries that coincide with
 headers and libraries present in the base system. Aside from a buildlink3.mk
 file, these packages should also include a builtin.mk file that includes the
 necessary checks to decide whether using the built-in software or the pkgsrc
 software is appropriate.
 The only requirements of a builtin.mk file for pkg are:
 . It should set USE_BUILTIN.pkg to either "yes" or "no" after it is included.
 . It should not override any USE_BUILTIN.pkg which is already set before the
     builtin.mk file is included.
 . It should be written to allow multiple inclusion. This is very important
     and takes careful attention to Makefile coding.
 .3.1. Anatomy of a builtin.mk file
 The following is the recommended template for builtin.mk files:
 .if !defined(IS_BUILTIN.foo)
+#
 # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
 # genuinely exists in the system or not.
+#
 IS_BUILTIN.foo?=        no
 # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
 # version can be determined.
+#
 .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
 BUILTIN_PKG.foo?=       foo-1.0
 .  endif
 .endif  # IS_BUILTIN.foo
 .if !defined(USE_BUILTIN.foo)
 USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
 .  if defined(BUILTIN_PKG.foo)
 .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
 .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
 USE_BUILTIN.foo!=                                                       \
         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
         && ${ECHO} "yes" || ${ECHO} "no"
 .      endif
 .    endfor
 .  endif
 .endif  # USE_BUILTIN.foo
 CHECK_BUILTIN.foo?=     no
 .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
+#
 # Here we place code that depends on whether USE_BUILTIN.foo is set to
 # "yes" or "no".
+#
 .endif  # CHECK_BUILTIN.foo
 The first section sets IS_BUILTIN.pkg depending on if pkg really exists in the
 base system. This should not be a base system software with similar
 functionality to pkg; it should only be "yes" if the actual package is included
 as part of the base system. This variable is only used internally within the
 builtin.mk file.
 The second section sets BUILTIN_PKG.pkg to the version of pkg in the base
 system if it exists (if IS_BUILTIN.pkg is "yes"). This variable is only used
 internally within the builtin.mk file.
 The third section sets USE_BUILTIN.pkg and is required in all builtin.mk files.
 The code in this section must make the determination whether the built-in
 software is adequate to satisfy the dependencies listed in
 BUILDLINK_API_DEPENDS.pkg. This is typically done by comparing BUILTIN_PKG.pkg
 against each of the dependencies in BUILDLINK_API_DEPENDS.pkg. USE_BUILTIN.pkg
 must be set to the correct value by the end of the builtin.mk file. Note that
 USE_BUILTIN.pkg may be "yes" even if IS_BUILTIN.pkg is "no" because we may make
 the determination that the built-in version of the software is similar enough
 to be used as a replacement.
 The last section is guarded by CHECK_BUILTIN.pkg, and includes code that uses
 the value of USE_BUILTIN.pkg set in the previous section. This typically
 includes, e.g., adding additional dependency restrictions and listing
 additional files to symlink into ${BUILDLINK_DIR} (via BUILDLINK_FILES.pkg).
 .3.2. Global preferences for native or pkgsrc software
 When building packages, it's possible to choose whether to set a global
 preference for using either the built-in (native) version or the pkgsrc version
 of software to satisfy a dependency. This is controlled by setting
 PREFER_PKGSRC and PREFER_NATIVE. These variables take values of either "yes", "
 no", or a list of packages. PREFER_PKGSRC tells pkgsrc to use the pkgsrc
 versions of software, while PREFER_NATIVE tells pkgsrc to use the built-in
 versions. Preferences are determined by the most specific instance of the
 package in either PREFER_PKGSRC or PREFER_NATIVE. If a package is specified in
 neither or in both variables, then PREFER_PKGSRC has precedence over
 PREFER_NATIVE. For example, to require using pkgsrc versions of software for
 all but the most basic bits on a NetBSD system, you can set:
 PREFER_PKGSRC=  yes
 PREFER_NATIVE=  getopt skey tcp_wrappers
 A package must have a builtin.mk file to be listed in PREFER_NATIVE, otherwise
 it is simply ignored in that list.
 Chapter 15. The pkginstall framework
 Table of Contents
 .1. Files and directories outside the installation prefix
 .1.1. Directory manipulation
 .1.2. File manipulation
 .2. Configuration files
 .2.1. How PKG_SYSCONFDIR is set
 .2.2. Telling the software where configuration files are
 .2.3. Patching installations
 .2.4. Disabling handling of configuration files
 .3. System startup scripts
 .3.1. Disabling handling of system startup scripts
 .4. System users and groups
 .5. System shells
 .5.1. Disabling shell registration
 .6. Fonts
 .6.1. Disabling automatic update of the fonts databases
 This chapter describes the framework known as pkginstall, whose key features
 are:
   * Generic installation and manipulation of directories and files outside the
     pkgsrc-handled tree, LOCALBASE.
   * Automatic handling of configuration files during installation, provided
     that packages are correctly designed.
   * Generation and installation of system startup scripts.
   * Registration of system users and groups.
   * Registration of system shells.
   * Automatic updating of fonts databases.
 The following sections inspect each of the above points in detail.
 You may be thinking that many of the things described here could be easily done
 with simple code in the package's post-installation target (post-install). This
 is incorrect, as the code in them is only executed when building from source.
 Machines using binary packages could not benefit from it at all (as the code
 itself could be unavailable). Therefore, the only way to achieve any of the
 items described above is by means of the installation scripts, which are
 automatically generated by pkginstall.
 .1. Files and directories outside the installation prefix
 As you already know, the PLIST file holds a list of files and directories that
 belong to a package. The names used in it are relative to the installation
 prefix (${PREFIX}), which means that it cannot register files outside this
 directory (absolute path names are not allowed). Despite this restriction, some
 packages need to install files outside this location; e.g., under ${VARBASE} or
 ${PKG_SYSCONFDIR}. The only way to achieve this is to create such files during
 installation time by using installation scripts.
 The generic installation scripts are shell scripts that can contain arbitrary
 code. The list of scripts to execute is taken from the INSTALL_FILE variable,
 which defaults to INSTALL. A similar variable exists for package removal
 (DEINSTALL_FILE, whose default is DEINSTALL). These scripts can run arbitrary
 commands, so they have the potential to create and manage files anywhere in the
 file system.
 Using these general installation files is not recommended, but may be needed in
 some special cases. One reason for avoiding them is that the user has to trust
 the packager that there is no unwanted or simply erroneous code included in the
 installation script. Also, previously there were many similar scripts for the
 same functionality, and fixing a common error involved finding and changing all
 of them.
 The pkginstall framework offers another, standardized way. It provides generic
 scripts to abstract the manipulation of such files and directories based on
 variables set in the package's Makefile. The rest of this section describes
 these variables.
 .1.1. Directory manipulation
 The following variables can be set to request the creation of directories
 anywhere in the file system:
   * MAKE_DIRS and OWN_DIRS contain a list of directories that should be created
     and should attempt to be destroyed by the installation scripts. The
     difference between the two is that the latter prompts the administrator to
     remove any directories that may be left after deinstallation (because they
     were not empty), while the former does not.
   * MAKE_DIRS_PERMS and OWN_DIRS_PERMS contain a list of tuples describing
     which directories should be created and should attempt to be destroyed by
     the installation scripts. Each tuple holds the following values, separated
     by spaces: the directory name, its owner, its group and its numerical mode.
     For example:
     MAKE_DIRS_PERMS+=         ${VARBASE}/foo/private ${ROOT_USER} ${ROOT_GROUP} 0700
     The difference between the two is exactly the same as their non-PERMS
     counterparts.
 .1.2. File manipulation
 Creating non-empty files outside the installation prefix is tricky because the
 PLIST forces all files to be inside it. To overcome this problem, the only
 solution is to extract the file in the known place (i.e., inside the
 installation prefix) and copy it to the appropriate location during
 installation (done by the installation scripts generated by pkginstall). We
 will call the former the master file in the following paragraphs, which
 describe the variables that can be used to automatically and consistently
 handle files outside the installation prefix:
   * CONF_FILES and REQD_FILES are pairs of master and target files. During
     installation time, the master file is copied to the target one if and only
     if the latter does not exist. Upon deinstallation, the target file is
     removed provided that it was not modified by the installation.
     The difference between the two is that the latter prompts the administrator
     to remove any files that may be left after deinstallation (because they
     were not empty), while the former does not.
   * CONF_FILES_PERMS and REQD_FILES_PERMS contain tuples describing master
     files as well as their target locations. For each of them, it also
     specifies their owner, their group and their numeric permissions, in this
     order. For example:
     REQD_FILES_PERMS+= ${PREFIX}/share/somefile ${VARBASE}/somefile ${ROOT_USER} ${ROOT_GROUP} 0700
     The difference between the two is exactly the same as their non-PERMS
     counterparts.
 .2. Configuration files
 Configuration files are special in the sense that they are installed in their
 own specific directory, PKG_SYSCONFDIR, and need special treatment during
 installation (most of which is automated by pkginstall). The main concept you
 must bear in mind is that files marked as configuration files are automatically
 copied to the right place (somewhere inside PKG_SYSCONFDIR) during installation
 if and only if they didn't exist before. Similarly, they will not be removed if
 they have local modifications. This ensures that administrators never lose any
 custom changes they may have made.
 .2.1. How PKG_SYSCONFDIR is set
 As said before, the PKG_SYSCONFDIR variable specifies where configuration files
 shall be installed. Its contents are set based upon the following variables:
   * PKG_SYSCONFBASE: The configuration's root directory. Defaults to ${PREFIX}/
     etc although it may be overridden by the user to point to his preferred
     location (e.g., /etc, /etc/pkg, etc.). Packages must not use it directly.
   * PKG_SYSCONFSUBDIR: A subdirectory of PKG_SYSCONFBASE under which the
     configuration files for the package being built shall be installed. The
     definition of this variable only makes sense in the package's Makefile
     (i.e., it is not user-customizable).
     As an example, consider the Apache package, www/apache2, which places its
     configuration files under the httpd/ subdirectory of PKG_SYSCONFBASE. This
     should be set in the package Makefile.
   * PKG_SYSCONFVAR: Specifies the name of the variable that holds this
     package's configuration directory (if different from PKG_SYSCONFBASE). It
     defaults to PKGBASE's value, and is always prefixed with PKG_SYSCONFDIR.
   * PKG_SYSCONFDIR.${PKG_SYSCONFVAR}: Holds the directory where the
     configuration files for the package identified by PKG_SYSCONFVAR's shall be
     placed.
 Based on the above variables, pkginstall determines the value of
 PKG_SYSCONFDIR, which is the only variable that can be used within a package to
 refer to its configuration directory. The algorithm used to set its value is
 basically the following:
 . If PKG_SYSCONFDIR.${PKG_SYSCONFVAR} is set, its value is used.
 . If the previous variable is not defined but PKG_SYSCONFSUBDIR is set in the
     package's Makefile, the resulting value is ${PKG_SYSCONFBASE}/$
     {PKG_SYSCONFSUBDIR}.
 . Otherwise, it is set to ${PKG_SYSCONFBASE}.
 It is worth mentioning that ${PKG_SYSCONFDIR} is automatically added to
 OWN_DIRS. See Section 15.1.1, "Directory manipulation" what this means. This
 does not apply to subdirectories of ${PKG_SYSCONFDIR}, they still have to be
 created with OWN_DIRS or MAKE_DIRS.
 .2.2. Telling the software where configuration files are
 Given that pkgsrc (and users!) expect configuration files to be in a known
 place, you need to teach each package where it shall install its files. In some
 cases you will have to patch the package Makefiles to achieve it. If you are
 lucky, though, it may be as easy as passing an extra flag to the configuration
 script; this is the case of GNU Autoconf- generated files:
 CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
 Note that this specifies where the package has to look for its configuration
 files, not where they will be originally installed (although the difference is
 never explicit, unfortunately).
 .2.3. Patching installations
 As said before, pkginstall automatically handles configuration files. This
 means that the packages themselves must not touch the contents of $
 {PKG_SYSCONFDIR} directly. Bad news is that many software installation scripts
 will, out of the box, mess with the contents of that directory. So what is the
 correct procedure to fix this issue?
 You must teach the package (usually by manually patching it) to install any
 configuration files under the examples hierarchy, share/examples/${PKGBASE}/.
 This way, the PLIST registers them and the administrator always has the
 original copies available.
 Once the required configuration files are in place (i.e., under the examples
 hierarchy), the pkginstall framework can use them as master copies during the
 package installation to update what is in ${PKG_SYSCONFDIR}. To achieve this,
 the variables CONF_FILES and CONF_FILES_PERMS are used. Check out
 Section 15.1.2, "File manipulation" for information about their syntax and
 their purpose. Here is an example, taken from the mail/mutt package:
 EGDIR=        ${PREFIX}/share/doc/mutt/samples
 CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
 Note that the EGDIR variable is specific to that package and has no meaning
 outside it.
 .2.4. Disabling handling of configuration files
 The automatic copying of config files can be toggled by setting the environment
 variable PKG_CONFIG prior to package installation.
 .3. System startup scripts
 System startup scripts are special files because they must be installed in a
 place known by the underlying OS, usually outside the installation prefix.
 Therefore, the same rules described in Section 15.1, "Files and directories
 outside the installation prefix" apply, and the same solutions can be used.
 However, pkginstall provides a special mechanism to handle these files.
 In order to provide system startup scripts, the package has to:
 . Store the script inside ${FILESDIR}, with the .sh suffix appended.
     Considering the print/cups package as an example, it has a cupsd.sh in its
     files directory.
 . Tell pkginstall to handle it, appending the name of the script, without its
     extension, to the RCD_SCRIPTS variable. Continuing the previous example:
     RCD_SCRIPTS+=   cupsd
 Once this is done, pkginstall will do the following steps for each script in an
 automated fashion:
 . Process the file found in the files directory applying all the
     substitutions described in the FILES_SUBST variable.
 . Copy the script from the files directory to the examples hierarchy, $
     {PREFIX}/share/examples/rc.d/. Note that this master file must be
     explicitly registered in the PLIST.
 . Add code to the installation scripts to copy the startup script from the
     examples hierarchy into the system-wide startup scripts directory.
 .3.1. Disabling handling of system startup scripts
 The automatic copying of config files can be toggled by setting the environment
 variable PKG_RCD_SCRIPTS prior to package installation. Note that the scripts
 will be always copied inside the examples hierarchy, ${PREFIX}/share/examples/
 rc.d/, no matter what the value of this variable is.
 .4. System users and groups
 If a package needs to create special users and/or groups during installation,
 it can do so by using the pkginstall framework.
 Users can be created by adding entries to the PKG_USERS variable. Each entry
 has the following syntax:
 user:group
 Further specification of user details may be done by setting per-user
 variables. PKG_UID.user is the numeric UID for the user. PKG_GECOS.user is the
 user's description or comment. PKG_HOME.user is the user's home directory, and
 defaults to /nonexistent if not specified. PKG_SHELL.user is the user's shell,
 and defaults to /sbin/nologin if not specified.
 Similarly, groups can be created by adding entries to the PKG_GROUPS variable,
 whose syntax is:
 group
 The numeric GID of the group may be set by defining PKG_GID.group.
 If a package needs to create the users and groups at an earlier stage, then it
 can set USERGROUP_PHASE to either configure or build to indicate the phase
 before which the users and groups are created. In this case, the numeric UIDs
 and GIDs of the created users and groups are automatically hardcoded into the
 final installation scripts.
 .5. System shells
 Packages that install system shells should register them in the shell database,
 /etc/shells, to make things easier to the administrator. This must be done from
 the installation scripts to keep binary packages working on any system.
 pkginstall provides an easy way to accomplish this task.
 When a package provides a shell interpreter, it has to set the PKG_SHELL
 variable to its absolute file name. This will add some hooks to the
 installation scripts to handle it. Consider the following example, taken from
 shells/zsh:
 PKG_SHELL=      ${PREFIX}/bin/zsh
 .5.1. Disabling shell registration
 The automatic registration of shell interpreters can be disabled by the
 administrator by setting the PKG_REGISTER_SHELLS environment variable to NO.
 .6. Fonts
 Packages that install X11 fonts should update the database files that index the
 fonts within each fonts directory. This can easily be accomplished within the
 pkginstall framework.
 When a package installs X11 fonts, it must list the directories in which fonts
 are installed in the FONTS_DIRS.type variables, where type can be one of "ttf",
 "type1" or "x11". This will add hooks to the installation scripts to run the
 appropriate commands to update the fonts database files within each of those
 directories. For convenience, if the directory path is relative, it is taken to
 be relative to the package's installation prefix. Consider the following
 example, taken from fonts/dbz-ttf:
 FONTS_DIRS.ttf= ${PREFIX}/lib/X11/fonts/TTF
 .6.1. Disabling automatic update of the fonts databases
 The automatic update of fonts databases can be disabled by the administrator by
 setting the PKG_UPDATE_FONTS_DB environment variable to NO.
 Chapter 16. Options handling
 Table of Contents
 .1. Global default options
 .2. Converting packages to use bsd.options.mk
 .3. Option Names
 .4. Determining the options of dependencies
 Many packages have the ability to be built to support different sets of
 features. bsd.options.mk is a framework in pkgsrc that provides generic
 handling of those options that determine different ways in which the packages
 can be built. It's possible for the user to specify exactly which sets of
 options will be built into a package or to allow a set of global default
 options apply.
 There are two broad classes of behaviors that one might want to control via
 options. One is whether some particular feature is enabled in a program that
 will be built anyway, often by including or not including a dependency on some
 other package. The other is whether or not an additional program will be built
 as part of the package. Generally, it is better to make a split package for
 such additional programs instead of using options, because it enables binary
 packages to be built which can then be added separately. For example, the foo
 package might have minimal dependencies (those packages without which foo
 doesn't make sense), and then the foo-gfoo package might include the GTK
 frontend program gfoo. This is better than including a gtk option to foo that
 adds gfoo, because either that option is default, in which case binary users
 can't get foo without gfoo, or not default, in which case they can't get gfoo.
 With split packages, they can install foo without having GTK, and later decide
 to install gfoo (pulling in GTK at that time). This is an advantage to source
 users too, avoiding the need for rebuilds.
 Plugins with widely varying dependencies should usually be split instead of
 options.
 It is often more work to maintain split packages, especially if the upstream
 package does not support this. The decision of split vs. option should be made
 based on the likelihood that users will want or object to the various pieces,
 the size of the dependencies that are included, and the amount of work.
 A further consideration is licensing. Non-free parts, or parts that depend on
 non-free dependencies (especially plugins) should almost always be split if
 feasible.
 .1. Global default options
 Global default options are listed in PKG_DEFAULT_OPTIONS, which is a list of
 the options that should be built into every package if that option is
 supported. This variable should be set in mk.conf.
 .2. Converting packages to use bsd.options.mk
 The following example shows how bsd.options.mk should be used by the
 hypothetical ``wibble'' package, either in the package Makefile, or in a file,
 e.g. options.mk, that is included by the main package Makefile.
 PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
 PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
 PKG_OPTIONS_OPTIONAL_GROUPS=    database
 PKG_OPTIONS_GROUP.database=     mysql pgsql
 PKG_SUGGESTED_OPTIONS=          wibble-foo
 PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
 PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
 .include "../../mk/bsd.prefs.mk"
 # this package was previously named wibble2
 .if defined(PKG_OPTIONS.wibble2)
 PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
 PKG_OPTIONS_DEPRECATED_WARNINGS+= \
         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
 .endif
 .include "../../mk/bsd.options.mk"
 # Package-specific option-handling
 ###
 ### FOO support
 ###
 .if !empty(PKG_OPTIONS:Mwibble-foo)
 CONFIGURE_ARGS+=    --enable-foo
 .endif
 ###
 ### LDAP support
 ###
 .if !empty(PKG_OPTIONS:Mldap)
 .  include "../../databases/openldap-client/buildlink3.mk"
 CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
 .endif
 ###
 ### database support
 ###
 .if !empty(PKG_OPTIONS:Mmysql)
 .  include "../../mk/mysql.buildlink3.mk"
 .endif
 .if !empty(PKG_OPTIONS:Mpgsql)
 .  include "../../mk/pgsql.buildlink3.mk"
 .endif
 The first section contains the information about which build options are
 supported by the package, and any default options settings if needed.
 . PKG_OPTIONS_VAR is the name of the make(1) variable that the user can set
     to override the default options. It should be set to PKG_OPTIONS.pkgbase.
     Do not set it to PKG_OPTIONS.${PKGBASE}, since PKGBASE is not defined at
     the point where the options are processed.
 . PKG_SUPPORTED_OPTIONS is a list of build options supported by the package.
 . PKG_OPTIONS_OPTIONAL_GROUPS is a list of names of groups of mutually
     exclusive options. The options in each group are listed in
     PKG_OPTIONS_GROUP.groupname. The most specific setting of any option from
     the group takes precedence over all other options in the group. Options
     from the groups will be automatically added to PKG_SUPPORTED_OPTIONS.
 . PKG_OPTIONS_REQUIRED_GROUPS is like PKG_OPTIONS_OPTIONAL_GROUPS, but
     building the packages will fail if no option from the group is selected.
 . PKG_OPTIONS_NONEMPTY_SETS is a list of names of sets of options. At least
     one option from each set must be selected. The options in each set are
     listed in PKG_OPTIONS_SET.setname. Options from the sets will be
     automatically added to PKG_SUPPORTED_OPTIONS. Building the package will
     fail if no option from the set is selected.
 . PKG_SUGGESTED_OPTIONS is a list of build options which are enabled by
     default.
 . PKG_OPTIONS_LEGACY_VARS is a list of "USE_VARIABLE:option" pairs that map
     legacy mk.conf variables to their option counterparts. Pairs should be
     added with "+=" to keep the listing of global legacy variables. A warning
     will be issued if the user uses a legacy variable.
 . PKG_OPTIONS_LEGACY_OPTS is a list of "old-option:new-option" pairs that map
     options that have been renamed to their new counterparts. Pairs should be
     added with "+=" to keep the listing of global legacy options. A warning
     will be issued if the user uses a legacy option.
 . PKG_LEGACY_OPTIONS is a list of options implied by deprecated variables
     used. This can be used for cases that neither PKG_OPTIONS_LEGACY_VARS nor
     PKG_OPTIONS_LEGACY_OPTS can handle, e. g. when PKG_OPTIONS_VAR is renamed.
 . PKG_OPTIONS_DEPRECATED_WARNINGS is a list of warnings about deprecated
     variables or options used, and what to use instead.
 A package should never modify PKG_DEFAULT_OPTIONS or the variable named in
 PKG_OPTIONS_VAR. These are strictly user-settable. To suggest a default set of
 options, use PKG_SUGGESTED_OPTIONS.
 PKG_OPTIONS_VAR must be defined before including bsd.options.mk. If none of
 PKG_SUPPORTED_OPTIONS, PKG_OPTIONS_OPTIONAL_GROUPS, and
 PKG_OPTIONS_REQUIRED_GROUPS are defined (as can happen with platform-specific
 options if none of them is supported on the current platform), PKG_OPTIONS is
 set to the empty list and the package is otherwise treated as not using the
 options framework.
 After the inclusion of bsd.options.mk, the variable PKG_OPTIONS contains the
 list of selected build options, properly filtered to remove unsupported and
 duplicate options.
 The remaining sections contain the logic that is specific to each option. The
 correct way to check for an option is to check whether it is listed in
 PKG_OPTIONS:
 .if !empty(PKG_OPTIONS:Moption)
 .3. Option Names
 Options that enable similar features in different packages (like optional
 support for a library) should use a common name in all packages that support it
 (like the name of the library). If another package already has an option with
 the same meaning, use the same name.
 Options that enable features specific to one package, where it's unlikely that
 another (unrelated) package has the same (or a similar) optional feature,
 should use a name prefixed with pkgname-.
 If a group of related packages share an optional feature specific to that
 group, prefix it with the name of the "main" package (e. g.
 djbware-errno-hack).
 For new options, add a line to mk/defaults/options.description. Lines have two
 fields, separated by tab. The first field is the option name, the second its
 description. The description should be a whole sentence (starting with an
 uppercase letter and ending with a period) that describes what enabling the
 option does. E. g. "Enable ispell support." The file is sorted by option names.
 .4. Determining the options of dependencies
 When writing buildlink3.mk files, it is often necessary to list different
 dependencies based on the options with which the package was built. For
 querying these options, the file pkgsrc/mk/pkg-build-options.mk should be used.
 A typical example looks like this:
 pkgbase := libpurple
 .include "../../mk/pkg-build-options.mk"
 .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
 ...
 .endif
 Including pkg-build-options.mk here will set the variable
 PKG_BUILD_OPTIONS.libpurple to the build options of the libpurple package,
 which can then be queried like PKG_OPTIONS in the options.mk file. See the file
 pkg-build-options.mk for more details.
 Chapter 17. The build process
 Table of Contents
 .1. Introduction
 .2. Program location
 .3. Directories used during the build process
 .4. Running a phase
 .5. The fetch phase
 .5.1. What to fetch and where to get it from
 .5.2. How are the files fetched?
 .6. The checksum phase
 .7. The extract phase
 .8. The patch phase
 .9. The tools phase
 .10. The wrapper phase
 .11. The configure phase
 .12. The build phase
 .13. The test phase
 .14. The install phase
 .15. The package phase
 .16. Cleaning up
 .17. Other helpful targets
 .1. Introduction
 This chapter gives a detailed description on how a package is built. Building a
 package is separated into different phases (for example fetch, build, install),
 all of which are described in the following sections. Each phase is split into
 so-called stages, which take the name of the containing phase, prefixed by one
 of pre-, do- or post-. (Examples are pre-configure, post-build.) Most of the
 actual work is done in the do-* stages.
 Never override the regular targets (like fetch), if you have to, override the
 do-* ones instead.
 The basic steps for building a program are always the same. First the program's
 source (distfile) must be brought to the local system and then extracted. After
 any pkgsrc-specific patches to compile properly are applied, the software can
 be configured, then built (usually by compiling), and finally the generated
 binaries, etc. can be put into place on the system.
 To get more details about what is happening at each step, you can set the
 PKG_VERBOSE variable, or the PATCH_DEBUG variable if you are just interested in
 more details about the patch step.
 .2. Program location
 Before outlining the process performed by the NetBSD package system in the next
 section, here's a brief discussion on where programs are installed, and which
 variables influence this.
 The automatic variable PREFIX indicates where all files of the final program
 shall be installed. It is usually set to LOCALBASE (/usr/pkg), or CROSSBASE for
 pkgs in the cross category. The value of PREFIX needs to be put into the
 various places in the program's source where paths to these files are encoded.
 See Section 11.3, "patches/*" and Section 19.3.1, "Shared libraries - libtool"
 for more details.
 When choosing which of these variables to use, follow the following rules:
   * PREFIX always points to the location where the current pkg will be
     installed. When referring to a pkg's own installation path, use "${PREFIX}"
+    .
   * LOCALBASE is where all non-X11 pkgs are installed. If you need to construct
     a -I or -L argument to the compiler to find includes and libraries
     installed by another non-X11 pkg, use "${LOCALBASE}". The name LOCALBASE
     stems from FreeBSD, which installed all packages in /usr/local. As pkgsrc
     leaves /usr/local for the system administrator, this variable is a
     misnomer.
   * X11BASE is where the actual X11 distribution (from xsrc, etc.) is
     installed. When looking for standard X11 includes (not those installed by a
     package), use "${X11BASE}".
   * X11-based packages are special in that they may be installed in either
     X11BASE or LOCALBASE.
     Usually, X11 packages should be installed under LOCALBASE whenever
     possible. Note that you will need to include ../../mk/x11.buildlink3.mk in
     them to request the presence of X11 and to get the right compilation flags.
     Even though, there are some packages that cannot be installed under
     LOCALBASE: those that come with app-defaults files. These packages are
     special and they must be placed under X11BASE. To accomplish this, set
     either USE_X11BASE or USE_IMAKE in your package.
     Some notes: If you need to find includes or libraries installed by a pkg
     that has USE_IMAKE or USE_X11BASE in its pkg Makefile, you need to look in
     both ${X11BASE} and ${LOCALBASE}. To force installation of all X11 packages
     in LOCALBASE, the pkgtools/xpkgwedge package is enabled by default.
   * X11PREFIX should be used to refer to the installed location of an X11
     package. X11PREFIX will be set to X11BASE if xpkgwedge is not installed,
     and to LOCALBASE if xpkgwedge is installed.
   * If xpkgwedge is installed, it is possible to have some packages installed
     in X11BASE and some in LOCALBASE. To determine the prefix of an installed
     package, the EVAL_PREFIX definition can be used. It takes pairs in the
     format "DIRNAME=<package>", and the make(1) variable DIRNAME will be set to
     the prefix of the installed package <package>, or "${X11PREFIX}" if the
     package is not installed.
     This is best illustrated by example.
     The following lines are taken from pkgsrc/wm/scwm/Makefile:
     EVAL_PREFIX+=           GTKDIR=gtk+
     CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
     CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
     CONFIGURE_ARGS+=        --enable-multibyte
     Specific defaults can be defined for the packages evaluated using
     EVAL_PREFIX, by using a definition of the form:
     GTKDIR_DEFAULT= ${LOCALBASE}
     where GTKDIR corresponds to the first definition in the EVAL_PREFIX pair.
   * Within ${PREFIX}, packages should install files according to hier(7), with
     the exception that manual pages go into ${PREFIX}/man, not ${PREFIX}/share/
     man.
 .3. Directories used during the build process
 When building a package, various directories are used to store source files,
 temporary files, pkgsrc-internal files, and so on. These directories are
 explained here.
 Some of the directory variables contain relative pathnames. There are two
 common base directories for these relative directories: PKGSRCDIR/PKGPATH is
 used for directories that are pkgsrc-specific. WRKSRC is used for directories
 inside the package itself.
 PKGSRCDIR
     This is an absolute pathname that points to the pkgsrc root directory.
     Generally, you don't need it.
 PKGDIR
     This is an absolute pathname that points to the current package.
 PKGPATH
     This is a pathname relative to PKGSRCDIR that points to the current
     package.
 WRKDIR
     This is an absolute pathname pointing to the directory where all work takes
     place. The distfiles are extracted to this directory. It also contains
     temporary directories and log files used by the various pkgsrc frameworks,
     like buildlink or the wrappers.
 WRKSRC
     This is an absolute pathname pointing to the directory where the distfiles
     are extracted. It is usually a direct subdirectory of WRKDIR, and often
     it's the only directory entry that isn't hidden. This variable may be
     changed by a package Makefile.
 The CREATE_WRKDIR_SYMLINK definition takes either the value yes or no and
 defaults to no. It indicates whether a symbolic link to the WRKDIR is to be
 created in the pkgsrc entry's directory. If users would like to have their
 pkgsrc trees behave in a read-only manner, then the value of
 CREATE_WRKDIR_SYMLINK should be set to no.
 .4. Running a phase
 You can run a particular phase by typing make phase, where phase is the name of