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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.132     spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
1.148     asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75      rillig     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.217     jnemeth    33: <div><p class="copyright">Copyright © 1994-2016 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.29 2016/05/06 17:26:34 jnemeth Exp $</p></div>
1.148     asau       35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
1.210     leot       48: <dl class="toc">
1.75      rillig     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
1.157     asau       67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz        68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     69: </dl></dd>
                     70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     71: <dd><dl>
                     72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     74: </dl></dd>
                     75: </dl></dd>
                     76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     77: <dd><dl>
1.82      rillig     78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     80: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                     81: <dd><dl>
1.151     obache     82: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                     83: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                     84: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166     jnemeth    85: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
                     86: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
                     87: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
                     88: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
                     89: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
                     90: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
                     91: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75      rillig     92: </dl></dd>
                     93: </dl></dd>
                     94: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     95: <dd><dl>
                     96: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     97: <dd><dl>
                     98: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     99: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    100: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    101: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    102: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    103: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    104: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig    105: </dl></dd>
                    106: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    107: <dd><dl>
                    108: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    109: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    110: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    111: </dl></dd>
                    112: </dl></dd>
                    113: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    114: <dd><dl>
                    115: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    116: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    117: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       118: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       119: <dd><dl>
1.103     wiz       120: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       121: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    122: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       123: </dl></dd>
1.103     wiz       124: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    125: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    126: </dl></dd>
                    127: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    128: <dd><dl>
                    129: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    130: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    131: </dl></dd>
                    132: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    133: builds)</a></span></dt>
1.75      rillig    134: <dd><dl>
1.180     wiz       135: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    136: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    137: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    138: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau      139: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    140: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig    141: </dl></dd>
                    142: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    143: <dd><dl>
1.128     wiz       144: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    145: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    146: </dl></dd>
                    147: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    148: <dd><dl>
                    149: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194     bsiegert  150: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    151: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    152: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    153: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    154: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    155: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    156: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    157: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    158: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       159: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert  160: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    161: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    162: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    164: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    165: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    166: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    167: </dl></dd>
                    168: </dl></dd>
                    169: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    170: <dd><dl>
1.106     rillig    171: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    172: <dd><dl>
1.106     rillig    173: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig    174: <dd><dl>
1.106     rillig    175: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174     asau      176: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118     imil      177: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig    178: </dl></dd>
1.106     rillig    179: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    180: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                    181: </dl></dd>
                    182: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    183: <dd><dl>
1.128     wiz       184: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    185: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219   ! rillig    186: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig    187: <dd><dl>
                    188: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    189: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    192: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    193: </dl></dd>
                    194: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    195: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    196: <dd><dl>
                    197: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    198: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    199: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    200: </dl></dd>
1.128     wiz       201: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    202: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    203: </dl></dd>
1.128     wiz       204: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    205: <dd><dl>
                    206: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz       207: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig    208: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    209: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    210: <dd><dl>
                    211: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.219   ! rillig    212: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.2. Passing variables to a shell command</a></span></dt>
        !           213: <dt><span class="sect2"><a href="#quoting-guideline">12.3.3. Quoting guideline</a></span></dt>
1.106     rillig    214: </dl></dd>
                    215: </dl></dd>
                    216: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    217: <dd><dl>
                    218: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz       219: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    220: <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>
1.106     rillig    221: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    222: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz       223: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig    224: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz       225: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                    226: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106     rillig    227: </dl></dd>
                    228: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    229: <dd><dl>
                    230: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz       231: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    232: <dd><dl>
                    233: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz       234: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                    235:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    236:       and
                    237:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    238:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    239: </dl></dd>
1.128     wiz       240: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig    241: <dd><dl>
1.128     wiz       242: <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>
1.106     rillig    243: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    244: </dl></dd>
                    245: </dl></dd>
                    246: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    247: <dd><dl>
                    248: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    249: <dd><dl>
                    250: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    251: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    252: </dl></dd>
                    253: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    254: <dd><dl>
1.128     wiz       255: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig    256: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    257: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    258: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    259: </dl></dd>
                    260: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    261: <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>
                    262: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    263: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    264: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    265: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    266: <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>
                    267: </dl></dd>
                    268: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    269: <dd><dl>
                    270: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz       271: <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>
1.106     rillig    272: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig    273: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    274: </dl></dd>
                    275: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    276: <dd><dl>
                    277: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    278: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    279: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    280: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz       281: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    282: <dd><dl>
                    283: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    284: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    285: </dl></dd>
1.128     wiz       286: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    287: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    289: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    290: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    291: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    292: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    293: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    294: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    295: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig    296: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    297: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    298: </dl></dd>
                    299: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    300: <dd><dl>
                    301: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    302: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    303: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    304: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                    305: </dl></dd>
                    306: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    307: <dd><dl>
                    308: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    309: <dd><dl>
1.218     rillig    310: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    311: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                    312: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                    313: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                    314: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                    315: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                    316: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                    317: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    318: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                    319: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    320: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.106     rillig    321: </dl></dd>
1.218     rillig    322: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    323: <dd><dl>
                    324: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    325: <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>
1.199     tnn       326: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig    327: </dl></dd>
1.218     rillig    328: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig    329: <dd><dl>
                    330: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    331: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    332: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    333: </dl></dd>
                    334: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    335: <dd><dl>
                    336: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    337: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    338: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz       339: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                    340: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig    341: </dl></dd>
1.218     rillig    342: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig    343: <dd><dl>
                    344: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    345: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz       346: <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>
1.106     rillig    347: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    348: </dl></dd>
1.218     rillig    349: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig    350: <dd><dl>
                    351: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    352: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    353: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    354: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    355: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    356: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    357: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    358: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig    359: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka    360: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig    361: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    362: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    363: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    364: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    365: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    366: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    367: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    368: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz       369:     emulation</a></span></dt>
1.106     rillig    370: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    371: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    372: </dl></dd>
1.106     rillig    373: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig    374: </dl></dd>
1.106     rillig    375: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    376: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig    377: <dd><dl>
1.106     rillig    378: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    379: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    380: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz       381: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig    382: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed      383: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                    384: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig    385: </dl></dd>
                    386: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    387: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    388: <dd><dl>
                    389: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    390: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    391: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    392: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv      393: </dl></dd>
1.75      rillig    394: </dl></dd>
                    395: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    396: <dd><dl>
1.106     rillig    397: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    398: <dd><dl>
1.106     rillig    399: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    400: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    401: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig    402: <dd><dl>
1.106     rillig    403: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    404: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig    405: </dl></dd>
1.106     rillig    406: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    407: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    408: <dd><dl>
1.106     rillig    409: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    410: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    411: </dl></dd>
1.106     rillig    412: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig    413: <dd><dl>
1.128     wiz       414: <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>
                    415: <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>
1.75      rillig    416: </dl></dd>
                    417: </dl></dd>
1.106     rillig    418: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig    419: <dd><dl>
1.219   ! rillig    420: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
        !           421: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig    422: <dd><dl>
1.219   ! rillig    423: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
        !           424: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig    425: </dl></dd>
                    426: </dl></dd>
1.106     rillig    427: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.219   ! rillig    428: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig    429: </dl></dd>
                    430: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    431: <dd><dl>
                    432: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    433: <dd><dl>
                    434: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    435: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    436: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz       437: <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>
1.75      rillig    438: </dl></dd>
                    439: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    440: </dl></dd>
                    441: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    442: <dd><dl>
                    443: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    444: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    445: </dl></dd>
1.76      rillig    446: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    447: <dd><dl>
1.128     wiz       448: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    449: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    450: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    451: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    452: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                    453: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    454: source packages</a></span></dt>
                    455: </dl></dd>
1.75      rillig    456: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    457: <dd><dl>
1.79      rillig    458: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig    459: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    460: </dl></dd>
                    461: </dl>
                    462: </div>
1.82      rillig    463: <div class="list-of-tables">
                    464: <p><b>List of Tables</b></p>
                    465: <dl>
                    466: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    467: </dt>
1.106     rillig    468: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      469: </dt>
1.106     rillig    470: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      471: </dt>
1.82      rillig    472: </dl>
                    473: </div>
1.148     asau      474: <div class="chapter">
                    475: <div class="titlepage"><div><div><h1 class="title">
                    476: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    477: <div class="toc">
                    478: <p><b>Table of Contents</b></p>
1.210     leot      479: <dl class="toc">
1.75      rillig    480: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    481: <dd><dl>
                    482: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    483: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    484: </dl></dd>
1.75      rillig    485: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    486: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       487: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig    488: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    489: </dl>
                    490: </div>
1.148     asau      491: <div class="sect1">
1.75      rillig    492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    493: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    494: <p>There is a lot of software freely available for Unix-based
                    495: systems, which is usually available in form of the source code. Before
                    496: such software can be used, it needs to be configured to the local
                    497: system, compiled and installed, and this is exactly what The NetBSD
                    498: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    499: to handle binary packages, so that not every user has to build the
                    500: packages for himself, which is a time-costly task.</p>
1.75      rillig    501: <p>pkgsrc currently contains several thousand packages,
                    502:       including:</p>
1.148     asau      503: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.214     sevan     504: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75      rillig    505:          web server</p></li>
1.189     snj       506: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    507:          web browser</p></li>
1.189     snj       508: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    509:          Desktop Environment</p></li>
1.212     ryoon     510: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75      rillig    511:          Desktop Environment</p></li>
                    512: </ul></div>
1.219   ! rillig    513: <p>&#8230; just to name a few.</p>
1.75      rillig    514: <p>pkgsrc has built-in support for handling varying dependencies,
                    515:       such as pthreads and X11, and extended features such as IPv6 support on
                    516:       a range of platforms.</p>
1.148     asau      517: <div class="sect2">
1.82      rillig    518: <div class="titlepage"><div><div><h3 class="title">
                    519: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    520: <p>
                    521: pkgsrc provides the following key features:
                    522: </p>
1.148     asau      523: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       524: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    525:   and installation of binary packages. The source and latest
                    526:   patches are retrieved from a master or mirror download site, checksum
                    527:   verified, then built on your system. Support for binary-only
                    528:   distributions is available for both native platforms and NetBSD
                    529:   emulated platforms.</p></li>
1.128     wiz       530: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    531:   including binaries, libraries, man pages and other
                    532:   documentation.</p></li>
1.214     sevan     533: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    534:   performing updates, to ensure required packages are installed. The
                    535:   configuration files of various packages are handled automatically during
                    536:   updates, so local changes are preserved.</p></li>
1.128     wiz       537: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    538:   consists of highly portable code. This allows the greatest speed of
1.132     spz       539:   development when porting to a new platform. This portability also
1.82      rillig    540:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    541:   platforms</em></span>.</p></li>
1.128     wiz       542: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    543:   international encryption requirements and build-time options for a
                    544:   large number of packages are all set in a simple, central
                    545:   configuration file.</p></li>
1.128     wiz       546: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    547:   freely available under a BSD license, so you may extend and adapt
                    548:   pkgsrc to your needs. Support for local packages and patches is
                    549:   available right out of the box, so you can configure it specifically
                    550:   for your environment.</p></li>
                    551: </ul></div>
1.91      rillig    552: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      553: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       554: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.126     jakllsch  555: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    556: them and to complain about them rather than to just install the package
                    557: and hope that it works. There are numerous checks in pkgsrc that try to
1.189     snj       558: find such bugs: Static analysis tools (<a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91      rillig    559: of shell scripts), and post-installation checks (installed files,
                    560: references to shared libraries, script interpreters).</p></li>
1.128     wiz       561: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  562: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    563: pkgsrc has been ported to many operating systems. Care is taken that
                    564: packages behave the same on all platforms.</p></li>
                    565: </ul></div>
1.82      rillig    566: </div>
1.148     asau      567: <div class="sect2">
1.82      rillig    568: <div class="titlepage"><div><div><h3 class="title">
                    569: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    570: <p>pkgsrc consists of both a source distribution and a binary
                    571: distribution for these operating systems. After retrieving the required
                    572: source or binaries, you can be up and running with pkgsrc in just
                    573: minutes!</p>
1.75      rillig    574: <p>pkgsrc was derived from FreeBSD's ports system, and
                    575:       initially developed for NetBSD only. Since then, pkgsrc has
                    576:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    577: <div class="table">
                    578: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       579: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    580: <colgroup>
                    581: <col>
                    582: <col>
1.202     sevan     583: <col>
1.82      rillig    584: </colgroup>
                    585: <thead><tr>
                    586: <th>Platform</th>
                    587: <th>Date Support Added</th>
1.202     sevan     588: <th>Notes</th>
1.82      rillig    589: </tr></thead>
                    590: <tbody>
                    591: <tr>
1.110     hubertf   592: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    593: <td align="center">Aug 1997</td>
1.202     sevan     594: <td class="auto-generated"> </td>
1.82      rillig    595: </tr>
                    596: <tr>
1.110     hubertf   597: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    598: <td align="center">Mar 1999</td>
1.203     sevan     599: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.82      rillig    600: </tr>
                    601: <tr>
1.110     hubertf   602: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    603: <td align="center">Jun 1999</td>
1.203     sevan     604: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.82      rillig    605: </tr>
                    606: <tr>
                    607: <td>
1.110     hubertf   608:           <a class="ulink" href="http://developer.apple.com/darwin/" target="_top">Darwin</a>
                    609:           (<a class="ulink" href="http://developer.apple.com/macosx/" target="_top">Mac OS X</a>)
1.82      rillig    610:         </td>
                    611: <td align="center">Oct 2001</td>
1.203     sevan     612: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.82      rillig    613: </tr>
                    614: <tr>
1.110     hubertf   615: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    616: <td align="center">Nov 2002</td>
1.203     sevan     617: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.82      rillig    618: </tr>
                    619: <tr>
1.110     hubertf   620: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    621: <td align="center">Nov 2002</td>
1.203     sevan     622: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.82      rillig    623: </tr>
                    624: <tr>
1.110     hubertf   625: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    626: <td align="center">Dec 2002</td>
1.202     sevan     627: <td>
1.203     sevan     628:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    629:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.202     sevan     630:        </td>
1.82      rillig    631: </tr>
                    632: <tr>
                    633: <td>BSD/OS</td>
                    634: <td align="center">Dec 2003</td>
1.202     sevan     635: <td class="auto-generated"> </td>
1.82      rillig    636: </tr>
                    637: <tr>
1.110     hubertf   638: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    639: <td align="center">Dec 2003</td>
1.203     sevan     640: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.82      rillig    641: </tr>
                    642: <tr>
                    643: <td>
1.110     hubertf   644:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    645:           (Microsoft Windows Services for Unix)
                    646:         </td>
                    647: <td align="center">Mar 2004</td>
1.203     sevan     648: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82      rillig    649: </tr>
                    650: <tr>
1.110     hubertf   651: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    652: <td align="center">Oct 2004</td>
1.202     sevan     653: <td class="auto-generated"> </td>
1.82      rillig    654: </tr>
                    655: <tr>
1.110     hubertf   656: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    657: <td align="center">Nov 2004</td>
1.203     sevan     658: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.82      rillig    659: </tr>
1.98      wiz       660: <tr>
1.110     hubertf   661: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       662: <td align="center">Apr 2007</td>
1.203     sevan     663: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.98      wiz       664: </tr>
1.128     wiz       665: <tr>
                    666: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    667: <td align="center">Sep 2010</td>
1.203     sevan     668: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.128     wiz       669: </tr>
1.151     obache    670: <tr>
                    671: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  672: <td align="center">Jan 2011</td>
1.202     sevan     673: <td class="auto-generated"> </td>
1.151     obache    674: </tr>
                    675: <tr>
                    676: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
                    677: <td align="center">Nov 2011</td>
1.203     sevan     678: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.151     obache    679: </tr>
                    680: <tr>
                    681: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
                    682: <td align="center">Mar 2013</td>
1.203     sevan     683: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.151     obache    684: </tr>
1.166     jnemeth   685: <tr>
                    686: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
                    687: <td align="center">Jul 2013</td>
1.203     sevan     688: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166     jnemeth   689: </tr>
1.214     sevan     690: <tr>
                    691: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
                    692: <td align="center">Jun 2014</td>
                    693: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
                    694: </tr>
1.82      rillig    695: </tbody>
1.91      rillig    696: </table></div>
1.82      rillig    697: </div>
1.91      rillig    698: <br class="table-break">
1.82      rillig    699: </div>
1.75      rillig    700: </div>
1.148     asau      701: <div class="sect1">
1.75      rillig    702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    703: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    704: <p>This document is divided into three parts. The first,
1.110     hubertf   705:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    706:        describes how one can use one of the packages in the Package
                    707:        Collection, either by installing a precompiled binary package,
1.93      rillig    708:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   709:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75      rillig    710:        package so it can be easily built by other NetBSD users without
                    711:        knowing about the package's building details. The third part,
1.110     hubertf   712:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    713:        is intended for those who want to understand how pkgsrc is
                    714:        implemented.</p>
                    715: <p>This document is available in various formats:
1.110     hubertf   716:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75      rillig    717: </div>
1.148     asau      718: <div class="sect1">
1.75      rillig    719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    720: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       721: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    722:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    723:       terminology used within this document.</p>
1.148     asau      724: <div class="variablelist"><dl class="variablelist">
1.75      rillig    725: <dt><span class="term">Package</span></dt>
                    726: <dd><p>A set of files and building instructions
                    727:            that describe what's necessary
                    728:            to build a certain piece of software using
                    729:             pkgsrc. Packages are traditionally stored under
1.76      rillig    730:            <code class="filename">/usr/pkgsrc</code>.</p></dd>
1.75      rillig    731: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       732: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       733:          is part of the NetBSD operating system and can be bootstrapped
                    734:          to run on non-NetBSD operating systems as well.  It handles
                    735:          building (compiling), installing, and removing of
                    736:          packages.</p></dd>
1.75      rillig    737: <dt><span class="term">Distfile</span></dt>
                    738: <dd><p>This term describes the file or files that are
                    739:            provided by the author of the piece of software to
                    740:            distribute his work. All the changes necessary to build on
                    741:            NetBSD are reflected in the corresponding package. Usually
                    742:            the distfile is in the form of a compressed tar-archive,
                    743:            but other types are possible, too. Distfiles are usually
                    744:            stored below
1.76      rillig    745:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    746: <dt><span class="term">Port</span></dt>
                    747: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    748:            for what we call a package.
1.128     wiz       749:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    750:            architecture.</p></dd>
                    751: <dt><span class="term">Precompiled/binary package</span></dt>
                    752: <dd>
                    753: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    754:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    755:            file so it can be installed on machines of the same
                    756:            machine architecture without the need to
                    757:            recompile. Packages are usually generated in
1.76      rillig    758:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       759:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       760: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    761:            especially in the context of precompiled packages.</p>
                    762: </dd>
                    763: <dt><span class="term">Program</span></dt>
1.88      wiz       764: <dd><p>The piece of software to be installed which will be
                    765:          constructed from all the files in the distfile by the
                    766:          actions defined in the corresponding package.</p></dd>
1.75      rillig    767: </dl></div>
1.148     asau      768: <div class="sect2">
1.75      rillig    769: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       770: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      771: <div class="variablelist"><dl class="variablelist">
1.75      rillig    772: <dt><span class="term">pkgsrc users</span></dt>
                    773: <dd>
                    774: <p>The
                    775:        pkgsrc users are people who use the packages provided by pkgsrc.
                    776:        Typically they are system administrators. The people using the
1.128     wiz       777:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    778:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    779: <p>There are two kinds of pkgsrc users: Some only want to
                    780:        install pre-built binary packages. Others build the pkgsrc
                    781:        packages from source, either for installing them directly or for
1.110     hubertf   782:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.75      rillig    783:        documentation.</p>
                    784: </dd>
                    785: <dt><span class="term">package maintainers</span></dt>
                    786: <dd><p>A
1.110     hubertf   787:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.75      rillig    788: <dt><span class="term">infrastructure developers</span></dt>
                    789: <dd><p>These people are involved in all those files
1.76      rillig    790:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   791:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.75      rillig    792:        too.</p></dd>
                    793: </dl></div>
                    794: </div>
                    795: </div>
1.148     asau      796: <div class="sect1">
1.75      rillig    797: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    798: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    799: <p>When giving examples for commands, shell prompts are used to
                    800:       show if the command should/can be issued as root, or if
1.128     wiz       801:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.75      rillig    802:       <code class="prompt">#</code> for root's shell prompt, and a <code class="prompt">%</code> for users'
                    803:       shell prompt, assuming they use the C-shell or tcsh.</p>
                    804: </div>
                    805: </div>
1.148     asau      806: <div class="part">
1.75      rillig    807: <div class="titlepage"><div><div><h1 class="title">
                    808: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    809: <div class="toc">
                    810: <p><b>Table of Contents</b></p>
1.210     leot      811: <dl class="toc">
1.75      rillig    812: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    813: <dd><dl>
                    814: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    815: <dd><dl>
1.157     asau      816: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       817: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    818: </dl></dd>
                    819: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    820: <dd><dl>
                    821: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    822: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    823: </dl></dd>
                    824: </dl></dd>
                    825: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    826: <dd><dl>
1.82      rillig    827: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    828: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    829: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                    830: <dd><dl>
1.151     obache    831: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                    832: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                    833: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166     jnemeth   834: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
                    835: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
                    836: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
                    837: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
                    838: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
                    839: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
                    840: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75      rillig    841: </dl></dd>
                    842: </dl></dd>
                    843: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    844: <dd><dl>
                    845: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    846: <dd><dl>
                    847: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    848: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig    849: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    850: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    851: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    852: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    853: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig    854: </dl></dd>
                    855: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    856: <dd><dl>
                    857: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    858: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    859: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    860: </dl></dd>
                    861: </dl></dd>
                    862: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    863: <dd><dl>
                    864: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    865: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig    866: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz       867: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       868: <dd><dl>
1.103     wiz       869: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz       870: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    871: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       872: </dl></dd>
1.103     wiz       873: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    874: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig    875: </dl></dd>
                    876: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    877: <dd><dl>
                    878: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    879: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    880: </dl></dd>
                    881: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    882: builds)</a></span></dt>
1.75      rillig    883: <dd><dl>
1.180     wiz       884: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    885: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    886: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    887: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau      888: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    889: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig    890: </dl></dd>
                    891: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    892: <dd><dl>
1.128     wiz       893: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    894: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.106     rillig    895: </dl></dd>
                    896: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    897: <dd><dl>
                    898: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194     bsiegert  899: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    900: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    901: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    902: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    903: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    904: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    905: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    906: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    907: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       908: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert  909: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    910: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    911: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    912: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    913: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    914: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    915: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    916: </dl></dd>
                    917: </dl>
                    918: </div>
1.148     asau      919: <div class="chapter">
1.75      rillig    920: <div class="titlepage"><div><div><h2 class="title">
                    921: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    922: <div class="toc">
                    923: <p><b>Table of Contents</b></p>
1.210     leot      924: <dl class="toc">
1.75      rillig    925: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    926: <dd><dl>
1.157     asau      927: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.128     wiz       928: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    929: </dl></dd>
                    930: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    931: <dd><dl>
                    932: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    933: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    934: </dl></dd>
                    935: </dl>
                    936: </div>
1.91      rillig    937: <p>Before you download and extract the files, you need to decide
                    938: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    939: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    940: free to install the sources and binary packages wherever you want in
                    941: your filesystem, provided that the pathname does not contain white-space
                    942: or other characters that are interpreted specially by the shell and some
                    943: other programs. A safe bet is to use only letters, digits, underscores
                    944: and dashes.</p>
1.148     asau      945: <div class="sect1">
1.75      rillig    946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    947: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    948: <p>Before you download any pkgsrc files, you should decide
                    949:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    950:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    951:        quarterly basis from the current branch and only gets modified
                    952:        for security updates. The names of the stable branches are built
                    953:        from the year and the quarter, for example
1.188     snj       954:        <code class="literal">2014Q3</code>.</p>
1.75      rillig    955: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz       956:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    957:        Both ways are described here.</p>
1.157     asau      958: <p>Note that tar archive contains CVS working copy.
                    959:        Thus you can switch to using CVS at any later time.</p>
1.148     asau      960: <div class="sect2">
1.75      rillig    961: <div class="titlepage"><div><div><h3 class="title">
1.157     asau      962: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.75      rillig    963: <p>The primary download location for all pkgsrc files is
1.157     asau      964:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
                    965:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    966:        (it points to the same location).
                    967:        There are a number of subdirectories for different purposes,
                    968:        which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
                    969: <p>The tar archive for the current branch is in the directory
                    970:        <code class="filename">current</code> and is called <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.75      rillig    971:        It is autogenerated daily.</p>
1.157     asau      972: <p>To save download time we provide bzip2- and
                    973:        xz-compressed archives which are published at
                    974:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
                    975:        and
                    976:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
                    977:        respectively.
                    978:        </p>
                    979: <p>You can fetch the same files using FTP.</p>
1.188     snj       980: <p>The tar file for the stable branch 2014Q3 is in the
                    981:        directory <code class="filename">pkgsrc-2014Q3</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2014Q3/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.112     weinem    982: <p>To download a pkgsrc stable tarball, run:</p>
                    983: <pre class="screen">
1.166     jnemeth   984: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/<em class="replaceable"><code>pkgsrc-20xxQy</code></em>/pkgsrc.tar.gz</code></strong></pre>
1.126     jakllsch  985: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.112     weinem    986:        stable branch to be downloaded, for example, 
1.188     snj       987:        <span class="quote">&#8220;<span class="quote">pkgsrc-2014Q3</span>&#8221;</span>.</p>
                    988: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau      989:        or your web browser.</p>
1.112     weinem    990: <p>Then, extract it with:</p>
1.188     snj       991: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem    992: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    993:        in <code class="filename">/usr/</code> and all the package source will be 
                    994:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    995: <p>To download pkgsrc-current, run:</p>
                    996: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75      rillig    997: </div>
1.148     asau      998: <div class="sect2">
1.75      rillig    999: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz      1000: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                   1001: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.146     wiz      1002: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r <em class="replaceable"><code>pkgsrc-20xxQy</code></em> -P pkgsrc</code></strong>
1.128     wiz      1003: </pre>
                   1004: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
1.188     snj      1005:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2014Q3</span>&#8221;</span></p>
1.128     wiz      1006: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1007:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1008:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1009: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1010: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       grant    1011: </pre>
1.188     snj      1012: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128     wiz      1013: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146     wiz      1014: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128     wiz      1015: </pre>
                   1016: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1017:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1018:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1019: <pre class="programlisting">
                   1020: # set CVS remote shell command
                   1021: CVS_RSH=ssh
                   1022: export CVS_RSH
                   1023: </pre>
                   1024: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1025:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1026:        in your home directory and saving the following lines to it.
                   1027:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1028:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1029: <pre class="programlisting">
                   1030: # recommended CVS configuration file from the pkgsrc guide
1.146     wiz      1031: cvs -q -z2
1.101     rillig   1032: checkout -P
1.103     wiz      1033: update -dP
                   1034: diff -upN
1.101     rillig   1035: rdiff -u
1.128     wiz      1036: release -d
1.101     rillig   1037: </pre>
1.75      rillig   1038: </div>
                   1039: </div>
1.148     asau     1040: <div class="sect1">
1.75      rillig   1041: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1042: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1043: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1044:        (which also works if you have first installed it via a tar
                   1045:        file). It saves bandwidth and hard disk activity, compared to
                   1046:        downloading the tar file again.</p>
1.148     asau     1047: <div class="sect2">
1.75      rillig   1048: <div class="titlepage"><div><div><h3 class="title">
                   1049: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.148     asau     1050: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1051: <h3 class="title">Warning</h3>
1.77      rillig   1052: <p>When updating from a tar file, you first need to
                   1053:        completely remove the old pkgsrc directory. Otherwise those
                   1054:        files that have been removed from pkgsrc in the mean time will
                   1055:        not be removed on your local disk, resulting in inconsistencies.
                   1056:        When removing the old files, any changes that you have done to
                   1057:        the pkgsrc files will be lost after updating. Therefore updating
                   1058:        via CVS is strongly recommended.</p>
1.75      rillig   1059: </div>
1.82      rillig   1060: <p>Note that by default the distfiles and the binary packages
                   1061:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1062:        before updating. You can also configure pkgsrc to store distfiles
                   1063:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1064:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.110     hubertf  1065:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1066: <p>To update pkgsrc from a tar file, download the tar file as
                   1067:        explained above. Then, make sure that you have not made any
                   1068:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1069:        directory and extract the new tar file. Done.</p>
                   1070: </div>
1.148     asau     1071: <div class="sect2">
1.75      rillig   1072: <div class="titlepage"><div><div><h3 class="title">
                   1073: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.132     spz      1074: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1075: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1076: </pre>
                   1077: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable as described above. E.g.:</p>
                   1078: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; env CVS_RSH=ssh cvs up -dP</code></strong>
                   1079: </pre>
1.148     asau     1080: <div class="sect3">
1.75      rillig   1081: <div class="titlepage"><div><div><h4 class="title">
                   1082: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1083: <p>When updating pkgsrc, the CVS program keeps track of the
                   1084:        branch you selected. But if you, for whatever reason, want to
                   1085:        switch from the stable branch to the current one, you can do it
1.128     wiz      1086:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1087:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1088:        back to the stable branch, add the
1.188     snj      1089:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2014Q3</span>&#8221;</span> option.</p>
1.75      rillig   1090: </div>
1.148     asau     1091: <div class="sect3">
1.75      rillig   1092: <div class="titlepage"><div><div><h4 class="title">
                   1093: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1094: <p>When you update pkgsrc, the CVS program will only touch
                   1095:        those files that are registered in the CVS repository. That
                   1096:        means that any packages that you created on your own will stay
                   1097:        unmodified. If you change files that are managed by CVS, later
                   1098:        updates will try to merge your changes with those that have been
                   1099:        done by others. See the CVS manual, chapter
1.128     wiz      1100:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1101: </div>
                   1102: </div>
                   1103: </div>
                   1104: </div>
1.148     asau     1105: <div class="chapter">
1.75      rillig   1106: <div class="titlepage"><div><div><h2 class="title">
                   1107: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1108: <div class="toc">
                   1109: <p><b>Table of Contents</b></p>
1.210     leot     1110: <dl class="toc">
1.82      rillig   1111: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1112: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1113: <dt><span class="sect1"><a href="#platform-specific-notes">3.3. Platform-specific notes</a></span></dt>
                   1114: <dd><dl>
1.151     obache   1115: <dt><span class="sect2"><a href="#cygwin">3.3.1. Cygwin</a></span></dt>
                   1116: <dt><span class="sect2"><a href="#darwin">3.3.2. Darwin (Mac OS X)</a></span></dt>
                   1117: <dt><span class="sect2"><a href="#freebsd">3.3.3. FreeBSD</a></span></dt>
1.166     jnemeth  1118: <dt><span class="sect2"><a href="#gnukfreebsd">3.3.4. GNU/kFreeBSD</a></span></dt>
                   1119: <dt><span class="sect2"><a href="#interix">3.3.5. Interix</a></span></dt>
                   1120: <dt><span class="sect2"><a href="#irix">3.3.6. IRIX</a></span></dt>
                   1121: <dt><span class="sect2"><a href="#linux">3.3.7. Linux</a></span></dt>
                   1122: <dt><span class="sect2"><a href="#mirbsd">3.3.8. MirBSD</a></span></dt>
                   1123: <dt><span class="sect2"><a href="#openbsd">3.3.9. OpenBSD</a></span></dt>
                   1124: <dt><span class="sect2"><a href="#solaris">3.3.10. Solaris</a></span></dt>
1.75      rillig   1125: </dl></dd>
                   1126: </dl>
                   1127: </div>
1.148     asau     1128: <div class="sect1">
1.75      rillig   1129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1130: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.110     hubertf  1131: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.82      rillig   1132: </div>
1.148     asau     1133: <div class="sect1">
1.82      rillig   1134: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1135: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1136: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1137:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1138:     to privileged one all programs are installed under one particular user
1.149     asau     1139:     and cannot utilise privileged operations (packages don't create
                   1140:     special users and all special file permissions like setuid are ignored).
                   1141:     </p>
1.82      rillig   1142: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1143: <pre class="screen">
1.167     asau     1144: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75      rillig   1145: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1146: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1147:     </pre>
1.149     asau     1148: <p>To bootstrap in unprivileged mode pass <span class="quote">&#8220;<span class="quote">--unprivileged</span>&#8221;</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
                   1149: <p>By default, in privileged mode pkgsrc uses
                   1150:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1151:     where programs will be installed in,
1.87      wiz      1152:     and <code class="filename">/var/db/pkg</code> for the package database
1.149     asau     1153:     directory where pkgsrc will do its internal bookkeeping,
                   1154:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1155:     where packages install their persistent data.
                   1156:     In unprivileged mode pkgsrc uses
                   1157:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
                   1158:     <code class="filename">~/pkg/var/db/pkg</code> for the package database,
                   1159:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1160:     </p>
                   1161: <p>You can change default layout using command-line arguments.
                   1162:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1163:     </p>
1.148     asau     1164: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1165: <h3 class="title">Note</h3>
1.110     hubertf  1166: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1167:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1168:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1169:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1170: </div>
1.149     asau     1171: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1172: <h3 class="title">Note</h3>
                   1173: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1174:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1175:       corresponding to the installation you're working with to build
                   1176:       and install packages.
                   1177:       </p>
                   1178: </div>
1.75      rillig   1179: </div>
1.148     asau     1180: <div class="sect1">
1.75      rillig   1181: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.82      rillig   1182: <a name="platform-specific-notes"></a>3.3. Platform-specific notes</h2></div></div></div>
1.148     asau     1183: <div class="sect2">
1.75      rillig   1184: <div class="titlepage"><div><div><h3 class="title">
1.151     obache   1185: <a name="cygwin"></a>3.3.1. Cygwin</h3></div></div></div>
                   1186: <p>Cygwin 1.7.x and later are supported.</p>
                   1187: <p>You need to install minimal base packages in `Base' category
                   1188:       plus any of compiler, gcc, gcc4, and/or clang.
                   1189:       For gcc and gcc4, C and C++ compiler will be installed by default,
                   1190:       but you can install Fortran compiler additionally
                   1191:       because it will be required to use libtool.
                   1192:       If it is not installed (or too old), Fortran compiler will be
                   1193:       installed with pkgsrc automatically.</p>
                   1194: <p>As noted in
                   1195:       <a class="ulink" href="http://cygwin.com/faq-nochunks.html#faq.using.su" target="_top">Cygwin FAQ: `Why doesn't su work?'</a>,
                   1196:       su(1) command has been in Cygwin distribution, but it has never worked.
                   1197:       Unless you bootstrap pkgsrc with the --unprivileged option, workaround is:
                   1198:       </p>
                   1199: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>Right click "Cygwin Terminal" in your Start Menu,
                   1200:           then pick "Run as administrator".</p></li></ul></div>
                   1201: </div>
                   1202: <div class="sect2">
                   1203: <div class="titlepage"><div><div><h3 class="title">
                   1204: <a name="darwin"></a>3.3.2. Darwin (Mac OS X)</h3></div></div></div>
1.211     sevan    1205: <p>Darwin 8.x and up are supported.</p>
1.148     asau     1206: <p>Before you start, you need to download and install
                   1207:       the Mac OS X Developer Tools from Apple's Developer Connection.
                   1208:       This requires (free) membership. See
1.126     jakllsch 1209:       <a class="ulink" href="http://developer.apple.com/macosx/" target="_top">http://developer.apple.com/macosx/</a>
1.148     asau     1210:       for details. Also, make sure you install X11 (an optional
                   1211:       package included with the Developer Tools) if you intend
                   1212:       to build packages that use the X11 Window System.
                   1213:       (If you don't want or need the full Xcode GUI,
                   1214:       download and install Command Line Tools for Xcode.)</p>
1.75      rillig   1215: </div>
1.148     asau     1216: <div class="sect2">
1.75      rillig   1217: <div class="titlepage"><div><div><h3 class="title">
1.151     obache   1218: <a name="freebsd"></a>3.3.3. FreeBSD</h3></div></div></div>
1.136     dholland 1219: <p>FreeBSD 8.3 and 9.0 have been tested and are supported,
1.87      wiz      1220:       other versions may work.</p>
1.75      rillig   1221: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1222:       with the FreeBSD userland tools. There are several steps:</p>
1.128     wiz      1223: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1224: <li class="listitem"><p>FreeBSD stores its ports pkg database in
1.87      wiz      1225:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1226:          recommended that you choose a different location (e.g.
                   1227:          <code class="filename">/usr/pkgdb</code>) by
                   1228:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.128     wiz      1229: <li class="listitem">
1.75      rillig   1230: <p>If you do not intend to use the FreeBSD ports tools, it's probably a
1.87      wiz      1231:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1232: <pre class="screen">
                   1233: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1234: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1235: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1236: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1237: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1238:          </pre>
1.75      rillig   1239: </li>
1.128     wiz      1240: <li class="listitem"><p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1241:          <code class="filename">/etc/mk.conf.example</code> file
                   1242:          when you use the bootstrap script.</p></li>
1.75      rillig   1243: </ol></div>
                   1244: </div>
1.148     asau     1245: <div class="sect2">
1.75      rillig   1246: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1247: <a name="gnukfreebsd"></a>3.3.4. GNU/kFreeBSD</h3></div></div></div>
                   1248: <p>Debian GNU/kFreeBSD is the only GNU/kFreeBSD distribution now.
                   1249:       Debian GNU/kFreeBSD 7.0 or later is tested and supported.</p>
                   1250: <p> You should install ncurses (libncurses and libncurses-dev)
                   1251:       packages.</p>
                   1252: </div>
                   1253: <div class="sect2">
                   1254: <div class="titlepage"><div><div><h3 class="title">
                   1255: <a name="interix"></a>3.3.5. Interix</h3></div></div></div>
1.75      rillig   1256: <p>Interix is a POSIX-compatible subsystem for the Windows NT kernel,
1.87      wiz      1257:       providing a Unix-like environment with a tighter kernel integration than
                   1258:       available with Cygwin.  It is part of the Windows Services for Unix
                   1259:       package, available for free for any licensed copy of Windows 2000, XP
1.110     hubertf  1260:       (not including XP Home), or 2003.  SFU can be downloaded from <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">http://www.microsoft.com/windows/sfu/</a>.</p>
1.93      rillig   1261: <p>Services for Unix 3.5 has been tested.  3.0 or 3.1 may work, but
                   1262:       are not officially supported.  (The main difference in 3.0/3.1 is lack
                   1263:       of pthreads, but other parts of libc may also be lacking.)</p>
1.129     wiz      1264: <p>Services for Unix Applications (aka SUA) is an integrated
                   1265:       component of Windows Server 2003 R2 (5.2), Windows Vista and
                   1266:       Windows Server 2008 (6.0), Windows 7 and Windows Server 2008 R2
                   1267:       (6.1).  As of this writing, the SUA's Interix 6.0 (32bit) and
                   1268:       6.1 (64bit) subsystems have been tested.  Other versions may
                   1269:       work as well. The Interix 5.x subsystem has not yet been tested
                   1270:       with pkgsrc.</p>
1.148     asau     1271: <div class="sect3">
1.75      rillig   1272: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1273: <a name="platform.interix-sfu-install"></a>3.3.5.1. When installing Interix/SFU</h4></div></div></div>
1.75      rillig   1274: <p>At an absolute minimum, the following packages must be installed from
1.87      wiz      1275:        the Windows Services for Unix 3.5 distribution in order to use pkgsrc:</p>
1.148     asau     1276: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1277: <li class="listitem"><p>Utilities -&gt; Base Utilities</p></li>
                   1278: <li class="listitem"><p>Interix GNU Components -&gt; (all)</p></li>
                   1279: <li class="listitem"><p>Remote Connectivity</p></li>
                   1280: <li class="listitem"><p>Interix SDK</p></li>
1.75      rillig   1281: </ul></div>
                   1282: <p>When using pkgsrc on Interix, DO NOT install the Utilities subcomponent
1.87      wiz      1283:        "UNIX Perl".  That is Perl 5.6 without shared module support, installed to
                   1284:        /usr/local, and will only cause confusion. Instead, install Perl 5.8 from
                   1285:        pkgsrc (or from a binary package).</p>
1.75      rillig   1286: <p>The Remote Connectivity subcomponent "Windows Remote Shell Service" does
1.87      wiz      1287:        not need to be installed, but Remote Connectivity itself should be
                   1288:        installed in order to have a working inetd.</p>
1.75      rillig   1289: <p>During installation you may be asked whether to enable setuid
1.87      wiz      1290:        behavior for Interix programs, and whether to make pathnames default to
                   1291:        case-sensitive.  Setuid should be enabled, and case-sensitivity MUST be
                   1292:        enabled.  (Without case-sensitivity, a large number of packages including
                   1293:        perl will not build.)</p>
1.75      rillig   1294: <p>NOTE:  Newer Windows service packs change the way binary execution
1.87      wiz      1295:        works (via the Data Execution Prevention feature).  In order to use
                   1296:        pkgsrc and other gcc-compiled binaries reliably, a hotfix containing
                   1297:        POSIX.EXE, PSXDLL.DLL, PSXRUN.EXE, and PSXSS.EXE (899522 or newer)
                   1298:        must be installed.  Hotfixes are available from Microsoft through a
1.114     jmcneill 1299:        support contract; however, Debian Interix Port has made most Interix
                   1300:        hotfixes available for personal use from <a class="ulink" href="http://www.debian-interix.net/hotfixes/" target="_top">http://www.debian-interix.net/hotfixes/</a>.</p>
1.93      rillig   1301: <p>In addition to the hotfix noted above, it may be necessary to
                   1302:        disable Data Execution Prevention entirely to make Interix functional.
                   1303:        This may happen only with certain types of CPUs; the cause is not fully
                   1304:        understood at this time.  If gcc or other applications still segfault
                   1305:        repeatedly after installing one of the hotfixes note above, the
                   1306:        following option can be added to the appropriate "boot.ini" line on the
                   1307:        Windows boot drive:  /NoExecute=AlwaysOff
                   1308:        (WARNING, this will disable DEP completely, which may be a security
                   1309:        risk if applications are often run as a user in the Administrators
                   1310:        group!)</p>
1.75      rillig   1311: </div>
1.148     asau     1312: <div class="sect3">
1.75      rillig   1313: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1314: <a name="platform.interix-sfu-postinstall"></a>3.3.5.2. What to do if Interix/SFU is already installed</h4></div></div></div>
1.75      rillig   1315: <p>If SFU is already installed and you wish to alter these settings to work
1.87      wiz      1316:        with pkgsrc, note the following things.</p>
1.148     asau     1317: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1318: <li class="listitem"><p>To uninstall UNIX Perl, use Add/Remove Programs, select Microsoft
1.87      wiz      1319:            Windows Services for UNIX, then click Change.  In the installer, choose
                   1320:            Add or Remove, then uncheck Utilities-&gt;UNIX Perl.</p></li>
1.128     wiz      1321: <li class="listitem">
1.75      rillig   1322: <p>To enable case-sensitivity for the file system, run REGEDIT.EXE, and
1.87      wiz      1323:            change the following registry key:</p>
1.75      rillig   1324: <p>HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\kernel</p>
                   1325: <p>Set the DWORD value "obcaseinsensitive" to 0; then reboot.</p>
                   1326: </li>
1.128     wiz      1327: <li class="listitem">
1.75      rillig   1328: <p>To enable setuid binaries (optional), run REGEDIT.EXE, and change the
1.87      wiz      1329:            following registry key:</p>
1.75      rillig   1330: <p>HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Services for UNIX</p>
                   1331: <p>Set the DWORD value "EnableSetuidBinaries" to 1; then reboot.</p>
                   1332: </li>
                   1333: </ul></div>
                   1334: </div>
1.148     asau     1335: <div class="sect3">
1.75      rillig   1336: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1337: <a name="platform.interix-notes"></a>3.3.5.3. Important notes for using pkgsrc</h4></div></div></div>
1.75      rillig   1338: <p>The package manager (either the pkgsrc "su" user, or the user
1.87      wiz      1339:        running "pkg_add") must be a member of the local Administrators
                   1340:        group.  Such a user must also be used to run the bootstrap.  This is
                   1341:        slightly relaxed from the normal pkgsrc requirement of "root".</p>
1.75      rillig   1342: <p>The package manager should use a umask of 002.  "make install" will
1.87      wiz      1343:        automatically complain if this is not the case.  This ensures that
                   1344:        directories written in /var/db/pkg are Administrators-group writeable.</p>
1.75      rillig   1345: <p>The popular Interix binary packages from http://www.interopsystems.com/
1.87      wiz      1346:        use an older version of pkgsrc's pkg_* tools.  Ideally, these should
                   1347:        NOT be used in conjunction with pkgsrc.  If you choose to use them at
                   1348:        the same time as the pkgsrc packages, ensure that you use the proper
                   1349:        pkg_* tools for each type of binary package.</p>
1.75      rillig   1350: <p>The TERM setting used for DOS-type console windows (including those
1.87      wiz      1351:        invoked by the csh and ksh startup shortcuts) is "interix".  Most systems
                   1352:        don't have a termcap/terminfo entry for it, but the following .termcap
                   1353:        entry provides adequate emulation in most cases:</p>
1.75      rillig   1354: <pre class="programlisting">
1.100     rillig   1355: interix:kP=\E[S:kN=\E[T:kH=\E[U:dc@:DC@:tc=pcansi:
1.87      wiz      1356:        </pre>
1.75      rillig   1357: </div>
1.148     asau     1358: <div class="sect3">
1.75      rillig   1359: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1360: <a name="platform.interix-limits"></a>3.3.5.4. Limitations of the Interix platform</h4></div></div></div>
1.75      rillig   1361: <p>Though Interix suffices as a familiar and flexible substitute
1.87      wiz      1362:        for a full Unix-like platform, it has some drawbacks that should
                   1363:        be noted for those desiring to make the most of Interix.</p>
1.148     asau     1364: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1365: <li class="listitem">
1.75      rillig   1366: <p><span class="strong"><strong>X11:</strong></span></p>
                   1367: <p>Interix comes with the standard set of X11R6 client libraries,
1.87      wiz      1368:          and can run X11 based applications, but it does
                   1369:          <span class="emphasis"><em>not</em></span> come with an X server.  Some options are
1.110     hubertf  1370:          <a class="ulink" href="http://www.starnet.com/products/xwin32/" target="_top">StarNet X-Win32</a>,
                   1371:          <a class="ulink" href="http://connectivity.hummingbird.com/products/nc/exceed/" target="_top">Hummingbird Exceed</a>
1.87      wiz      1372:          (available in a trimmed version for Interix from Interop Systems as the
1.110     hubertf  1373:          <a class="ulink" href="http://www.interopsystems.com/InteropXserver.htm" target="_top">Interop X Server</a>),
1.87      wiz      1374:          and the free X11 server included with
1.110     hubertf  1375:          <a class="ulink" href="http://x.cygwin.com/" target="_top">Cygwin</a>.</p>
1.75      rillig   1376: </li>
1.128     wiz      1377: <li class="listitem">
1.75      rillig   1378: <p><span class="strong"><strong>X11 acceleration:</strong></span></p>
                   1379: <p>Because Interix runs in a completely different NT subsystem from
1.87      wiz      1380:          Win32 applications, it does not currently support various X11
                   1381:          protocol extensions for acceleration (such as MIT-SHM or DGA).
                   1382:          Most interactive applications to a local X server will run
                   1383:          reasonably fast, but full motion video and other graphics
                   1384:          intensive applications may require a faster-than-expected CPU.</p>
1.75      rillig   1385: </li>
1.128     wiz      1386: <li class="listitem">
1.75      rillig   1387: <p><span class="strong"><strong>Audio:</strong></span></p>
                   1388: <p>Interix has no native support for audio output.  For audio
1.110     hubertf  1389:          support, pkgsrc uses the <span class="command"><strong>esound</strong></span> client/server
1.87      wiz      1390:          audio system on Interix.  Unlike on most platforms, the
1.189     snj      1391:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/audio/esound/README.html" target="_top"><code class="filename">audio/esound</code></a> package does
1.110     hubertf  1392:          <span class="emphasis"><em>not</em></span> contain the <span class="command"><strong>esd</strong></span>
1.87      wiz      1393:          server component.  To output audio via an Interix host, the
1.189     snj      1394:          <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/emulators/cygwin_esound/README.html" target="_top"><code class="filename">emulators/cygwin_esound</code></a> package
1.87      wiz      1395:          must also be installed.</p>
1.75      rillig   1396: </li>
1.128     wiz      1397: <li class="listitem">
1.75      rillig   1398: <p><span class="strong"><strong>CD/DVDs, USB, and SCSI:</strong></span></p>
                   1399: <p>Direct device access is not currently supported in Interix, so it
1.87      wiz      1400:          is not currently possible to access CD/DVD drives, USB devices,
                   1401:          or SCSI devices through non-filesystem means.  Among other things,
                   1402:          this makes it impossible to use Interix directly for CD/DVD
                   1403:          burning.</p>
1.75      rillig   1404: </li>
1.128     wiz      1405: <li class="listitem">
1.75      rillig   1406: <p><span class="strong"><strong>Tape drives:</strong></span></p>
                   1407: <p>Due to the same limitations as for CD-ROMs and SCSI devices, tape
1.87      wiz      1408:          drives are also not directly accessible in Interix.  However,
                   1409:          support is in work to make tape drive access possible by using
                   1410:          Cygwin as a bridge (similarly to audio bridged via Cygwin's
                   1411:          esound server).</p>
1.75      rillig   1412: </li>
                   1413: </ul></div>
                   1414: </div>
1.148     asau     1415: <div class="sect3">
1.75      rillig   1416: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1417: <a name="platform.interix-knownissues"></a>3.3.5.5. Known issues for pkgsrc on Interix</h4></div></div></div>
1.75      rillig   1418: <p>It is not necessary, in general, to have a "root" user on the
1.87      wiz      1419:        Windows system; any member of the local Administrators group will
                   1420:        suffice.  However, some packages currently assume that the user
                   1421:        named "root" is the privileged user.  To accommodate these, you
                   1422:        may create such a user; make sure it is in the local group
                   1423:        Administrators (or your language equivalent).</p>
1.110     hubertf  1424: <p><span class="command"><strong>pkg_add</strong></span> creates directories of mode
1.87      wiz      1425:        0755, not 0775, in <code class="filename">$PKG_DBDIR</code>.  For the
                   1426:        time being, install packages as the local Administrator (or
                   1427:        your language equivalent), or run the following command after
                   1428:        installing a package to work around the issue:</p>
1.75      rillig   1429: <pre class="screen">
1.87      wiz      1430: <code class="prompt">#</code> <strong class="userinput"><code>chmod -R g+w $PKG_DBDIR</code></strong>
                   1431:        </pre>
1.75      rillig   1432: </div>
                   1433: </div>
1.148     asau     1434: <div class="sect2">
1.75      rillig   1435: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1436: <a name="irix"></a>3.3.6. IRIX</h3></div></div></div>
1.75      rillig   1437: <p>You will need a working C compiler, either gcc or SGI's MIPS and MIPSpro
1.87      wiz      1438:       compiler (cc/c89).  Please set the <code class="varname">CC</code> environment variable
                   1439:       according to your preference.  If you do not have a license for the MIPSpro
1.110     hubertf  1440:       compiler suite, you can download a gcc tardist file from <a class="ulink" href="http://freeware.sgi.com/" target="_top">http://freeware.sgi.com/</a>.</p>
1.75      rillig   1441: <p>Please note that you will need IRIX 6.5.17 or higher, as this is the earliest
1.189     snj      1442:       version of IRIX providing support for <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_indextoname+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_indextoname</span>(3)</span></a>, <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?if_nametoindex+3+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">if_nametoindex</span>(3)</span></a>,
1.87      wiz      1443:       etc.</p>
1.86      schwarz  1444: <p>At this point in time, pkgsrc only supports one ABI at a time.  That is, you cannot
1.75      rillig   1445:        switch between the old 32-bit ABI, the new 32-bit ABI and the 64-bit ABI.  If
                   1446:        you start out using "abi=n32", that's what all your packages will be built
                   1447:        with.</p>
                   1448: <p>Therefore, please make sure that you have no conflicting
1.87      wiz      1449:       <code class="varname">CFLAGS</code> in your environment or the
1.110     hubertf  1450:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Particularly, make sure that you do not
1.87      wiz      1451:       try to link n32 object files with lib64 or vice versa.  Check your
                   1452:       <code class="filename">/etc/compiler.defaults</code>!</p>
1.75      rillig   1453: <p>If you have the actual pkgsrc tree mounted via NFS from a different host,
1.87      wiz      1454:       please make sure to set <code class="varname">WRKOBJDIR</code> to a local directory,
                   1455:       as it appears that IRIX linker occasionally runs into issues when trying to
                   1456:       link over a network-mounted file system.</p>
1.75      rillig   1457: <p>The bootstrapping process should set all the right options for programs such
1.87      wiz      1458:       as imake(1), but you may want to set some options depending on your local
                   1459:       setup.  Please see <code class="filename">pkgsrc/mk/defaults/mk.conf</code> and, of
                   1460:       course, your compiler's man pages for details.</p>
1.75      rillig   1461: <p>If you are using SGI's MIPSPro compiler, please set
1.1       grant    1462: 
1.87      wiz      1463:       </p>
1.75      rillig   1464: <pre class="programlisting">
1.100     rillig   1465: PKGSRC_COMPILER=        mipspro
1.87      wiz      1466:       </pre>
1.75      rillig   1467: <p>
1.1       grant    1468: 
1.110     hubertf  1469:       in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Otherwise, pkgsrc will assume you
1.87      wiz      1470:       are using gcc and may end up passing invalid flags to the compiler.  Note that
                   1471:       bootstrap should create an appropriate <code class="filename">mk.conf.example</code> by
                   1472:       default.</p>
1.75      rillig   1473: <p>If you have both the MIPSPro compiler chain installed as well as gcc,
1.93      rillig   1474:       but want to make sure that MIPSPro is used, please set your <code class="varname">PATH</code>
1.87      wiz      1475:       to <span class="emphasis"><em>not</em></span> include the location of gcc (often
                   1476:       <code class="filename">/usr/freeware/bin</code>), and (important) pass the
                   1477:       '--preserve-path' flag.</p>
1.75      rillig   1478: </div>
1.148     asau     1479: <div class="sect2">
1.75      rillig   1480: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1481: <a name="linux"></a>3.3.7. Linux</h3></div></div></div>
1.87      wiz      1482: <p>Some versions of Linux (for example Debian GNU/Linux) need
                   1483:       either libtermcap or libcurses (libncurses).  Installing the
                   1484:       distributions libncurses-dev package (or equivalent) should fix
                   1485:       the problem.</p>
                   1486: <p>pkgsrc supports both gcc (GNU Compiler Collection) and icc
                   1487:       (Intel C++ Compiler). gcc is the default. icc 8.0 and 8.1 on
                   1488:       i386 have been tested.</p>
1.75      rillig   1489: <p>To bootstrap using icc, assuming the default icc installation
1.87      wiz      1490:       directory:</p>
1.75      rillig   1491: <pre class="programlisting">
1.138     wiz      1492: env ICCBASE=/opt/intel/cc/10.1.008 ./bootstrap --compiler=icc
1.87      wiz      1493:       </pre>
1.148     asau     1494: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1495: <h3 class="title">Note</h3>
1.138     wiz      1496: <p>For icc 8.0 you must add `LDFLAGS=-static-libcxa' to this.</p>
                   1497: <p>For icc 8.1 you must add `LDFLAGS=-i-static' instead.</p>
                   1498: <p>For icc 10.1 neither of these appears to be necessary.</p>
                   1499: </div>
                   1500: <p>Use a value for ICCBASE that corresponds to the directory
                   1501:       where icc is installed. After bootstrapping, set
                   1502:       <code class="varname">ICCBASE</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.137     wiz      1503: <pre class="programlisting">
1.138     wiz      1504: ICCBASE=                /opt/intel/cc/10.1.008
1.87      wiz      1505:       </pre>
1.138     wiz      1506: <p>The pkgsrc default for <code class="varname">ICCBASE</code> is
                   1507:       <code class="filename">/opt/intel_cc_80</code>. This is the default
                   1508:       install directory for icc 8.0. If you are using a more recent
                   1509:       version, be sure to set the correct path explicitly.
                   1510:       </p>
1.75      rillig   1511: <p>pkgsrc uses the static linking method of the runtime libraries
1.87      wiz      1512:       provided by icc, so binaries can be run on other systems which do not
                   1513:       have the shared libraries installed.</p>
                   1514: <p>Libtool, however, extracts a list of libraries from the
1.189     snj      1515:       <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> command run when linking a C++ shared library and
1.87      wiz      1516:       records it, throwing away the -Bstatic and -Bdynamic options
                   1517:       interspersed between the libraries.  This means that
                   1518:       libtool-linked C++ shared libraries will have a runtime
                   1519:       dependency on the icc libraries until this is fixed in
                   1520:       libtool.</p>
1.75      rillig   1521: </div>
1.148     asau     1522: <div class="sect2">
1.75      rillig   1523: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1524: <a name="mirbsd"></a>3.3.8. MirBSD</h3></div></div></div>
1.163     bsiegert 1525: <p>pkgsrc has been tested on MirBSD #10-current (2011 and newer).
                   1526:       Older versions might also work. Releases before #10 are not
                   1527:       supported.</p>
                   1528: <p>The package tools of the (older) native ports tree,
                   1529:       <a class="ulink" href="//www.mirbsd.org/ports.htm" target="_top">MirPorts</a>,
                   1530:       have the same names as the ones used by pkgsrc. Care should be taken
                   1531:       that the right tools are used. When installing packages from source,
                   1532:       use the <code class="filename">bmake</code> command for pkgsrc and
                   1533:       <code class="filename">mmake</code> for MirPorts.</p>
                   1534: <p>pkgsrc and MirPorts use the same location for the package
                   1535:       database, <code class="filename">/var/db/pkg</code>. It is strongly recommended
                   1536:       to use <code class="filename">/usr/pkg/db</code> instead, so that the pkgsrc
                   1537:       tree is self-contained. This is also the default setting used in the
                   1538:       binary package builds.</p>
                   1539: <p>Binary packages for MirBSD/i386 can be found on the pkgsrc ftp
                   1540:       server. The bootstrap kit there already contains the
                   1541:       <span class="command"><strong>pkgin</strong></span> package manager. See the
                   1542:       <a class="ulink" href="https://www.mirbsd.org/pkgsrc.htm" target="_top">pkgsrc on MirOS</a>
                   1543:       page for more details.</p>
                   1544: </div>
                   1545: <div class="sect2">
                   1546: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1547: <a name="openbsd"></a>3.3.9. OpenBSD</h3></div></div></div>
1.136     dholland 1548: <p>OpenBSD 5.1 has been tested and supported,
                   1549:       other versions may work.</p>
1.75      rillig   1550: <p>Care should be taken so that the tools that this kit installs do not conflict
1.87      wiz      1551:       with the OpenBSD userland tools. There are several steps:</p>
1.128     wiz      1552: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1553: <li class="listitem"><p>OpenBSD stores its ports pkg database in
1.87      wiz      1554:          <code class="filename">/var/db/pkg</code>. It is therefore
                   1555:          recommended that you choose a different location (e.g.
                   1556:          <code class="filename">/usr/pkgdb</code>) by
                   1557:          using the --pkgdbdir option to the bootstrap script.</p></li>
1.128     wiz      1558: <li class="listitem">
1.75      rillig   1559: <p>If you do not intend to use the OpenBSD ports tools, it's probably a
1.87      wiz      1560:          good idea to move them out of the way to avoid confusion, e.g.</p>
                   1561: <pre class="screen">
                   1562: <code class="prompt">#</code> <strong class="userinput"><code>cd /usr/sbin</code></strong>
1.75      rillig   1563: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_add pkg_add.orig</code></strong>
                   1564: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_create pkg_create.orig</code></strong>
                   1565: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_delete pkg_delete.orig</code></strong>
1.87      wiz      1566: <code class="prompt">#</code> <strong class="userinput"><code>mv pkg_info pkg_info.orig</code></strong>
                   1567:          </pre>
1.75      rillig   1568: </li>
1.128     wiz      1569: <li class="listitem">
1.110     hubertf  1570: <p>An example <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file will be placed in
1.87      wiz      1571:          <code class="filename">/etc/mk.conf.example</code> file
                   1572:          when you use the bootstrap script. OpenBSD's make program uses
1.110     hubertf  1573:          <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.87      wiz      1574:          as well. You can work around this by enclosing all the pkgsrc-specific parts
                   1575:          of the file with:</p>
                   1576: <pre class="programlisting">
1.100     rillig   1577: .ifdef BSD_PKG_MK
                   1578: # pkgsrc stuff, e.g. insert defaults/mk.conf or similar here
                   1579: .else
                   1580: # OpenBSD stuff
                   1581: .endif
1.87      wiz      1582:          </pre>
1.75      rillig   1583: </li>
                   1584: </ol></div>
                   1585: </div>
1.148     asau     1586: <div class="sect2">
1.75      rillig   1587: <div class="titlepage"><div><div><h3 class="title">
1.166     jnemeth  1588: <a name="solaris"></a>3.3.10. Solaris</h3></div></div></div>
1.142     wiz      1589: <p>Solaris 2.6 through 10 are supported on both x86 and sparc.
                   1590:       You will need a working C compiler. Both gcc 4.5.3 and
1.87      wiz      1591:       Sun WorkShop 5 have been tested.</p>
1.75      rillig   1592: <p>The following packages are required on Solaris 8 for the bootstrap
1.87      wiz      1593:       process and to build packages.</p>
1.148     asau     1594: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1595: <li class="listitem"><p>SUNWsprot</p></li>
                   1596: <li class="listitem"><p>SUNWarc</p></li>
                   1597: <li class="listitem"><p>SUNWbtool</p></li>
                   1598: <li class="listitem"><p>SUNWtoo</p></li>
                   1599: <li class="listitem"><p>SUNWlibm</p></li>
1.75      rillig   1600: </ul></div>
1.78      rillig   1601: <p>Please note that the use of GNU binutils on Solaris is
1.87      wiz      1602:       <span class="emphasis"><em>not</em></span> supported, as of June 2006.</p>
1.75      rillig   1603: <p>Whichever compiler you use, please ensure the compiler tools and
1.87      wiz      1604:       your $prefix are in your <code class="varname">PATH</code>. This includes
                   1605:       <code class="filename">/usr/ccs/{bin,lib}</code>
                   1606:       and e.g. <code class="filename">/usr/pkg/{bin,sbin}</code>.</p>
1.148     asau     1607: <div class="sect3">
1.75      rillig   1608: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1609: <a name="solaris-gcc-note"></a>3.3.10.1. If you are using gcc</h4></div></div></div>
1.75      rillig   1610: <p>It makes life much simpler if you only use the same gcc consistently
1.87      wiz      1611:        for building all packages.</p>
1.75      rillig   1612: <p>It is recommended that an external gcc be used only for bootstrapping,
1.87      wiz      1613:        then either build gcc from
1.189     snj      1614:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/gcc46/README.html" target="_top"><code class="filename">lang/gcc46</code></a> or install a binary gcc
1.87      wiz      1615:        package, then remove gcc used during bootstrapping.</p>
1.110     hubertf  1616: <p>Binary packages of gcc can be found through <a class="ulink" href="http://www.sunfreeware.com/" target="_top">http://www.sunfreeware.com/</a>.</p>
1.75      rillig   1617: </div>
1.148     asau     1618: <div class="sect3">
1.75      rillig   1619: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1620: <a name="solaris-sun-workshop-note"></a>3.3.10.2. If you are using Sun WorkShop</h4></div></div></div>
1.75      rillig   1621: <p>You will need at least the following packages installed (from WorkShop
1.87      wiz      1622:        5.0)</p>
1.148     asau     1623: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1624: <li class="listitem"><p>SPROcc
1.87      wiz      1625:          - Sun WorkShop Compiler C 5.0</p></li>
1.128     wiz      1626: <li class="listitem"><p>SPROcpl
1.87      wiz      1627:          - Sun WorkShop Compiler C++ 5.0</p></li>
1.128     wiz      1628: <li class="listitem"><p>SPROild
1.87      wiz      1629:          - Sun WorkShop Incremental Linker</p></li>
1.128     wiz      1630: <li class="listitem"><p>SPROlang
1.87      wiz      1631:          - Sun WorkShop Compilers common components</p></li>
1.75      rillig   1632: </ul></div>
1.96      rillig   1633: <p>You should set the following variables in your
1.110     hubertf  1634:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.96      rillig   1635: <pre class="programlisting">
1.100     rillig   1636: CC=     cc
                   1637: CXX=    CC
                   1638: CPP=    cc -E
                   1639: CXXCPP= CC -E
1.96      rillig   1640: </pre>
1.148     asau     1641: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96      rillig   1642: <h3 class="title">Note</h3>
                   1643: <p>The <code class="varname">CPP</code> setting might break some
                   1644:        packages that use the C preprocessor for processing things other
                   1645:        than C source code.</p>
                   1646: </div>
1.75      rillig   1647: </div>
1.148     asau     1648: <div class="sect3">
1.75      rillig   1649: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1650: <a name="solaris-sunpro-64"></a>3.3.10.3. Building 64-bit binaries with SunPro</h4></div></div></div>
1.96      rillig   1651: <p>To build 64-bit packages, you just need to have the
1.110     hubertf  1652:        following lines in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:</p>
1.75      rillig   1653: <pre class="programlisting">
1.100     rillig   1654: PKGSRC_COMPILER=        sunpro
                   1655: ABI=                    64
1.96      rillig   1656: </pre>
1.148     asau     1657: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.96      rillig   1658: <h3 class="title">Note</h3>
                   1659: <p>This setting has been tested for the SPARC
                   1660:        architecture. Intel and AMD machines need some more
                   1661:        work.</p>
                   1662: </div>
1.75      rillig   1663: </div>
1.148     asau     1664: <div class="sect3">
1.75      rillig   1665: <div class="titlepage"><div><div><h4 class="title">
1.166     jnemeth  1666: <a name="plat.sunos.problems"></a>3.3.10.4. Common problems</h4></div></div></div>
1.110     hubertf  1667: <p>Sometimes, when using <span class="command"><strong>libtool</strong></span>,
1.87      wiz      1668:       <code class="filename">/bin/ksh</code> crashes with a segmentation fault.
                   1669:       The workaround is to use another shell for the configure
1.189     snj      1670:       scripts, for example by installing <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a> and adding the following lines
1.110     hubertf  1671:       to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.87      wiz      1672: <pre class="programlisting">
1.100     rillig   1673: CONFIG_SHELL=   ${LOCALBASE}/bin/bash
                   1674: WRAPPER_SHELL=  ${LOCALBASE}/bin/bash
1.87      wiz      1675:       </pre>
1.189     snj      1676: <p>Then, rebuild the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool-base/README.html" target="_top"><code class="filename">devel/libtool-base</code></a> package.</p>
1.75      rillig   1677: </div>
                   1678: </div>
                   1679: </div>
                   1680: </div>
1.148     asau     1681: <div class="chapter">
1.75      rillig   1682: <div class="titlepage"><div><div><h2 class="title">
                   1683: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1684: <div class="toc">
                   1685: <p><b>Table of Contents</b></p>
1.210     leot     1686: <dl class="toc">
1.75      rillig   1687: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1688: <dd><dl>
                   1689: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1690: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
1.82      rillig   1691: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1692: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1693: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1694: <dt><span class="sect2"><a href="#pkg_versions">4.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                   1695: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
1.75      rillig   1696: </dl></dd>
                   1697: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1698: <dd><dl>
                   1699: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1700: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1701: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1702: </dl></dd>
                   1703: </dl>
                   1704: </div>
                   1705: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1706: is to only install the package tools and to use binary packages
1.128     wiz      1707: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1708: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1709: of pkgsrc, too. Then you are able to build your own packages,
                   1710: and you can still use binary packages from someone else.</p>
1.148     asau     1711: <div class="sect1">
1.75      rillig   1712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1713: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.110     hubertf  1714: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.109     rillig   1715:   server and its mirrors, there are collections of binary packages,
                   1716:   ready to be installed. These binary packages have been built using the
                   1717:   default settings for the directories, that is:</p>
1.148     asau     1718: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1719: <li class="listitem"><p><code class="filename">/usr/pkg</code> for <code class="varname">LOCALBASE</code>, where most of the files are installed,</p></li>
                   1720: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1721: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109     rillig   1722: </ul></div>
                   1723: <p>If you cannot use these directories for whatever reasons (maybe
                   1724:   because you're not root), you cannot use these binary packages, but
1.110     hubertf  1725:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="3.2. Bootstrapping pkgsrc">Section 3.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.148     asau     1726: <div class="sect2">
1.75      rillig   1727: <div class="titlepage"><div><div><h3 class="title">
                   1728: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1729: <p>To install binary packages, you first need to know from where
                   1730:     to get them. The first place where you should look is on the main
1.110     hubertf  1731:     pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105     weinem   1732: <p>This directory contains binary packages for multiple
                   1733:     platforms. First, select your operating system. (Ignore the
                   1734:     directories with version numbers attached to it, they just exist for
                   1735:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1736:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1737: <p>In this directory, you often find a file called
                   1738:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1739:     management tools. If the file is missing, it is likely that your
                   1740:     operating system already provides those tools. Download the file and
                   1741:     extract it in the <code class="filename">/</code> directory. It will create
                   1742:     the directories <code class="filename">/usr/pkg</code> (containing the tools
                   1743:     for managing binary packages) and <code class="filename">/var/db/pkg</code>
                   1744:     (the database of installed packages).</p>
1.75      rillig   1745: </div>
1.148     asau     1746: <div class="sect2">
1.75      rillig   1747: <div class="titlepage"><div><div><h3 class="title">
                   1748: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1749: <p>In the directory from the last section, there is a
1.196     wiz      1750:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1751:     binary packages that are available for the platform, excluding those
                   1752:     that may not be distributed via FTP or CDROM (depending on which
1.128     wiz      1753:     medium you are using).</p>
1.109     rillig   1754: <p>To install packages directly from an FTP or HTTP server, run
                   1755:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1756:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1757: <pre class="screen">
                   1758: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.196     wiz      1759: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.109     rillig   1760: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1761: </pre>
                   1762: <p>Instead of URLs, you can also use local paths, for example if
                   1763:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1764:     repository. If you want to install packages from multiple sources,
                   1765:     you can separate them by a semicolon in
                   1766:     <code class="varname">PKG_PATH</code>.</p>
                   1767: <p>After these preparations, installing a package is very
                   1768:     easy:</p>
                   1769: <pre class="screen">
                   1770: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add openoffice2</code></strong>
                   1771: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
                   1772: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap2-php5-*</code></strong>
                   1773: </pre>
1.75      rillig   1774: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1775:     package in question will be installed, too, assuming they are
                   1776:     present where you install from.</p>
1.128     wiz      1777: <p>Adding packages might install vulnerable packages.
                   1778:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
                   1779:     regularly, especially after installing new packages, and verify
                   1780:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1781: <p>After you've installed packages, be sure to have
1.88      wiz      1782:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1783:     <code class="varname">PATH</code> so you can actually start the just
                   1784:     installed program.</p>
1.75      rillig   1785: </div>
1.148     asau     1786: <div class="sect2">
1.75      rillig   1787: <div class="titlepage"><div><div><h3 class="title">
1.82      rillig   1788: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1789: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1790:     installed from source code or from a binary package. The
1.110     hubertf  1791:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1792:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1793:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1794:     name can be given with or without version number. Wildcards can
                   1795:     also be used to deinstall a set of packages, for example
                   1796:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1797:     so that the shell does not expand them before
                   1798:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1799: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1800:     removes all the packages that require the package in question
                   1801:     and then removes the package itself. For example:
1.82      rillig   1802: 
1.88      wiz      1803:     </p>
1.82      rillig   1804: <pre class="screen">
1.88      wiz      1805: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1806:     </pre>
1.82      rillig   1807: <p>
                   1808: 
1.88      wiz      1809:     will remove jpeg and all the packages that used it; this allows
                   1810:     upgrading the jpeg package.</p>
1.82      rillig   1811: </div>
1.148     asau     1812: <div class="sect2">
1.82      rillig   1813: <div class="titlepage"><div><div><h3 class="title">
                   1814: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1815: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1816:     installed packages or binary package files.</p>
1.82      rillig   1817: </div>
1.148     asau     1818: <div class="sect2">
1.82      rillig   1819: <div class="titlepage"><div><div><h3 class="title">
                   1820: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1821: <p>
1.88      wiz      1822:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1823:       known security vulnerabilities to packages which are (or have been)
                   1824:       included in pkgsrc.  The list is available from the NetBSD
1.110     hubertf  1825:       FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.88      wiz      1826:     </p>
1.82      rillig   1827: <p>
1.125     wiz      1828:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1829:       this list can be downloaded
                   1830:       automatically, and a security audit of all packages installed on a system
                   1831:       can take place.
                   1832:     </p>
1.82      rillig   1833: <p>
1.125     wiz      1834:       There are two components to auditing.  The first
                   1835:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1836:       is for downloading
1.88      wiz      1837:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1838:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1839:       installed packages are vulnerable.  If a package is vulnerable, you
                   1840:       will see output similar to the following:
                   1841:     </p>
1.82      rillig   1842: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.88      wiz      1843:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1844: <p>
1.125     wiz      1845:       You may wish to have the
1.110     hubertf  1846:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1847:       file downloaded daily so that
                   1848:       it remains current.  This may be done by adding an appropriate entry
1.189     snj      1849:       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1850:       </p>
                   1851: <pre class="screen">
                   1852: # download vulnerabilities file
                   1853: 0 3 * * * /usr/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
                   1854:       </pre>
                   1855: <p>
                   1856:       will update the vulnerability list every day at 3AM. You may wish to do
                   1857:       this more often than once a day.
                   1858: 
                   1859:       In addition, you may wish to run the package audit from the daily
                   1860:       security script.  This may be accomplished by adding the following
                   1861:       line to <code class="filename">/etc/security.local</code>:
                   1862:       </p>
                   1863: <pre class="screen">
                   1864: /usr/sbin/pkg_admin audit
                   1865:       </pre>
                   1866: <p>
1.88      wiz      1867:     </p>
1.82      rillig   1868: </div>
1.148     asau     1869: <div class="sect2">
1.82      rillig   1870: <div class="titlepage"><div><div><h3 class="title">
                   1871: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1872: <p>
1.189     snj      1873:       Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128     wiz      1874:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.88      wiz      1875:       argument to check if your packages are up-to-date, e.g.
                   1876:     </p>
                   1877: <pre class="screen">
                   1878: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1879: ...
1.88      wiz      1880: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1881:     </pre>
1.110     hubertf  1882: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1883:     package on your system and rebuild any dependencies.
                   1884:     </p>
1.82      rillig   1885: </div>
1.148     asau     1886: <div class="sect2">
1.82      rillig   1887: <div class="titlepage"><div><div><h3 class="title">
                   1888: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1889: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1890:     administrative functions on the package system.</p>
1.82      rillig   1891: </div>
1.75      rillig   1892: </div>
1.148     asau     1893: <div class="sect1">
1.75      rillig   1894: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1895: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
1.88      wiz      1896: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1897:   directory now contains a set of packages, organized into
                   1898:   categories. You can browse the online index of packages, or run
1.110     hubertf  1899:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1900:   directory to build local <code class="filename">README.html</code> files for
1.189     snj      1901:   all packages, viewable with any web browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1902: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1903:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1904:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1905:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1906:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1907:   system (inside a chroot is an exception). </p>
                   1908: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1909:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.88      wiz      1910:   instructions how to create your own packages.</p>
1.148     asau     1911: <div class="sect2">
1.75      rillig   1912: <div class="titlepage"><div><div><h3 class="title">
                   1913: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
1.82      rillig   1914: <p>To build packages from source, you need a working C
1.88      wiz      1915:     compiler. On NetBSD, you need to install the
1.128     wiz      1916:     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1.88      wiz      1917:     sets. If you want to build X11-related packages, the
1.128     wiz      1918:     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1.88      wiz      1919:     sets are required, too.</p>
1.75      rillig   1920: </div>
1.148     asau     1921: <div class="sect2">
1.75      rillig   1922: <div class="titlepage"><div><div><h3 class="title">
                   1923: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1924: <p>The first step for building a package is downloading the
1.88      wiz      1925:     distfiles (i.e. the unmodified source). If they have not yet been
                   1926:     downloaded, pkgsrc will fetch them automatically.</p>
                   1927: <p>If you have all files that you need in the
                   1928:     <code class="filename">distfiles</code> directory,
                   1929:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1930:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1931:     </p>
1.82      rillig   1932: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1933: <p>
1.110     hubertf  1934:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1935: <p>By default a list of distribution sites will be randomly
                   1936:     intermixed to prevent huge load on servers which holding popular
                   1937:     packages (for example, SourceForge.net mirrors). Thus, every
                   1938:     time when you need to fetch yet another distfile all the mirrors
                   1939:     will be tried in new (random) order. You can turn this feature
                   1940:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1941:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1942: <p>You can overwrite some of the major distribution sites to
                   1943:     fit to sites that are close to your own.  By setting one or two
                   1944:     variables you can modify the order in which the master sites are
                   1945:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1946:     delimited list of domain suffixes.
                   1947:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1948:     contains a whitespace delimited list of regular expressions.  It
                   1949:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1950:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1951:     some examples.  This may save some of your bandwidth and
                   1952:     time.</p>
1.75      rillig   1953: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1954:     if you want to keep the settings, by editing the
1.110     hubertf  1955:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1956:     and adding the definitions there.</p>
1.82      rillig   1957: <p>
1.88      wiz      1958:       If a package depends on many other packages (such as
1.189     snj      1959:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde3/README.html" target="_top"><code class="filename">meta-pkgs/kde3</code></a>), the build process may
1.88      wiz      1960:       alternate between periods of
                   1961:       downloading source, and compiling. To ensure you have all the source
                   1962:       downloaded initially you can run the command:
                   1963:       </p>
1.82      rillig   1964: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1965: <p>
1.88      wiz      1966:       which will output and run a set of shell commands to fetch the
                   1967:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1968:       also choose to download the files manually.
                   1969:     </p>
1.75      rillig   1970: </div>
1.148     asau     1971: <div class="sect2">
1.75      rillig   1972: <div class="titlepage"><div><div><h3 class="title">
                   1973: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1974: <p>
1.88      wiz      1975:       Once the software has downloaded, any patches will be applied, then it
                   1976:       will be compiled for you. This may take some time depending on your
                   1977:       computer, and how many other packages the software depends on and their
                   1978:       compile time.
                   1979:     </p>
1.148     asau     1980: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1981: <h3 class="title">Note</h3>
                   1982: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1983:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1984:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1985: </div>
1.87      wiz      1986: <p>For example, type</p>
1.88      wiz      1987: <pre class="screen">
                   1988: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1989: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1990:     </pre>
1.75      rillig   1991: <p>at the shell prompt to build the various components of the
1.88      wiz      1992:     package.</p>
1.82      rillig   1993: <p>The next stage is to actually install the newly compiled
1.88      wiz      1994:     program onto your system. Do this by entering:
1.82      rillig   1995: 
1.88      wiz      1996:     </p>
1.82      rillig   1997: <pre class="screen">
1.88      wiz      1998: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1999:     </pre>
1.82      rillig   2000: <p>
                   2001: 
1.88      wiz      2002:     while you are still in the directory for whatever package you
                   2003:     are installing.</p>
1.82      rillig   2004: <p>Installing the package on your system may require you to
1.88      wiz      2005:     be root.  However, pkgsrc has a
                   2006:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   2007:     to only become root for the actual installation step.</p>
1.82      rillig   2008: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      2009:     You can now enter:
1.82      rillig   2010: 
1.88      wiz      2011:     </p>
1.82      rillig   2012: <pre class="screen">
1.88      wiz      2013: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   2014:     </pre>
1.82      rillig   2015: <p>
                   2016: 
1.88      wiz      2017:     to remove the compiled files in the work directory, as you shouldn't need
                   2018:     them any more. If other packages were also added to your system
                   2019:     (dependencies) to allow your program to compile, you can tidy these up
                   2020:     also with the command:</p>
1.82      rillig   2021: <pre class="screen">
1.88      wiz      2022: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   2023:     </pre>
1.75      rillig   2024: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  2025:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88      wiz      2026: <p>The program is installed under the default root of the
                   2027:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   2028:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   2029:     variable in your environment, and it will use that value as the
                   2030:     root of your packages tree. So, to use
                   2031:     <code class="filename">/usr/local</code>, set
                   2032:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   2033:     Please note that you should use a directory which is dedicated to
                   2034:     packages and not shared with other programs (i.e., do not try and
                   2035:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   2036:     to add any of your own files or directories (such as
                   2037:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   2038:     <code class="filename">pkgsrc/</code>) below the
                   2039:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   2040:     conflicts between programs and other files installed by the
                   2041:     package system and whatever else may have been installed
                   2042:     there.</p>
1.110     hubertf  2043: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      2044:     alter some configuration options at build time.  Have a look at
                   2045:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   2046:     of what will be set there by default.  Environment variables such
                   2047:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  2048:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      2049:     set them each time you want to use pkgsrc.</p>
1.128     wiz      2050: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   2051:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      2052:     or being installed. This may be for debugging purposes, or out of
                   2053:     simple curiosity. A number of utility values have been added to
                   2054:     help with this.</p>
1.128     wiz      2055: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2056: <li class="listitem">
1.189     snj      2057: <p>If you invoke 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> command with
1.88      wiz      2058:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   2059:        information will be displayed. For example,</p>
1.75      rillig   2060: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      2061: <p>will show all the commands that are invoked, up to and
1.128     wiz      2062:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   2063: </li>
1.128     wiz      2064: <li class="listitem">
1.189     snj      2065: <p>If you want to know the value of a certain <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      2066:        definition, then the <code class="varname">VARNAME</code> definition
                   2067:        should be used, in conjunction with the show-var
1.189     snj      2068:        target. e.g. to show the expansion 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>
1.88      wiz      2069:        variable <code class="varname">LOCALBASE</code>:</p>
                   2070: <pre class="screen">
                   2071: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   2072: /usr/pkg
                   2073: <code class="prompt">%</code>
1.88      wiz      2074:        </pre>
1.75      rillig   2075: </li>
                   2076: </ol></div>
                   2077: <p>If you want to install a binary package that you've either
1.88      wiz      2078:     created yourself (see next section), that you put into
                   2079:     pkgsrc/packages manually or that is located on a remote FTP
                   2080:     server, you can use the "bin-install" target. This target will
1.189     snj      2081:     install a binary package - if available - 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>,
1.110     hubertf  2082:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      2083:     sites searched is kept in the variable
                   2084:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.189     snj      2085:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      2086:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   2087:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   2088:     details.</p>
                   2089: <p>A final word of warning: If you set up a system that has a
                   2090:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   2091:     set that before any packages are installed, as you cannot use
                   2092:     several directories for the same purpose. Doing so will result in
                   2093:     pkgsrc not being able to properly detect your installed packages,
                   2094:     and fail miserably. Note also that precompiled binary packages are
                   2095:     usually built with the default <code class="varname">LOCALBASE</code> of
                   2096:     <code class="filename">/usr/pkg</code>, and that you should
                   2097:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   2098:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   2099: </div>
                   2100: </div>
                   2101: </div>
1.148     asau     2102: <div class="chapter">
1.75      rillig   2103: <div class="titlepage"><div><div><h2 class="title">
                   2104: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   2105: <div class="toc">
                   2106: <p><b>Table of Contents</b></p>
1.210     leot     2107: <dl class="toc">
1.75      rillig   2108: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   2109: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.109     rillig   2110: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.103     wiz      2111: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz      2112: <dd><dl>
1.103     wiz      2113: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.128     wiz      2114: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   2115: <dt><span class="sect2"><a href="#conf.ldflags">5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      2116: </dl></dd>
1.103     wiz      2117: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   2118: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.75      rillig   2119: </dl>
                   2120: </div>
1.104     rillig   2121: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   2122: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   2123: that file depends on the installation. On NetBSD, when you use
1.189     snj      2124: <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> from the base system, it is in the directory
1.89      rillig   2125: <code class="filename">/etc/</code>. In all other cases the default location is
                   2126: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   2127: bootstrap program to install the binary packages.</p>
                   2128: <p>During the bootstrap, an example configuration file is created. To
                   2129: use that, you have to create the directory
                   2130: <code class="filename">${PREFIX}/etc</code> and copy the example file
                   2131: there.</p>
                   2132: <p>The format of the configuration file is that of the usual
                   2133: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   2134: is done by setting variables in this file. Note that you can define all
                   2135: kinds of variables, and no special error checking (for example for
                   2136: spelling mistakes) takes place, so you have to try it out to see if it
                   2137: works.</p>
1.148     asau     2138: <div class="sect1">
1.75      rillig   2139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2140: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
                   2141: <p>In this section, you can find some variables that apply to all
1.89      rillig   2142:     pkgsrc packages. A complete list of the variables that can be
                   2143:     configured by the user is available in
                   2144:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   2145:     comments that describe each variable's intent.</p>
1.148     asau     2146: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2147: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   2148:            packages will be installed. The default is
1.76      rillig   2149:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   2150:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      2151: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   2152:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   2153:            installed. The default is
1.76      rillig   2154:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      2155: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   2156:            X11 is installed on the system. The default is
1.194     bsiegert 2157:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      2158: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   2159:            downloaded copies of the original source distributions used
                   2160:            for building pkgsrc packages. The default is
1.76      rillig   2161:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      2162: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   2163:            database about installed packages is stored.  The default is
                   2164:            <code class="filename">/var/db/pkg</code>.</p></li>
1.128     wiz      2165: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   2166:            If set, override the packages'
                   2167:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      2168: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   2169:            Backup location(s) for distribution files and patch files
                   2170:            if not found locally or in
1.76      rillig   2171:            <code class="filename">${MASTER_SITES}</code> or
                   2172:            <code class="filename">${PATCH_SITES}</code> respectively.
1.75      rillig   2173:            The defaults are
1.132     spz      2174:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>
1.75      rillig   2175:            and
1.76      rillig   2176:            <code class="filename">ftp://ftp.freebsd.org/pub/FreeBSD/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      2177: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   2178:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   2179:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      2180:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   2181:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   2182: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      2183:            List of acceptable licenses. License names are case-sensitive.
                   2184:            Whenever you try to build a package whose license is not in this
                   2185:            list, you will get an error message. If the license condition is
                   2186:            simple enough, the error message will include specific
                   2187:            instructions on how to change this variable.</p></li>
1.75      rillig   2188: </ul></div>
                   2189: </div>
1.148     asau     2190: <div class="sect1">
1.75      rillig   2191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2192: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.219   ! rillig   2193: <p>
1.75      rillig   2194:       </p>
1.148     asau     2195: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2196: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   2197:            directory for the binary packages. The default is
1.76      rillig   2198:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      2199: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   2200:            The top level directory where, if defined, the separate
                   2201:            working directories will get created, and symbolically
1.76      rillig   2202:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   2203:            This is useful for building packages on several
1.76      rillig   2204:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   2205:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   2206:            is local to every architecture. (It should be noted that
                   2207:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 2208:            &mdash; it is an internal definition which refers to the
1.75      rillig   2209:            root of the pkgsrc tree. It is possible to have many
                   2210:            pkgsrc tree instances.)</p></li>
1.128     wiz      2211: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   2212:            Directory for local patches that aren't part of pkgsrc.
1.219   ! rillig   2213:            See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more
1.93      rillig   2214:            information.</p></li>
1.128     wiz      2215: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  2216:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   2217:            BSD-style Makefile. If this is not set,
                   2218:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   2219:            <code class="filename">/dev/null</code> to avoid picking up
                   2220:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.128     wiz      2221: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.82      rillig   2222:            By default, dependencies are only installed, and no binary
                   2223:            package is created for them. You can set this variable to
1.174     asau     2224:            <code class="literal">package-install</code> to automatically create binary
1.190     wiz      2225:            packages after installing dependencies. Please note that the
1.194     bsiegert 2226:            <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.190     wiz      2227:            <code class="literal">yes</code> to preserve binary packages when
                   2228:            using the <code class="literal">install</code> as well.</p></li>
1.75      rillig   2229: </ul></div>
                   2230: </div>
1.148     asau     2231: <div class="sect1">
1.75      rillig   2232: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.109     rillig   2233: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.217     jnemeth  2234: <p>Packages have to support installation into a
1.103     wiz      2235:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   2236:     to be built, before the actual filesystem is touched. DESTDIR
                   2237:     support exists in two variations:</p>
1.148     asau     2238: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2239: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      2240:       installation and packaging is still run as root.</p></li>
                   2241: <li class="listitem"><p>Full DESTDIR support can run the complete
                   2242:       build, installation and packaging as normal user. Root
                   2243:       privileges are only needed to add packages.</p></li>
                   2244: </ul></div>
1.103     wiz      2245: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   2246:     clean</code></strong> needs to be run as root.</p>
1.118     imil     2247: <p>Considering the <code class="filename">foo/bar</code> package,
                   2248:     DESTDIR full support can be tested using the following commands
                   2249: 
                   2250: </p>
                   2251: <pre class="programlisting">
                   2252: <code class="prompt">$</code> id
                   2253: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   2254: <code class="prompt">$</code> mkdir $HOME/packages
                   2255: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   2256: </pre>
                   2257: <p>
                   2258: 
                   2259:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   2260:     should be needed
                   2261: 
                   2262: </p>
                   2263: <pre class="programlisting">
1.174     asau     2264: <code class="prompt">$</code> make stage-install
1.118     imil     2265: </pre>
                   2266: <p>
                   2267: 
                   2268:     Create a package without root privileges
                   2269: 
                   2270: </p>
                   2271: <pre class="programlisting">
1.174     asau     2272: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     2273: </pre>
                   2274: <p>
                   2275: 
                   2276:     For the following command, you must be able to gain root
1.189     snj      2277:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     2278: 
                   2279: </p>
                   2280: <pre class="programlisting">
1.174     asau     2281: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     2282: </pre>
                   2283: <p>
                   2284: 
                   2285:     Then, as a simple user
                   2286: 
                   2287: </p>
                   2288: <pre class="programlisting">
                   2289: <code class="prompt">$</code> make clean
                   2290: </pre>
                   2291: <p>
                   2292: 
                   2293:     </p>
1.103     wiz      2294: </div>
1.148     asau     2295: <div class="sect1">
1.103     wiz      2296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2297: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     2298: <div class="sect2">
1.78      rillig   2299: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2300: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   2301: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   2302:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     2303: <div class="variablelist"><dl class="variablelist">
1.89      rillig   2304: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   2305: <dd>
                   2306: <p>This is a list of values specifying the chain of
                   2307:          compilers to invoke when building packages.  Valid values
                   2308:          are:</p>
1.148     asau     2309: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     2310: <li class="listitem"><p><code class="varname">ccc</code>:
                   2311:            Compaq C Compilers (Tru64)</p></li>
                   2312: <li class="listitem"><p><code class="varname">ccache</code>:
                   2313:            compiler cache (chainable)</p></li>
                   2314: <li class="listitem"><p><code class="varname">clang</code>:
                   2315:            Clang C and Objective-C compiler</p></li>
1.128     wiz      2316: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   2317:            distributed C/C++ (chainable)</p></li>
1.174     asau     2318: <li class="listitem"><p><code class="varname">f2c</code>:
                   2319:            Fortran 77 to C compiler (chainable)</p></li>
                   2320: <li class="listitem"><p><code class="varname">icc</code>:
                   2321:            Intel C++ Compiler (Linux)</p></li>
                   2322: <li class="listitem"><p><code class="varname">ido</code>:
                   2323:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      2324: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   2325:            GNU C/C++ Compiler</p></li>
1.174     asau     2326: <li class="listitem"><p><code class="varname">hp</code>:
                   2327:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      2328: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   2329:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     2330: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   2331:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      2332: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   2333:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     2334: <li class="listitem"><p><code class="varname">xlc</code>:
                   2335:            IBM's XL C/C++ compiler suite (Darwin/MacOSX)</p></li>
1.89      rillig   2336: </ul></div>
                   2337: <p>The default is
1.128     wiz      2338:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   2339:          <code class="varname">ccache</code> and/or
                   2340:          <code class="varname">distcc</code> with an appropriate
                   2341:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      2342:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 2343:          variable should always be terminated with a value for
                   2344:          a real compiler.  Note that only one real compiler
1.128     wiz      2345:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 2346:          is not allowed).</p>
1.89      rillig   2347: </dd>
                   2348: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   2349: <dd><p>This specifies the minimum version of GCC to use
                   2350:          when building packages.  If the system GCC doesn't
                   2351:          satisfy this requirement, then pkgsrc will build and
                   2352:          install one of the GCC packages to use instead.</p></dd>
                   2353: </dl></div>
                   2354: </div>
1.148     asau     2355: <div class="sect2">
1.89      rillig   2356: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2357: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   2358: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   2359:        please make sure to use the <code class="literal">+=</code> operator
                   2360:        instead of the <code class="literal">=</code> operator:</p>
                   2361: <pre class="programlisting">
1.100     rillig   2362: CFLAGS+=        -your -flags
1.78      rillig   2363: </pre>
                   2364: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      2365:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  2366:        need to add their own flags.  You may want to take a look
1.189     snj      2367:        at the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      2368:        package if you're interested in optimization specifically
                   2369:        for the current CPU. </p>
1.78      rillig   2370: </div>
1.148     asau     2371: <div class="sect2">
1.88      wiz      2372: <div class="titlepage"><div><div><h3 class="title">
1.103     wiz      2373: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      2374: <p>If you want to pass flags to the linker, both in the configure
                   2375: step and the build step, you can do this in two ways.  Either set
                   2376: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   2377: between the two is that <code class="varname">LIBS</code> will be appended to
                   2378: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   2379: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   2380: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   2381: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   2382: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   2383: settings, use the <code class="literal">+=</code> operator:</p>
                   2384: <pre class="programlisting">
1.100     rillig   2385: LDFLAGS+=        -your -linkerflags
1.88      wiz      2386: </pre>
                   2387: </div>
1.78      rillig   2388: </div>
1.148     asau     2389: <div class="sect1">
1.78      rillig   2390: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2391: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 2392: <p>
1.75      rillig   2393:       </p>
1.148     asau     2394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2395: <li class="listitem">
1.75      rillig   2396: <p><code class="varname">PKG_DEVELOPER</code>:
                   2397:            Run some sanity checks that package developers want:
                   2398:            </p>
1.148     asau     2399: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      2400: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      2401:              fuzz</p></li>
1.128     wiz      2402: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      2403:              binaries will find their shared libs.</p></li>
1.75      rillig   2404: </ul></div>
                   2405: <p>
1.87      wiz      2406:        </p>
1.75      rillig   2407: </li>
1.128     wiz      2408: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      2409:        of debugging output which is displayed whilst making and
                   2410:        installing the package.  The default value for this is 0,
                   2411:        which will not display the commands as they are executed
                   2412:        (normal, default, quiet operation); the value 1 will display
                   2413:        all shell commands before their invocation, and the value 2
                   2414:        will display both the shell commands before their invocation,
1.110     hubertf  2415:        and their actual execution progress with <span class="command"><strong>set
1.88      wiz      2416:        -x</strong></span> will be displayed.</p></li>
1.75      rillig   2417: </ul></div>
                   2418: <p>
                   2419:     </p>
                   2420: </div>
1.148     asau     2421: <div class="sect1">
1.75      rillig   2422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.103     wiz      2423: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      2424: <p>Some packages have build time options, usually to select
                   2425:     between different dependencies, enable optional support for big
                   2426:     dependencies or enable experimental features.</p>
1.75      rillig   2427: <p>To see which options, if any, a package supports, and which
1.110     hubertf  2428:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      2429:     show-options</strong></span>, for example:</p>
1.75      rillig   2430: <pre class="programlisting">
                   2431:     The following options are supported by this package:
                   2432:         ssl      Enable SSL support.
                   2433:     Exactly one of the following gecko options is required:
                   2434:         firefox  Use firefox as gecko rendering engine.
                   2435:         mozilla  Use mozilla as gecko rendering engine.
                   2436:     At most one of the following database options may be selected:
                   2437:         mysql    Enable support for MySQL database.
                   2438:         pgsql    Enable support for PostgreSQL database.
1.1       grant    2439: 
1.75      rillig   2440:     These options are enabled by default: firefox
                   2441:     These options are currently enabled: mozilla ssl
1.1       grant    2442: </pre>
1.75      rillig   2443: <p>The following variables can be defined in
1.110     hubertf  2444:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      2445:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   2446:     which can be used to select or disable options for all packages
                   2447:     that support them, and
                   2448:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2449:     which can be used to select or disable options specifically for
                   2450:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      2451:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      2452:     are disabled. A few examples:</p>
1.75      rillig   2453: <pre class="screen">
1.110     hubertf  2454: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75      rillig   2455: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2456: PKG_OPTIONS.kdebase=    debug -sasl
                   2457: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2458: <p>It is important to note that options that were specifically
1.120     snj      2459:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2460:     you do not wish to include the option.  If you are unsure you can view
                   2461:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2462: <p>The following settings are consulted in the order given, and
                   2463:     the last setting that selects or disables an option is
                   2464:     used:</p>
1.128     wiz      2465: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2466: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2467:       maintainer</p></li>
1.128     wiz      2468: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2469:       variables (see below)</p></li>
1.128     wiz      2470: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2471: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2472: </ol></div>
                   2473: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2474:     selected is used, all others are automatically disabled.  If an
                   2475:     option of the group is explicitly disabled, the previously
                   2476:     selected option, if any, is used.  It is an error if no option
                   2477:     from a required group of options is selected, and building the
                   2478:     package will fail.</p>
                   2479: <p>Before the options framework was introduced, build options
                   2480:     were selected by setting a variable (often named
                   2481:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2482:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2483:     transition to the options framework for the user, these legacy
                   2484:     variables are converted to the appropriate options setting
                   2485:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2486:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2487:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2488:     directly.  Support for the legacy variables will be removed
                   2489:     eventually.</p>
1.75      rillig   2490: </div>
                   2491: </div>
1.148     asau     2492: <div class="chapter">
1.75      rillig   2493: <div class="titlepage"><div><div><h2 class="title">
                   2494: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   2495: <div class="toc">
                   2496: <p><b>Table of Contents</b></p>
1.210     leot     2497: <dl class="toc">
1.75      rillig   2498: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   2499: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   2500: </dl>
                   2501: </div>
1.148     asau     2502: <div class="sect1">
1.75      rillig   2503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2504: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2505: <p>Once you have built and installed a package, you can create
                   2506:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.189     snj      2507:     another system with <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>. This saves having to build
1.87      wiz      2508:     the same package on a group of hosts and wasting CPU time. It also
                   2509:     provides a simple means for others to install your package, should
                   2510:     you distribute it.</p>
                   2511: <p>To create a binary package, change into the appropriate
1.110     hubertf  2512:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2513:     package</strong></span>:</p>
                   2514: <pre class="screen">
                   2515: <code class="prompt">#</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2516: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   2517:     </pre>
                   2518: <p>This will build and install your package (if not already done),
                   2519:     and then build a binary package from what was installed. You can
1.110     hubertf  2520:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2521:     it. Binary packages are created by default in
                   2522:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2523:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.189     snj      2524:     continuation of the above <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.110     hubertf  2525: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2526:     such a binary package.</p>
1.75      rillig   2527: </div>
1.148     asau     2528: <div class="sect1">
1.75      rillig   2529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2530: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.110     hubertf  2531: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2532: </div>
                   2533: </div>
1.148     asau     2534: <div class="chapter">
1.106     rillig   2535: <div class="titlepage"><div><div><h2 class="title">
                   2536: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2537: builds)</h2></div></div></div>
                   2538: <div class="toc">
                   2539: <p><b>Table of Contents</b></p>
1.210     leot     2540: <dl class="toc">
1.180     wiz      2541: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                   2542: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                   2543: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                   2544: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.174     asau     2545: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2546: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2547: </dl>
                   2548: </div>
1.180     wiz      2549: <p>For a number of reasons you may want to build binary packages
                   2550: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
                   2551: For instance, when you have multiple machines that should run the same software,
                   2552: it is wasted time if they all build their packages themselves from source.
                   2553: Or you may want to build a list of packages you want and check them before
                   2554: deploying onto production system.
                   2555: There is a way of getting a set of binary packages:
1.174     asau     2556: The bulk build system, or pbulk ("p" stands for "parallel).
                   2557: This chapter describes how to set it up so that the packages
1.106     rillig   2558: are most likely to be usable later.</p>
1.148     asau     2559: <div class="sect1">
1.106     rillig   2560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2561: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
                   2562: <p>First of all, you have to decide whether you build all packages
                   2563: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2564: both space and time, than builds for some practical sets of packages.
                   2565: There exists a number of particularly heavy packages that are not actually
                   2566: interesting to a wide audience.
                   2567: 
                   2568: For a limited bulk builds you need to make a list of packages you want to build.
                   2569: Note, that all their dependencies will be built, so you don't need to track them manually.
                   2570: </p>
                   2571: <p>During bulk builds various packages are installed and deinstalled
                   2572: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2573: so make sure that you don't need any package during the builds.
                   2574: Essentially, you should provide fresh system, either a chroot environment
                   2575: or something even more restrictive, depending on what the operating system provides,
                   2576: or dedicate the whole physical machine.
                   2577: As a useful side effect this makes sure that bulk builds cannot
                   2578: break anything in your system. There have been numerous cases where
1.106     rillig   2579: certain packages tried to install files outside the
                   2580: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2581: <code class="filename">/etc</code>.
                   2582: </p>
1.106     rillig   2583: </div>
1.148     asau     2584: <div class="sect1">
1.106     rillig   2585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2586: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   2587: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148     asau     2588: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2589: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2590: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2591: </ul></div>
1.148     asau     2592: <div class="sect2">
1.116     rillig   2593: <div class="titlepage"><div><div><h3 class="title">
1.180     wiz      2594: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.178     asau     2595: <p>To simplify configuration we provide helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
                   2596: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2597: Configure network access to fetch distribution files.
                   2598: Create user with name "pbulk".</p>
                   2599: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2600: <pre class="screen">
1.181     wiz      2601: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; ftp -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
                   2602: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; fetch -o - http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
                   2603: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178     asau     2604: </pre>
                   2605: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2606: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2607: <pre class="screen">
                   2608: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # native (NetBSD)</code></strong>
                   2609: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n -c mk.conf.frag # native, apply settings from given mk.conf fragment</code></strong>
                   2610: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2611: </pre>
                   2612: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2613: <h3 class="title">Note</h3>
                   2614: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2615: <code class="filename">mk.conf</code> that contains settings you want to
                   2616: apply to packages you build. For instance,</p>
                   2617: <pre class="programlisting">
                   2618: PKG_DEVELOPER=         yes             # perform more checks
                   2619: X11_TYPE=              modular         # use pkgsrc X11
                   2620: SKIP_LICENSE_CHECK=    yes             # accept all licences (useful when building all packages)
                   2621: </pre>
                   2622: </div>
                   2623: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
                   2624: with your list of packages one per line without empty lines or comments. E.g.:</p>
                   2625: <pre class="programlisting">
                   2626: www/firefox
                   2627: mail/thunderbird
                   2628: misc/libreoffice4
                   2629: </pre>
1.179     asau     2630: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2631: and make final amendments, if wanted.</p>
1.178     asau     2632: <p>Start it:</p>
                   2633: <pre class="screen">
                   2634: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2635: </pre>
                   2636: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2637: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2638: </p>
                   2639: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2640: <h3 class="title">Note</h3>
                   2641: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2642: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2643: The script is kept small enough for better understanding.</p>
                   2644: </div>
                   2645: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2646: <h3 class="title">Note</h3>
                   2647: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2648: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2649: </div>
1.106     rillig   2650: </div>
                   2651: </div>
1.148     asau     2652: <div class="sect1">
1.106     rillig   2653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     wiz      2654: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
                   2655: <p>A complete bulk build requires lots of disk space. Some of the
                   2656: disk space can be read-only, some other must be writable. Some can be on
                   2657: remote filesystems (such as NFS) and some should be local. Some can be
                   2658: temporary filesystems, others must survive a sudden reboot.</p>
                   2659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2660: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2661: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2662: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2663: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2664: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2665: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2666: </ul></div>
                   2667: </div>
                   2668: <div class="sect1">
                   2669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.174     asau     2670: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2671: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2672:     create a CD-ROM set of the resulting binary packages to assist
                   2673:     in installing packages on other machines.  The
1.189     snj      2674:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2675:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2676:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2677:     way that keeps all the dependencies for a given package on the same
                   2678:     CD as that package.</p>
1.148     asau     2679: <div class="sect2">
1.75      rillig   2680: <div class="titlepage"><div><div><h3 class="title">
1.174     asau     2681: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2682: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2683:       man page. The following short example assumes that the binary
                   2684:       packages are left in
                   2685:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2686:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2687:       hold the ISO 9660 images.</p>
                   2688: <pre class="screen">
                   2689: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2690: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2691: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2692:       </pre>
                   2693: <p>If you wish to include a common set of files
                   2694:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2695:       etc.) on each CD in the collection, then you need to create a
                   2696:       directory which contains these files. e.g.</p>
                   2697: <pre class="screen">
                   2698: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2699: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2700: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2701: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2702: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2703: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2704: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2705:       </pre>
1.75      rillig   2706: <p>Now create the images:</p>
                   2707: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76      rillig   2708: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2709:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2710:       in their root directories.</p>
1.75      rillig   2711: </div>
                   2712: </div>
                   2713: </div>
1.148     asau     2714: <div class="chapter">
1.75      rillig   2715: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2716: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2717: <div class="toc">
                   2718: <p><b>Table of Contents</b></p>
1.210     leot     2719: <dl class="toc">
1.128     wiz      2720: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2721: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90      rillig   2722: </dl>
                   2723: </div>
                   2724: <p>The files that are installed by pkgsrc are organized in a way that
                   2725: is similar to what you find in the <code class="filename">/usr</code> directory
                   2726: of the base system. But some details are different. This is because
                   2727: pkgsrc initially came from FreeBSD and had adopted its file system
                   2728: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2729: which operating system you are using pkgsrc with, you can expect the
                   2730: same layout for pkgsrc.</p>
1.91      rillig   2731: <p>There are mainly four root directories for pkgsrc, which are all
                   2732: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2733: When pkgsrc has been installed as root, the default locations
                   2734: are:</p>
                   2735: <pre class="programlisting">
1.100     rillig   2736: LOCALBASE=              /usr/pkg
                   2737: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2738: VARBASE=                /var
                   2739: PKG_DBDIR=              /var/db/pkg
1.91      rillig   2740: </pre>
                   2741: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2742: user), the default locations are:</p>
                   2743: <pre class="programlisting">
1.100     rillig   2744: LOCALBASE=              ${HOME}/pkg
                   2745: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2746: VARBASE=                ${HOME}/pkg/var
                   2747: PKG_DBDIR=              ${HOME}/pkg/var/db/pkg
1.91      rillig   2748: </pre>
                   2749: <p>What these four directories are for, and what they look like is
                   2750: explained below.</p>
1.148     asau     2751: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2752: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2753: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2754: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2755: the well-known subdirectories like <code class="filename">bin</code>,
                   2756: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2757: <code class="filename">share</code> and
                   2758: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2759: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2760: <code class="filename">/var</code> in the base system. Some programs (especially
                   2761: games, network daemons) need write access to it during normal
                   2762: operation.</p></li>
1.128     wiz      2763: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2764: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2765: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90      rillig   2766: itself.</p></li>
                   2767: </ul></div>
1.148     asau     2768: <div class="sect1">
1.90      rillig   2769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2770: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2771: </h2></div></div></div>
1.90      rillig   2772: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2773: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2774: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2775: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2776: <dd><p>Contains executable programs that are intended to be
                   2777: directly used by the end user.</p></dd>
                   2778: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2779: <dd><p>Contains files for the emulation layers of various other
                   2780: operating systems, especially for
                   2781: NetBSD.</p></dd>
                   2782: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2783: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2784: <dd><p>Contains
                   2785: the configuration files.</p></dd>
                   2786: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2787: <dd><p>Contains headers for the C and C++ programming
                   2788: languages.</p></dd>
                   2789: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2790: <dd><p>Contains GNU info files of various
                   2791: packages.</p></dd>
                   2792: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2793: <dd><p>Contains shared and static
                   2794: libraries.</p></dd>
                   2795: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2796: <dd><p>Contains data files that don't change after
                   2797: installation. Other data files belong into
                   2798: <code class="filename">${VARBASE}</code>.</p></dd>
                   2799: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2800: <dd><p>Contains programs that are not intended to be used by
                   2801: end users, such as helper programs or network
                   2802: daemons.</p></dd>
                   2803: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2804: <dd><p>Contains programs that are intended to be executed as
                   2805: CGI scripts by a web server.</p></dd>
                   2806: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2807: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2808: <dd><p>Contains brief
                   2809: documentation in form of manual pages.</p></dd>
                   2810: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2811: <dd><p>Contains programs that are intended to be used only by
                   2812: the super-user.</p></dd>
                   2813: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2814: <dd><p>Contains platform-independent data files that don't
                   2815: change after installation.</p></dd>
                   2816: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2817: <dd><p>Contains documentation files provided by the
                   2818: packages.</p></dd>
                   2819: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2820: <dd><p>Contains example files provided by the packages. Among
                   2821: others, the original configuration files are saved here and copied to
                   2822: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2823: installation.</p></dd>
                   2824: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2825: <dd><p>Contains the original files for rc.d
                   2826: scripts.</p></dd>
                   2827: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2828: <code class="filename">${VARBASE}</code>)</span></dt>
                   2829: <dd><p>Contains files
                   2830: that may be modified after
                   2831: installation.</p></dd>
                   2832: </dl></div>
                   2833: </div>
1.148     asau     2834: <div class="sect1">
1.90      rillig   2835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2836: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2837: </h2></div></div></div>
1.148     asau     2838: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2839: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2840: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2841: <dd><p>Contains
                   2842: information about the currently installed
                   2843: packages.</p></dd>
                   2844: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2845: <dd><p>Contains highscore
                   2846: files.</p></dd>
                   2847: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2848: <dd><p>Contains log files.</p></dd>
                   2849: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2850: <dd><p>Contains informational files about daemons that are
                   2851: currently running.</p></dd>
                   2852: </dl></div>
                   2853: </div>
                   2854: </div>
1.148     asau     2855: <div class="chapter">
1.90      rillig   2856: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   2857: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2858: <div class="toc">
                   2859: <p><b>Table of Contents</b></p>
1.210     leot     2860: <dl class="toc">
1.106     rillig   2861: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.194     bsiegert 2862: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                   2863: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                   2864: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2865: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">9.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                   2866: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                   2867: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                   2868: <dt><span class="sect1"><a href="#passive-ftp">9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                   2869: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                   2870: <dt><span class="sect1"><a href="#tmac.andoc-missing">9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2871: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.194     bsiegert 2872: <dt><span class="sect1"><a href="#bsd.own.mk-missing">9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                   2873: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2874: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   2875: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                   2876: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2877: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                   2878: <dt><span class="sect1"><a href="#faq.rcs-conflicts">9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig   2879: </dl>
                   2880: </div>
                   2881: <p>This section contains hints, tips &amp; tricks on special things in
                   2882: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2883: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2884: <div class="sect1">
1.75      rillig   2885: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   2886: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2887: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2888: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2889: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   2890:          This is a general purpose list for most issues regarding
                   2891:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2892:          for pkgsrc configuration, unexpected build failures, using
                   2893:          particular packages, upgrading pkgsrc installations,
                   2894:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2895:          proposals for changes that impact the pkgsrc user community,
                   2896:          e.g. major infrastructure changes, new features, package
                   2897:          removals, etc., may also be posted.</p></li>
1.128     wiz      2898: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   2899:          A list where the results of pkgsrc bulk builds are sent and
                   2900:          discussed.</p></li>
1.128     wiz      2901: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   2902:          This list is for those who are interested in getting a
                   2903:          commit message for every change committed to pkgsrc. It is
                   2904:          also available in digest form, meaning one daily message
                   2905:          containing all commit messages for changes to the package
                   2906:          source tree in that 24 hour period.</p></li>
                   2907: </ul></div>
                   2908: <p>To subscribe, do:</p>
                   2909: <pre class="programlisting">
1.100     rillig   2910: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2911: </pre>
                   2912: <p>Archives for all these mailing lists are available from
1.110     hubertf  2913: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2914: </div>
1.148     asau     2915: <div class="sect1">
1.75      rillig   2916: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2917: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2918: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2919: a number of useful utilities for both users and developers of pkgsrc.  This
                   2920: section attempts only to make the reader aware of the utilities and when
                   2921: they might be useful, and not to duplicate the documentation that comes
                   2922: with each package.</p>
                   2923: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.189     snj      2924: <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/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   2925:       Symlinks for use by buildlink.</p></li></ul></div>
                   2926: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2927: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2928: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.75      rillig   2929:       Calculates various kinds of checksums (including SHA1).</p></li>
1.189     snj      2930: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   2931:       Compatibility library for pkgsrc tools.</p></li>
1.189     snj      2932: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      2933:       non-BSD systems due to lack of native mtree.</p></li>
1.189     snj      2934: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   2935:       Up-to-date replacement for
1.76      rillig   2936:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2937:       systems where pkg_install is not present.</p></li>
                   2938: </ul></div>
                   2939: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2940: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2941: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   2942:       Create a binary package from an
1.110     hubertf  2943:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2944:       save the old package.</p></li>
1.189     snj      2945: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   2946:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2947:       from multiple locations. It currently supports the following
                   2948:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.189     snj      2949: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117     jnemeth  2950:       the best compiler flags to optimise code for your current
1.128     wiz      2951:       CPU and compiler. </p></li>
1.75      rillig   2952: </ul></div>
                   2953: <p>Utilities for keeping track of installed packages, being up to date,
                   2954: etc:</p>
1.148     asau     2955: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2956: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173     wiz      2957:     update tool similar to apt(1). Download, install, and upgrade
                   2958:     binary packages easily.</p></li>
1.189     snj      2959: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   2960:       packages whose installed versions do not match the latest pkgsrc
                   2961:       entries.</p></li>
1.189     snj      2962: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   2963:       dependency graphs of packages, to aid in choosing a strategy for
                   2964:       updating.</p></li>
1.189     snj      2965: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   2966:       graphs from the output of <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   2967: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   2968:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.189     snj      2969: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   2970:       does various checks on the complete pkgsrc system.</p></li>
1.189     snj      2971: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   2972:       packages you have installed.</p></li>
                   2973: </ul></div>
                   2974: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2975: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2976: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   2977:       making and maintaining patches for a package (includes pkgdiff,
                   2978:       pkgvi, mkpatches, etc.).</p></li>
1.189     snj      2979: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   2980:       converting to pkgsrc.</p></li>
                   2981: </ul></div>
                   2982: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2983: utilities)</p>
1.148     asau     2984: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      2985: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   2986:       packages in a chrooted area.</p></li>
1.189     snj      2987: <li class="listitem"><p><a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   2988:       kernel version for chrooted cross builds.</p></li>
                   2989: </ul></div>
                   2990: </div>
1.148     asau     2991: <div class="sect1">
1.75      rillig   2992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 2993: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219   ! rillig   2994: <p>To install packages from source as a non-root user, download
        !          2995: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 2. Where to get pkgsrc and how to keep it up-to-date">Chapter 2, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
        !          2996: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
        !          2997: --unprivileged</strong></span>.</p>
        !          2998: <p>This will install the binary part of pkgsrc to
        !          2999: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
        !          3000: into <code class="filename">~/pkg/etc</code>.</p>
        !          3001: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   3002: </div>
1.148     asau     3003: <div class="sect1">
1.75      rillig   3004: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3005: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   3006: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   3007: enable this feature by adding the option
                   3008: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  3009: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   3010: distfile is found, pkgsrc will try to resume it.</p>
                   3011: <p>You can also
1.168     wiz      3012: use a different program than the platform default program by changing the
1.117     jnemeth  3013: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   3014: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   3015: by using the value manual.  A value of custom disables the system defaults
                   3016: and dependency tracking for the fetch program.  In that case you have to
                   3017: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   3018: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   3019: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   3020: <p>For example, if you want to use
1.117     jnemeth  3021: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   3022: like:</p>
                   3023: <pre class="programlisting">
1.117     jnemeth  3024: FETCH_USING=   wget
1.1       grant    3025: </pre>
1.75      rillig   3026: </div>
1.148     asau     3027: <div class="sect1">
1.75      rillig   3028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3029: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      3030: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   3031: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   3032: you will have to add the following line into
1.110     hubertf  3033: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   3034: <pre class="programlisting">
1.103     wiz      3035: X11_TYPE=modular
1.1       grant    3036: </pre>
1.148     asau     3037: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   3038: <h3 class="title">Note</h3>
1.103     wiz      3039: <p>The DragonFly operating system defaults to using modular X.org from pkgsrc.
                   3040: </p>
1.75      rillig   3041: </div>
                   3042: </div>
1.148     asau     3043: <div class="sect1">
1.75      rillig   3044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3045: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   3046: <p>If you are sitting behind a firewall which does not allow direct
                   3047: connections to Internet hosts (i.e. non-NAT), you may specify the
                   3048: relevant proxy hosts.  This is done using an environment variable in the
                   3049: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      3050: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   3051: port 80 as the proxy port number.  So the proxy environment variables
                   3052: are:</p>
                   3053: <pre class="programlisting">
1.100     rillig   3054: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   3055: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    3056: </pre>
1.75      rillig   3057: </div>
1.148     asau     3058: <div class="sect1">
1.75      rillig   3059: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3060: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      3061: <p>Some fetch tools are not prepared to support HTTPS by default
                   3062: (for example, the one in NetBSD 6.0), or the one installed by the
                   3063: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   3064: dependency graph).</p>
                   3065: <p>Usually you won't notice, because distribution files are
                   3066: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   3067: be often enough if you are following pkgsrc-current. In that case, set
                   3068: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   3069: <span class="quote">&#8220;<span class="quote">curl</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">wget</span>&#8221;</span>, which are both compiled
                   3070: with HTTPS support by default. Of course, these tools need to be
                   3071: installed before you can use them this way.</p>
                   3072: </div>
                   3073: <div class="sect1">
                   3074: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3075: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   3076: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   3077: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   3078: the first available command from the following list:</p>
1.148     asau     3079: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3080: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   3081: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   3082: </ul></div>
                   3083: <p>On a default NetBSD installation, this will be
1.76      rillig   3084: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   3085: connections first, and falls back to active connections if the server
                   3086: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  3087: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   3088: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   3089: <p>Having that option present will prevent
1.76      rillig   3090: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   3091: transfers.</p>
                   3092: </div>
1.148     asau     3093: <div class="sect1">
1.75      rillig   3094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3095: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      3096: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  3097: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      3098: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   3099: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  3100: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   3101: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   3102: resulting list to your machine at work/school and use it there.  If you
1.189     snj      3103: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   3104: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   3105: URL:</p>
                   3106: <p>At home:</p>
                   3107: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   3108: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   3109: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   3110: <p>At work:</p>
                   3111: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   3112: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   3113: home.</p>
                   3114: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      3115: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   3116: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  3117: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      3118: directly by running:</p>
1.75      rillig   3119: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   3120: <p>If you even decide to ignore
                   3121: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   3122: by running:</p>
                   3123: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   3124: </div>
1.148     asau     3125: <div class="sect1">
1.75      rillig   3126: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3127: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      3128: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.189     snj      3129: <p>When compiling the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   3130: package, you get the error from make that it doesn't know how to make
1.76      rillig   3131: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      3132: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   3133: the NetBSD base distribution on your machine.  It is recommended to do
                   3134: that to format man pages.</p>
1.189     snj      3135: <p>In the case of the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   3136: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  3137: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   3138: </div>
1.148     asau     3139: <div class="sect1">
1.75      rillig   3140: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3141: <a name="bsd.own.mk-missing"></a>9.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
1.87      wiz      3142: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   3143: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   3144: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   3145: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   3146: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   3147: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  3148: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   3149: -r</strong></span>).</p>
                   3150: </div>
1.148     asau     3151: <div class="sect1">
1.75      rillig   3152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3153: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   3154: <p>When installing packages as non-root user and using the just-in-time
1.189     snj      3155: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   3156: password for each required package installed.  To avoid this, the sudo
                   3157: package can be used, which does password caching over a limited time.  To
                   3158: use it, install sudo (either as binary package or from
1.189     snj      3159: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  3160: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      3161: <span class="emphasis"><em>after</em></span> the definition of the
                   3162: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   3163: <pre class="programlisting">
1.100     rillig   3164: .if exists(${LOCALBASE}/bin/sudo)
                   3165: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   3166: .endif
1.1       grant    3167: </pre>
1.75      rillig   3168: </div>
1.148     asau     3169: <div class="sect1">
1.75      rillig   3170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3171: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   3172: <p>As the system administrator, you can choose where configuration files
                   3173: are installed.  The default settings make all these files go into
1.76      rillig   3174: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   3175: be suboptimal depending on your expectations (e.g., a read-only,
                   3176: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   3177: configuration of the provided packages).</p>
                   3178: <p>In order to change the defaults, you can modify the
                   3179: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  3180: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   3181: directory; some common examples include <code class="filename">/etc</code> or
                   3182: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   3183: <p>Furthermore, you can change this value on a per-package basis by
                   3184: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   3185: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   3186: package you would like to modify, that is, the contents of
                   3187: <code class="varname">PKGBASE</code>.</p>
                   3188: <p>Note that after changing these settings, you must rebuild and
                   3189: reinstall any affected packages.</p>
                   3190: </div>
1.148     asau     3191: <div class="sect1">
1.75      rillig   3192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3193: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.75      rillig   3194: <p>Please be aware that there can often be bugs in third-party software,
                   3195: and some of these bugs can leave a machine vulnerable to exploitation by
                   3196: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3197: maintains a database of known-exploits to packages which have at one time
                   3198: been included in pkgsrc.  The database can be downloaded automatically, and
                   3199: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3200: do this, refer to the following two tools (installed as part of the
1.189     snj      3201: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128     wiz      3202: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3203: <li class="listitem">
1.122     reed     3204: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3205:     download a list of the security vulnerabilities information.  This list
1.132     spz      3206:     is kept up to date by the pkgsrc security team, and is distributed
                   3207:     from the NetBSD ftp server:</p>
                   3208: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.75      rillig   3209: </li>
1.128     wiz      3210: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3211:     current machine, checking each known vulnerability.  If a
1.75      rillig   3212:     vulnerable package is installed, it will be shown by output to stdout,
                   3213:     including a description of the type of vulnerability, and a URL
                   3214:     containing more information.</p></li>
                   3215: </ol></div>
1.114     jmcneill 3216: <p>Use of these tools is strongly recommended!  After
1.128     wiz      3217: <span class="quote">&#8220;<span class="quote">pkg_install</span>&#8221;</span> is installed, please read
1.75      rillig   3218: the package's message, which you can get by running <strong class="userinput"><code>pkg_info -D
1.114     jmcneill 3219: pkg_install</code></strong>.</p>
1.87      wiz      3220: <p>If this package is installed, pkgsrc builds will use it to
1.110     hubertf  3221: perform a security check before building any package.  See <a class="xref" href="#variables-affecting-build" title="5.2. Variables affecting the build process">Section 5.2, &#8220;Variables affecting the build process&#8221;</a> for ways to control this
1.87      wiz      3222: check.</p>
1.75      rillig   3223: </div>
1.148     asau     3224: <div class="sect1">
1.75      rillig   3225: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3226: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3227: <p>When you add your own preferences to the
                   3228:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3229:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3230:        environment variables to the <code class="filename">./configure</code>
1.189     snj      3231:        scripts and to <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>. Some package authors ignore the
1.75      rillig   3232:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3233:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3234:        package.</p>
                   3235: <p>Currently there is no solution to this problem. If you
                   3236:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3237:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3238:        directory and then inspect any <code class="filename">Makefile</code> and
                   3239:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3240:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      3241:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   3242:        programmers write so bad code that it only works for the
                   3243:        specific combination of <code class="varname">CFLAGS</code> they have
                   3244:        chosen.</p>
                   3245: </div>
1.148     asau     3246: <div class="sect1">
1.80      rillig   3247: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3248: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3249: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3250: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3251:        case that occurs often is that people only update pkgsrc in
                   3252:        parts, because of performance reasons. Since pkgsrc is one large
                   3253:        system, not a collection of many small systems, there are
                   3254:        sometimes changes that only work when the whole pkgsrc tree is
                   3255:        updated.</p></li>
1.148     asau     3256: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      3257:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3258:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   3259:        files.</p></li>
1.148     asau     3260: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3261:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3262:        verify this.</p></li>
1.218     rillig   3263: <li class="step"><p>If you are a package developer who wants to invest
                   3264:        some work, have a look at <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.148     asau     3265: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3266:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3267: </ol></div>
                   3268: </div>
1.148     asau     3269: <div class="sect1">
1.88      wiz      3270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.194     bsiegert 3271: <a name="faq.rcs-conflicts"></a>9.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
1.89      rillig   3272: <p>You have modified a file from pkgsrc, and someone else has
                   3273: modified that same file afterwards in the CVS repository. Both changes
                   3274: are in the same region of the file, so when you updated pkgsrc, the
                   3275: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3276: file. Because of these markers, the file is no longer a valid
                   3277: <code class="filename">Makefile</code>.</p>
                   3278: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3279: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3280: -dP</strong></span> in that directory to download the current version.</p>
                   3281: </div>
1.75      rillig   3282: </div>
                   3283: </div>
1.148     asau     3284: <div class="part">
1.75      rillig   3285: <div class="titlepage"><div><div><h1 class="title">
                   3286: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3287: <div class="partintro">
1.77      rillig   3288: <div></div>
                   3289: <p>This part of the book deals with creating and
1.128     wiz      3290:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   3291:        guide on creating a new package. The remaining chapters are more
                   3292:        like a reference manual for pkgsrc.</p>
1.75      rillig   3293: <div class="toc">
                   3294: <p><b>Table of Contents</b></p>
1.210     leot     3295: <dl class="toc">
1.106     rillig   3296: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   3297: <dd><dl>
1.106     rillig   3298: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3299: <dd><dl>
1.106     rillig   3300: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174     asau     3301: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118     imil     3302: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3303: </dl></dd>
1.106     rillig   3304: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3305: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
                   3306: </dl></dd>
                   3307: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   3308: <dd><dl>
1.128     wiz      3309: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3310: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219   ! rillig   3311: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig   3312: <dd><dl>
                   3313: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3314: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3315: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3316: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3317: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3318: </dl></dd>
                   3319: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3320: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3321: <dd><dl>
                   3322: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3323: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3324: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   3325: </dl></dd>
1.128     wiz      3326: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3327: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3328: </dl></dd>
1.128     wiz      3329: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3330: <dd><dl>
                   3331: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      3332: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   3333: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   3334: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   3335: <dd><dl>
                   3336: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.219   ! rillig   3337: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.2. Passing variables to a shell command</a></span></dt>
        !          3338: <dt><span class="sect2"><a href="#quoting-guideline">12.3.3. Quoting guideline</a></span></dt>
1.106     rillig   3339: </dl></dd>
                   3340: </dl></dd>
                   3341: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   3342: <dd><dl>
                   3343: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      3344: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3345: <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>
1.106     rillig   3346: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   3347: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      3348: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig   3349: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      3350: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   3351: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.106     rillig   3352: </dl></dd>
                   3353: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   3354: <dd><dl>
                   3355: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      3356: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3357: <dd><dl>
                   3358: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      3359: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   3360:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3361:       and
                   3362:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3363:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3364: </dl></dd>
1.128     wiz      3365: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig   3366: <dd><dl>
1.128     wiz      3367: <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>
1.106     rillig   3368: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3369: </dl></dd>
                   3370: </dl></dd>
                   3371: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   3372: <dd><dl>
                   3373: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   3374: <dd><dl>
                   3375: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   3376: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   3377: </dl></dd>
                   3378: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   3379: <dd><dl>
1.128     wiz      3380: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig   3381: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   3382: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   3383: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   3384: </dl></dd>
                   3385: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   3386: <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>
                   3387: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   3388: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   3389: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3390: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   3391: <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>
                   3392: </dl></dd>
                   3393: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   3394: <dd><dl>
                   3395: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      3396: <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>
1.106     rillig   3397: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   3398: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3399: </dl></dd>
                   3400: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   3401: <dd><dl>
                   3402: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   3403: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   3404: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   3405: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      3406: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3407: <dd><dl>
                   3408: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   3409: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   3410: </dl></dd>
1.128     wiz      3411: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3412: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3413: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3414: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3415: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3416: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3417: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3418: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3419: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3420: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig   3421: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   3422: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   3423: </dl></dd>
                   3424: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   3425: <dd><dl>
                   3426: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   3427: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   3428: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   3429: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
                   3430: </dl></dd>
                   3431: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   3432: <dd><dl>
                   3433: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   3434: <dd><dl>
1.218     rillig   3435: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                   3436: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   3437: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   3438: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   3439: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   3440: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   3441: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   3442: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   3443: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   3444: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3445: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.106     rillig   3446: </dl></dd>
1.218     rillig   3447: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   3448: <dd><dl>
                   3449: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3450: <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>
1.199     tnn      3451: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   3452: </dl></dd>
1.218     rillig   3453: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig   3454: <dd><dl>
                   3455: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   3456: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3457: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   3458: </dl></dd>
                   3459: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   3460: <dd><dl>
                   3461: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   3462: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   3463: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      3464: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   3465: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   3466: </dl></dd>
1.218     rillig   3467: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig   3468: <dd><dl>
                   3469: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3470: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      3471: <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>
1.106     rillig   3472: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   3473: </dl></dd>
1.218     rillig   3474: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig   3475: <dd><dl>
                   3476: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   3477: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   3478: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   3479: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3480: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3481: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   3482: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   3483: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   3484: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   3485: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   3486: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   3487: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   3488: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   3489: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3490: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   3491: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   3492: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   3493: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      3494:     emulation</a></span></dt>
1.106     rillig   3495: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3496: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3497: </dl></dd>
1.106     rillig   3498: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3499: </dl></dd>
1.106     rillig   3500: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   3501: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.77      rillig   3502: <dd><dl>
1.106     rillig   3503: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   3504: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3505: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz      3506: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   3507: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     3508: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   3509: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.106     rillig   3510: </dl></dd>
                   3511: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   3512: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   3513: <dd><dl>
                   3514: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   3515: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   3516: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   3517: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     3518: </dl></dd>
1.75      rillig   3519: </dl>
                   3520: </div>
1.77      rillig   3521: </div>
1.148     asau     3522: <div class="chapter">
1.77      rillig   3523: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3524: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3525: <div class="toc">
                   3526: <p><b>Table of Contents</b></p>
1.210     leot     3527: <dl class="toc">
1.106     rillig   3528: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.91      rillig   3529: <dd><dl>
1.106     rillig   3530: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.174     asau     3531: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 applications</a></span></dt>
1.118     imil     3532: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.91      rillig   3533: </dl></dd>
1.106     rillig   3534: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3535: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91      rillig   3536: </dl>
                   3537: </div>
1.77      rillig   3538: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3539: most likely have a URL from where you can download the source
                   3540: code. Starting with this URL, creating a package involves only a
                   3541: few steps.</p>
1.128     wiz      3542: <div class="procedure"><ol class="procedure" type="1">
1.189     snj      3543: <li class="step"><p>First, install the packages <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.148     asau     3544: <li class="step"><p>Then, choose one of the top-level directories as the
1.91      rillig   3545: category in which you want to place your package. You can also create a
                   3546: directory of your own (maybe called <code class="filename">local</code>). In that
                   3547: category directory, create another directory for your package and change
                   3548: into it.</p></li>
1.148     asau     3549: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3550: you for a URL. Enter the URL of the distribution file (in most cases a
                   3551: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3552: of your package are created automatically. The distribution file is
                   3553: extracted automatically to fill in some details in the
                   3554: <code class="filename">Makefile</code> that would otherwise have to be done
                   3555: manually.</p></li>
1.148     asau     3556: <li class="step">
1.91      rillig   3557: <p>Examine the extracted files to determine the dependencies of
                   3558: your package. Ideally, this is mentioned in some
                   3559: <code class="filename">README</code> file, but things may differ. For each of
                   3560: these dependencies, look where it exists in pkgsrc, and if there is a
                   3561: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3562: line to your package <code class="filename">Makefile</code> which includes that
                   3563: file just before the last line. If the
1.132     spz      3564: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3565: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3566: <p>If you just need binaries from a package, add a
1.91      rillig   3567: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3568: version of the dependency and where it can be found in pkgsrc. This line
                   3569: should be placed in the third paragraph. If the dependency is only
                   3570: needed for building the package, but not when using it, use
                   3571: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3572: Your package may then look like this:</p>
1.77      rillig   3573: <pre class="programlisting">
1.100     rillig   3574: [...]
1.77      rillig   3575: 
1.174     asau     3576: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.100     rillig   3577: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3578: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3579: 
1.100     rillig   3580: [...]
1.77      rillig   3581: 
1.100     rillig   3582: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3583: .include "../../devel/glib2/buildlink3.mk"
                   3584: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3585: </pre>
                   3586: </li>
1.148     asau     3587: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128     wiz      3588: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
1.110     hubertf  3589: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3590: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3591: -e</strong></span>, which outputs additional
                   3592: explanations.</p></li>
1.148     asau     3593: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.110     hubertf  3594: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.91      rillig   3595: over there, you can hopefully continue here.</p></li>
1.148     asau     3596: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3597: directory from the extracted files. Besides these files, a lot of cache
                   3598: files and other system information has been saved in the working
                   3599: directory, which may become wrong after you edited the
                   3600: <code class="filename">Makefile</code>.</p></li>
1.148     asau     3601: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.110     hubertf  3602: the various things that can go wrong in this phase, consult <a class="xref" href="#fixes" title="Chapter 19. Making your package work">Chapter 19, <i>Making your package work</i></a>.</p></li>
1.148     asau     3603: <li class="step"><p>When the package builds fine, the next step is to install
1.110     hubertf  3604: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3605: everything works.</p></li>
1.148     asau     3606: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91      rillig   3607: contains a list of the files that are installed by the package, is
1.110     hubertf  3608: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3609: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3610: the file using your preferred text editor to see if the list of
                   3611: files looks plausible.</p></li>
1.148     asau     3612: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3613: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148     asau     3614: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3615: has been registered in the database of installed files, but with an
1.110     hubertf  3616: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3617: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3618: registered with the list of files from
                   3619: <code class="filename">PLIST</code>.</p></li>
1.148     asau     3620: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3621: package from the set of installed files.</p></li>
1.77      rillig   3622: </ol></div>
1.148     asau     3623: <div class="sect1">
1.91      rillig   3624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3625: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.148     asau     3626: <div class="sect2">
1.91      rillig   3627: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3628: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3629: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3630: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   3631: </div>
1.148     asau     3632: <div class="sect2">
1.91      rillig   3633: <div class="titlepage"><div><div><h3 class="title">
1.174     asau     3634: <a name="creating.kde-app"></a>10.1.2. KDE3 applications</h3></div></div></div>
                   3635: <p>KDE3 applications should always include
1.91      rillig   3636: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.174     asau     3637: settings that are typical of KDE3 packages.</p>
1.91      rillig   3638: </div>
1.148     asau     3639: <div class="sect2">
1.118     imil     3640: <div class="titlepage"><div><div><h3 class="title">
                   3641: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   3642: <p>Python modules and programs packages are easily created using a
                   3643: set of predefined variables.</p>
                   3644: <p>
1.171     wiz      3645: If some Python versions are not supported by the software, set the
                   3646: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3647: that are not supported, e.g.
1.118     imil     3648: </p>
                   3649: <pre class="programlisting">
1.203     sevan    3650: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.118     imil     3651: </pre>
                   3652: <p>
1.213     wiz      3653: If the packaged software is a Python module, include one of
                   3654: <code class="filename">../../lang/python/egg.mk</code>,
                   3655: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3656: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3657: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3658: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3659: if the packaged software is using setuptools, you only need
                   3660: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3661: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   3662: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   3663: so pkgsrc will use this framework.
                   3664: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3665: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3666: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3667: to the name of the script.</p>
                   3668: <p>Either way, the package directory should be called
1.128     wiz      3669: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3670: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.118     imil     3671: </p>
                   3672: <pre class="programlisting">
                   3673: DISTNAME=   foopymodule-1.2.10
                   3674: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3675: </pre>
1.171     wiz      3676: <p>If it is an application, include
                   3677: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3678: In order to correctly set the path to the Python interpreter, use the
1.118     imil     3679: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142     wiz      3680: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171     wiz      3681: For example:
1.118     imil     3682: </p>
                   3683: <pre class="programlisting">
1.142     wiz      3684: REPLACE_PYTHON=   *.py
1.118     imil     3685: </pre>
1.171     wiz      3686: <p>Some Python modules have separate distributions for Python-2.x
                   3687: and Python-3.x support. In pkgsrc this is handled by the
                   3688: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3689: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3690: packages that should be depended upon and include
                   3691: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3692: then the pkgsrc infrastructure will depend on the appropriate package
                   3693: version. For example:
                   3694: </p>
                   3695: <pre class="programlisting">
                   3696: PYTHON_VERSIONED_DEPENDENCIES=dateutil dns
                   3697: </pre>
                   3698: <p>
                   3699: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3700: of supported packages.</p>
1.118     imil     3701: </div>
1.91      rillig   3702: </div>
1.148     asau     3703: <div class="sect1">
1.91      rillig   3704: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3705: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.148     asau     3706: <div class="sect2">
1.91      rillig   3707: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   3708: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148     asau     3709: <div class="sect3">
1.91      rillig   3710: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3711: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   3712: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128     wiz      3713: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.91      rillig   3714: pkgsrc. As the description says it has to do with the web, the obvious
1.128     wiz      3715: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.91      rillig   3716: <pre class="programlisting">
1.100     rillig   3717: <code class="prompt">$</code> mkdir www/nvu
                   3718: <code class="prompt">$</code> cd www/nvu
1.91      rillig   3719: </pre>
                   3720: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  3721: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   3722: <pre class="programlisting">
1.100     rillig   3723: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   3724: </pre>
                   3725: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3726: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128     wiz      3727: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
1.91      rillig   3728: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3729: <code class="varname">COMMENT</code> fields. Then the package
                   3730: <code class="filename">Makefile</code> looked like that:</p>
                   3731: <pre class="programlisting">
1.100     rillig   3732: # $NetBSD$
                   3733: #
1.91      rillig   3734: 
1.100     rillig   3735: DISTNAME=       nvu-1.0-sources
                   3736: PKGNAME=        nvu-1.0
                   3737: CATEGORIES=     www
                   3738: MASTER_SITES=   http://cvs.nvu.com/download/
                   3739: EXTRACT_SUFX=   .tar.bz2
                   3740: 
                   3741: MAINTAINER=     rillig@NetBSD.org
                   3742: HOMEPAGE=       http://cvs.nvu.com/
                   3743: COMMENT=        Web Authoring System
1.91      rillig   3744: 
1.100     rillig   3745: # url2pkg-marker (please do not remove this line.)
                   3746: .include "../../mk/bsd.pkg.mk"
1.91      rillig   3747: </pre>
                   3748: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3749: source archive:</p>
                   3750: <pre class="programlisting">
1.100     rillig   3751: url2pkg&gt; Running "make makesum" ...
                   3752: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3753: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3754: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3755: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3756: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3757: url2pkg&gt; Running "make extract" ...
                   3758: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3759: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3760: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3761: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3762: ===&gt; Installing dependencies for nvu-1.0
                   3763: ===&gt; Overriding tools for nvu-1.0
                   3764: ===&gt; Extracting for nvu-1.0
                   3765: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   3766: 
1.100     rillig   3767: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   3768: 
1.100     rillig   3769: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   3770: </pre>
                   3771: </div>
1.148     asau     3772: <div class="sect3">
1.91      rillig   3773: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3774: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91      rillig   3775: <p>Now that the package has been extracted, let's see what's inside
                   3776: it. The package has a <code class="filename">README.txt</code>, but that only
                   3777: says something about mozilla, so it's probably useless for seeing what
                   3778: dependencies this package has. But since there is a GNU configure script
                   3779: in the package, let's hope that it will complain about everything it
                   3780: needs.</p>
                   3781: <pre class="programlisting">
1.100     rillig   3782: <code class="prompt">$</code> bmake
                   3783: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3784: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3785: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3786: ===&gt; Patching for nvu-1.0
                   3787: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3788: ===&gt; Configuring for nvu-1.0
                   3789: [...]
                   3790: configure: error: Perl 5.004 or higher is required.
                   3791: [...]
                   3792: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3793: [...]
1.91      rillig   3794: </pre>
                   3795: <p>That worked quite well. So I opened the package Makefile in my
                   3796: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128     wiz      3797: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.91      rillig   3798: package have changed now, and since a perl wrapper is automatically
1.128     wiz      3799: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.91      rillig   3800: from scratch.</p>
                   3801: <pre class="programlisting">
1.100     rillig   3802: <code class="prompt">$</code> bmake clean
                   3803: ===&gt; Cleaning for nvu-1.0
                   3804: <code class="prompt">$</code> bmake
                   3805: [...]
                   3806: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3807: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3808: [...]
1.91      rillig   3809: </pre>
1.128     wiz      3810: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.91      rillig   3811: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   3812: <pre class="programlisting">
1.100     rillig   3813: [...]
                   3814: checking for GTK - version &gt;= 1.2.0... no
                   3815: *** Could not run GTK test program, checking why...
                   3816: [...]
1.91      rillig   3817: </pre>
                   3818: <p>Now to the other dependencies. The first question is: Where is the
                   3819: GTK package hidden in pkgsrc?</p>
                   3820: <pre class="programlisting">
1.100     rillig   3821: <code class="prompt">$</code> echo ../../*/gtk*
                   3822: [many packages ...]
                   3823: <code class="prompt">$</code> echo ../../*/gtk
                   3824: ../../x11/gtk
                   3825: <code class="prompt">$</code> echo ../../*/gtk2
                   3826: ../../x11/gtk2
                   3827: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   3828: ../../x11/gtk2/buildlink3.mk
1.91      rillig   3829: </pre>
                   3830: <p>The first try was definitely too broad. The second one had exactly
                   3831: one result, which is very good. But there is one pitfall with GNOME
                   3832: packages. Before GNOME 2 had been released, there were already many
                   3833: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   3834: packages, the GNOME 2 packages were imported as separate packages, and
1.128     wiz      3835: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.91      rillig   3836: whether this was the case here, and indeed it was.</p>
                   3837: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   3838: file, adding the dependency is very easy. I just inserted an
                   3839: <code class="literal">.include</code> line before the last line of the package
                   3840: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   3841: <pre class="programlisting">
1.100     rillig   3842: [...]
                   3843: .include "../../x11/gtk2/buildlink3.mk"
                   3844: .include "../../mk/bsd.pkg.mk
1.91      rillig   3845: </pre>
1.110     hubertf  3846: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   3847: was:</p>
                   3848: <pre class="programlisting">
1.100     rillig   3849: [...]
                   3850: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3851: checking for GTK - version &gt;= 1.2.0... no
                   3852: *** Could not run GTK test program, checking why...
                   3853: *** The test program failed to compile or link. See the file config.log for the
                   3854: *** exact error that occured. This usually means GTK was incorrectly installed
                   3855: *** or that you have moved GTK since it was installed. In the latter case, you
                   3856: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3857: configure: error: Test for GTK failed.
                   3858: [...]
1.91      rillig   3859: </pre>
1.128     wiz      3860: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   3861: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.91      rillig   3862: told me that this package really wanted to have the GNOME 1 version of
                   3863: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  3864: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   3865: So I changed the <code class="literal">x11/gtk2</code> to
                   3866: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   3867: and tried again.</p>
                   3868: <pre class="programlisting">
1.100     rillig   3869: [...]
1.166     jnemeth  3870: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.100     rillig   3871: In file included from xpidl.c:42:
                   3872: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3873: In file included from xpidl.c:42:
                   3874: xpidl.h:132: error: parse error before "IDL_ns"
                   3875: [...]
1.91      rillig   3876: </pre>
                   3877: <p>The package still does not find all of its dependencies. Now the
                   3878: question is: Which package provides the
                   3879: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   3880: <pre class="programlisting">
1.100     rillig   3881: <code class="prompt">$</code> echo ../../*/*idl*
                   3882: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3883: <code class="prompt">$</code> echo ../../*/*IDL*
                   3884: ../../net/libIDL
1.91      rillig   3885: </pre>
                   3886: <p>Let's take the one from the second try. So I included the
                   3887: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   3888: again. But the error didn't change. After digging through some of the
                   3889: code, I concluded that the build process of the package was broken and
                   3890: couldn't have ever worked, but since the Mozilla source tree is quite
                   3891: large, I didn't want to fix it. So I added the following to the package
                   3892: <code class="filename">Makefile</code> and tried again:</p>
                   3893: <pre class="programlisting">
1.100     rillig   3894: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   3895: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
1.91      rillig   3896: </pre>
                   3897: <p>The latter line is needed because the package expects the library
                   3898: <code class="filename">libIDL.so</code>, but only
                   3899: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   3900: wrapper to rewrite that on the fly.</p>
                   3901: <p>The next problem was related to a recent change of the FreeType
1.189     snj      3902: interface. I looked up in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.91      rillig   3903: which patch files were relevant for this issue and copied them to the
                   3904: <code class="filename">patches</code> directory. Then I retried, fixed the
                   3905: patches so that they applied cleanly and retried again. This time,
                   3906: everything worked.</p>
                   3907: </div>
1.148     asau     3908: <div class="sect3">
1.91      rillig   3909: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   3910: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   3911: <pre class="programlisting">
1.100     rillig   3912: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   3913: [...]
                   3914: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   3915: <code class="prompt">$</code> bmake deinstall
                   3916: <code class="prompt">$</code> bmake install
1.91      rillig   3917: </pre>
                   3918: </div>
                   3919: </div>
                   3920: </div>
1.77      rillig   3921: </div>
1.148     asau     3922: <div class="chapter">
1.75      rillig   3923: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   3924: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   3925: <div class="toc">
                   3926: <p><b>Table of Contents</b></p>
1.210     leot     3927: <dl class="toc">
1.128     wiz      3928: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3929: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.219   ! rillig   3930: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig   3931: <dd><dl>
                   3932: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3933: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3934: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3935: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3936: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3937: </dl></dd>
                   3938: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3939: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3940: <dd><dl>
                   3941: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3942: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3943: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   3944: </dl></dd>
1.128     wiz      3945: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3946: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   3947: </dl>
                   3948: </div>
1.87      wiz      3949: <p>Whenever you're preparing a package, there are a number of
                   3950: files involved which are described in the following
                   3951: sections.</p>
1.148     asau     3952: <div class="sect1">
1.75      rillig   3953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   3954: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.93      rillig   3955: </h2></div></div></div>
1.75      rillig   3956: <p>Building, installation and creation of a binary package are all
1.87      wiz      3957:   controlled by the package's <code class="filename">Makefile</code>.
                   3958:   The <code class="filename">Makefile</code> describes various things about
                   3959:   a package, for example from where to get it, how to configure,
                   3960:   build, and install it.</p>
1.76      rillig   3961: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      3962:   sections that describe the package.</p>
1.75      rillig   3963: <p>In the first section there are the following variables, which
1.87      wiz      3964:   should appear exactly in the order given here.  The order and
                   3965:   grouping of the variables is mostly historical and has no further
                   3966:   meaning.</p>
1.148     asau     3967: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3968: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      3969:     distribution file to be downloaded from the package's
                   3970:     website.</p></li>
1.128     wiz      3971: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174     asau     3972:     package, as used by pkgsrc. You need to provide it if
1.87      wiz      3973:     <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174     asau     3974:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3975:     provided (no distribution file is required).  Usually it is the pkgsrc
1.87      wiz      3976:     directory name together with the version number. It must match the
                   3977:     regular expression
                   3978:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3979:     starts with a letter or digit, and contains only letters, digits,
                   3980:     dashes, underscores, dots and plus signs.</p></li>
1.128     wiz      3981: <li class="listitem">
1.75      rillig   3982: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      3983:     which the package fits in. You can choose any of the top-level
                   3984:     directories of pkgsrc for it.</p>
1.75      rillig   3985: <p>Currently the following values are available for
1.87      wiz      3986:     <code class="varname">CATEGORIES</code>. If more than
                   3987:     one is used, they need to be separated by spaces:</p>
1.75      rillig   3988: <pre class="programlisting">
1.100     rillig   3989: archivers     cross         geography     meta-pkgs     security
                   3990: audio         databases     graphics      misc          shells
                   3991: benchmarks    devel         ham           multimedia    sysutils
                   3992: biology       editors       inputmethod   net           textproc
                   3993: cad           emulators     lang          news          time
                   3994: chat          finance       mail          parallel      wm
                   3995: comms         fonts         math          pkgtools      www
                   3996: converters    games         mbone         print         x11
                   3997: </pre>
1.75      rillig   3998: </li>
1.128     wiz      3999: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      4000:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   4001:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   4002:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.128     wiz      4003:     <a class="xref" href="#build.fetch" title="17.5. The fetch phase">Section 17.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
1.75      rillig   4004: </ul></div>
                   4005: <p>The second section contains information about separately
1.87      wiz      4006:   downloaded patches, if any.
                   4007:   </p>
1.148     asau     4008: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190     wiz      4009: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87      wiz      4010:     Name(s) of additional files that contain distribution patches.
                   4011:     There is no default. pkgsrc will look for them at
                   4012:     <code class="varname">PATCH_SITES</code>.
                   4013:     They will automatically be uncompressed before patching if
                   4014:     the names end with <code class="filename">.gz</code> or
                   4015:     <code class="filename">.Z</code>.</p></li>
1.128     wiz      4016: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      4017:     Primary location(s) for distribution patch files (see
1.190     wiz      4018:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   4019: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
                   4020:     an argument 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> that sets the pathname strip count to
                   4021:     help find the correct files to patch. It defaults to
                   4022:     <span class="command"><strong>-p0</strong></span>.</p></li>
1.75      rillig   4023: </ul></div>
                   4024: <p>The third section contains the following variables.
1.87      wiz      4025:   </p>
1.148     asau     4026: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4027: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114     jmcneill 4028:     address of the person who feels responsible for this package,
                   4029:     and who is most likely to look at problems or questions regarding
1.189     snj      4030:     this package which have been reported 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>.
1.114     jmcneill 4031:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   4032:     before making changes to the package, but are not required to
                   4033:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   4034:     to yourself. If you really can't maintain the package for future
                   4035:     updates, set it to
1.110     hubertf  4036:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.128     wiz      4037: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114     jmcneill 4038:     of <code class="varname">MAINTAINER</code> when you do not want other
                   4039:     developers to update or change the package without contacting
                   4040:     you first. A package Makefile should contain one of
                   4041:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   4042:     not both.  </p></li>
1.128     wiz      4043: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      4044:     find more information about the package.</p></li>
1.128     wiz      4045: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      4046:     description of the package (should not include the package
                   4047:     name).</p></li>
1.75      rillig   4048: </ul></div>
                   4049: <p>Other variables that affect the build:
1.87      wiz      4050:   </p>
1.148     asau     4051: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75      rillig   4052: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      4053:       interesting distribution files of the package are found. The
                   4054:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   4055:       works for most packages.</p>
1.75      rillig   4056: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      4057:       (most GNU software does, for instance), but extracts itself in
                   4058:       the current directory, you should set
                   4059:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   4060: <p>If a package doesn't create a subdirectory with the
                   4061:       name of <code class="varname">DISTNAME</code> but some different name,
                   4062:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   4063:       <code class="filename">${WRKDIR}</code>, for example
                   4064:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.189     snj      4065:       <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.75      rillig   4066: <p>The name of the working directory created by pkgsrc is
1.87      wiz      4067:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   4068:       variable. By default, its value is
                   4069:       <code class="filename">work</code>. If you want to use the same
                   4070:       pkgsrc tree for building different kinds of binary packages,
                   4071:       you can change the variable according to your needs. Two
                   4072:       other variables handle common cases of setting
                   4073:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   4074:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  4075:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      4076:       the host's name is attached to the directory name. If
                   4077:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   4078:       is attached, which might look like
                   4079:       <code class="filename">work.i386</code> or
                   4080:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   4081: </li></ul></div>
                   4082: <p>Please pay attention to the following gotchas:</p>
1.148     asau     4083: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4084: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      4085:       installed in compressed form by the package.  For packages using
                   4086:       BSD-style makefiles which honor MANZ, there is
                   4087:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128     wiz      4088: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   4089:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.88      wiz      4090:       below).</p></li>
1.128     wiz      4091: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="19.6.7. Packages installing info files">Section 19.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
1.75      rillig   4092: </ul></div>
                   4093: </div>
1.148     asau     4094: <div class="sect1">
1.75      rillig   4095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4096: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.93      rillig   4097: </h2></div></div></div>
1.76      rillig   4098: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      4099:   digest, or checksum, of each distfile needed for the package. This
                   4100:   ensures that the distfiles retrieved from the Internet have not been
                   4101:   corrupted during transfer or altered by a malign force to introduce
1.219   ! rillig   4102:   a security hole. To provide maximum security, all distfiles are
        !          4103:   protected using three different message digest algorithms (SHA1,
        !          4104:   RMD160, SHA512), as well as the file size.</p>
1.76      rillig   4105: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      4106:   checksums for all the patches found in the
1.219   ! rillig   4107:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;<code class="filename">patches/*</code>&#8221;</a>).</p>
1.76      rillig   4108: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.219   ! rillig   4109:   <span class="command"><strong>make distinfo</strong></span> command.</p>
1.75      rillig   4110: <p>Some packages have different sets of distfiles depending on
1.189     snj      4111:   the platform, for example <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.87      wiz      4112:   <code class="filename">distinfo</code> file and care should be taken when
                   4113:   upgrading such a package to ensure distfile information is not
                   4114:   lost.</p>
1.75      rillig   4115: </div>
1.148     asau     4116: <div class="sect1">
1.75      rillig   4117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219   ! rillig   4118: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
        !          4119: </h2></div></div></div>
        !          4120: <p>Some packages don't work out-of-the box on the various
        !          4121:   platforms that are supported by pkgsrc. These packages need
        !          4122:   to be patched to make them work. The patch files can be
1.93      rillig   4123:   found in the <code class="filename">patches/</code> directory.</p>
                   4124: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   4125:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.219   ! rillig   4126:   extracting them, in alphabetic order.</p>
1.148     asau     4127: <div class="sect2">
1.93      rillig   4128: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4129: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   4130: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  4131:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   4132:   problems. (To force patches to apply with fuzz you can set
                   4133:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 4134:   should contain only changes for a single file, and no file should be
1.93      rillig   4135:   patched by more than one patch file. This helps to keep future
                   4136:   modifications simple.</p>
                   4137: <p>Each patch file is structured as follows: In the first line,
                   4138:   there is the RCS Id of the patch itself. The second line should be
                   4139:   empty for aesthetic reasons. After that, there should be a comment for
                   4140:   each change that the patch does. There are a number of standard
                   4141:   cases:</p>
1.148     asau     4142: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4143: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93      rillig   4144:   mention the vulnerability ID (CAN, CVE).</p></li>
1.128     wiz      4145: <li class="listitem"><p>Patches that change source code should mention the
1.93      rillig   4146:   platform and other environment (for example, the compiler) that the
                   4147:   patch is needed for.</p></li>
                   4148: </ul></div>
1.219   ! rillig   4149: <p>The patch should be commented so that any
1.93      rillig   4150:   developer who knows the code of the application can make some use of
                   4151:   the patch. Special care should be taken for the upstream developers,
                   4152:   since we generally want that they accept our patches, so we have less
                   4153:   work in the future.</p>
                   4154: </div>
1.148     asau     4155: <div class="sect2">
1.93      rillig   4156: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4157: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   4158: <p>One important thing to mention is to pay attention that no RCS
                   4159:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      4160:   later checked into the NetBSD CVS tree. Use the
1.189     snj      4161:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.93      rillig   4162:   problems.</p>
1.87      wiz      4163: <p>For even more automation, we recommend using
1.110     hubertf  4164:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      4165:   whole set of patches. You just have to backup files before you
                   4166:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  4167:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   4168:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      4169:   you upgrade a package this way, you can easily compare the new
                   4170:   set of patches with the previously existing one with
1.130     wiz      4171:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   4172:   are replaced by new files, so carefully check if you want to take all
                   4173:   the changes.</p>
1.87      wiz      4174: <p>When you have finished a package, remember to generate
1.110     hubertf  4175:   the checksums for the patch files by using the <span class="command"><strong>make
1.128     wiz      4176:   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>
1.87      wiz      4177: <p>When adding a patch that corrects a problem in the
                   4178:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   4179:   man pages should go), send the patch as a bug report to the
                   4180:   maintainer.  This benefits non-pkgsrc users of the package,
                   4181:   and usually makes it possible to remove the patch in future
                   4182:   version.</p>
1.101     rillig   4183: <p>The file names of the patch files are usually of the form
1.130     wiz      4184:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   4185:   Many packages still use the previous convention
                   4186:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   4187:   but new patches should be of the form containing the filename.
1.189     snj      4188:   <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
1.130     wiz      4189:   automatically.</p>
1.93      rillig   4190: </div>
1.148     asau     4191: <div class="sect2">
1.93      rillig   4192: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4193: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      4194: <p>If you want to share patches between multiple packages
                   4195:   in pkgsrc, e.g. because they use the same distfiles, set
                   4196:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   4197:   can be found, e.g.:</p>
                   4198: <pre class="programlisting">
1.100     rillig   4199: PATCHDIR= ${.CURDIR}/../xemacs/patches
1.93      rillig   4200: </pre>
1.75      rillig   4201: <p>Patch files that are distributed by the author or other
1.87      wiz      4202:     maintainers can be listed in
                   4203:     <code class="varname">PATCHFILES</code>.</p>
                   4204: <p>If it is desired to store any patches that should not be
                   4205:     committed into pkgsrc, they can be kept outside the pkgsrc
                   4206:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   4207:     directory tree there is expected to have the same
1.128     wiz      4208:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.87      wiz      4209:     patches are expected to be stored inside these dirs (also
                   4210:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   4211:     example, if you want to keep a private patch for
                   4212:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   4213:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   4214:     files in the named directory are expected to be patch files,
                   4215:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   4216:     applied</em></span>.</p>
1.93      rillig   4217: </div>
1.148     asau     4218: <div class="sect2">
1.85      jmmv     4219: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4220: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     4221: <p>When fixing a portability issue in the code do not use
                   4222:       preprocessor magic to check for the current operating system nor
                   4223:       platform.  Doing so hurts portability to other platforms because
                   4224:       the OS-specific details are not abstracted appropriately.</p>
                   4225: <p>The general rule to follow is: instead of checking for the
                   4226:       operating system the application is being built on, check for the
                   4227:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   4228:       instead of assuming that kqueue is available under NetBSD and
                   4229:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126     jakllsch 4230:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     4231:       yes, this generally involves patching the
1.110     hubertf  4232:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     4233:       that prevents some OSes from adopting interfaces from other OSes
                   4234:       (e.g. Linux implementing kqueue), something that the above checks
                   4235:       cannot take into account.</p>
                   4236: <p>Of course, checking for features generally involves more
                   4237:       work on the developer's side, but the resulting changes are
1.87      wiz      4238:       cleaner and there are chances they will work on many other
1.85      jmmv     4239:       platforms.  Not to mention that there are higher chances of being
                   4240:       later integrated into the mainstream sources.  Remember:
                   4241:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   4242: <p>Some typical examples:</p>
                   4243: <div class="table">
1.106     rillig   4244: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.216     tnn      4245: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85      jmmv     4246: <colgroup>
                   4247: <col>
                   4248: <col>
                   4249: <col>
                   4250: </colgroup>
                   4251: <thead><tr>
                   4252: <th>Where</th>
                   4253: <th>Incorrect</th>
                   4254: <th>Correct</th>
                   4255: </tr></thead>
                   4256: <tbody>
                   4257: <tr>
                   4258: <td>configure script</td>
                   4259: <td>
1.100     rillig   4260: <pre class="programlisting">
                   4261: case ${target_os} in
                   4262: netbsd*) have_kvm=yes ;;
                   4263: *)       have_kvm=no  ;;
                   4264: esac
                   4265: </pre>
1.85      jmmv     4266:              </td>
                   4267: <td>
1.100     rillig   4268: <pre class="programlisting">
                   4269: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   4270: </pre>
1.85      jmmv     4271:              </td>
                   4272: </tr>
                   4273: <tr>
                   4274: <td>C source file</td>
                   4275: <td>
1.100     rillig   4276: <pre class="programlisting">
                   4277: #if defined(__NetBSD__)
                   4278: #  include &lt;sys/event.h&gt;
                   4279: #endif
                   4280: </pre>
1.85      jmmv     4281:              </td>
                   4282: <td>
1.100     rillig   4283: <pre class="programlisting">
                   4284: #if defined(HAVE_SYS_EVENT_H)
                   4285: #  include &lt;sys/event.h&gt;
                   4286: #endif
                   4287: </pre>
1.85      jmmv     4288:              </td>
                   4289: </tr>
                   4290: <tr>
                   4291: <td>C source file</td>
                   4292: <td>
1.100     rillig   4293: <pre class="programlisting">
                   4294: int
                   4295: monitor_file(...)
                   4296: {
                   4297: #if defined(__NetBSD__)
                   4298:         int fd = kqueue();
                   4299:         ...
                   4300: #else
                   4301:         ...
                   4302: #endif
                   4303: }
                   4304: </pre>
1.85      jmmv     4305:              </td>
                   4306: <td>
1.100     rillig   4307: <pre class="programlisting">
                   4308: int
                   4309: monitor_file(...)
                   4310: {
                   4311: #if defined(HAVE_KQUEUE)
                   4312:         int fd = kqueue();
                   4313:         ...
                   4314: #else
                   4315:        ...
                   4316: #endif
                   4317: }
                   4318: </pre>
1.85      jmmv     4319:              </td>
                   4320: </tr>
                   4321: </tbody>
1.91      rillig   4322: </table></div>
1.85      jmmv     4323: </div>
1.91      rillig   4324: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.110     hubertf  4325:       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
                   4326:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.85      jmmv     4327:       2</a>).  It summarizes multiple details on how to make
                   4328:       software easier to package; all the suggestions in it were
                   4329:       collected from our experience in pkgsrc work, so they are possibly
                   4330:       helpful when creating patches too.</p>
                   4331: </div>
1.148     asau     4332: <div class="sect2">
1.85      jmmv     4333: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4334: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     4335: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   4336:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   4337:       improvements you do to a package to the mainstream developers.
                   4338:       This is the only way to get their attention on portability issues
                   4339:       and to ensure that future versions can be built out-of-the box on
                   4340:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   4341:       the fixes straight from the packaged code.</p>
1.93      rillig   4342: <p>This generally involves cleaning up the patches
                   4343:       (because sometimes the patches that are
1.147     wiz      4344:       added to pkgsrc are quick hacks), filing bug reports in the
1.85      jmmv     4345:       appropriate trackers for the projects and working with the
                   4346:       mainstream authors to accept your changes.  It is
                   4347:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   4348:       the packages in pkgsrc are kept simple and thus further changes
                   4349:       can be done without much hassle.</p>
1.130     wiz      4350: <p>When you have done this, please add a URL to the upstream
                   4351:       bug report to the patch comment.</p>
1.85      jmmv     4352: <p>Support the idea of free software!</p>
                   4353: </div>
1.75      rillig   4354: </div>
1.148     asau     4355: <div class="sect1">
1.75      rillig   4356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4357: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.148     asau     4358: <div class="variablelist"><dl class="variablelist">
1.76      rillig   4359: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   4360: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      4361:          any credits where they are due.  Please bear in mind that others do not
                   4362:          share your sense of humour (or spelling idiosyncrasies), and that others
                   4363:          will read everything that you write here.</p></dd>
1.76      rillig   4364: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4365: <dd><p>This file governs the files that are installed on your
                   4366:          system: all the binaries, manual pages, etc. There are other
                   4367:          directives which may be entered in this file, to control the
                   4368:          creation and deletion of directories, and the location of
1.110     hubertf  4369:          inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.87      wiz      4370:          information.</p></dd>
1.75      rillig   4371: </dl></div>
                   4372: </div>
1.148     asau     4373: <div class="sect1">
1.75      rillig   4374: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4375: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.148     asau     4376: <div class="sect2">
1.78      rillig   4377: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4378: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.148     asau     4379: <div class="variablelist"><dl class="variablelist">
1.76      rillig   4380: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135     wiz      4381: <dd>
1.189     snj      4382: <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>.
1.87      wiz      4383:            First time after package extraction and before files are
                   4384:            moved in place, the second time after the files to install
                   4385:            are moved in place. This can be used to do any custom
                   4386:            procedures not possible with @exec commands in
1.189     snj      4387:            <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
                   4388:            <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>.
1.135     wiz      4389:            Please note that you can modify variables in it easily by using
                   4390:            <code class="varname">FILES_SUBST</code> in the package's
                   4391:            <code class="filename">Makefile</code>:</p>
                   4392: <pre class="programlisting">
                   4393: FILES_SUBST+=  SOMEVAR="somevalue"
                   4394: </pre>
                   4395: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4396:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4397:            performed for <code class="varname">PREFIX</code>,
                   4398:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4399:            <code class="varname">VARBASE</code>, and a few others, type
                   4400:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4401:            complete list.</p>
                   4402: </dd>
1.76      rillig   4403: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4404: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4405:            this script's responsibility to clean up any additional messy details
                   4406:            around the package's installation, since all pkg_delete knows is how to
                   4407:            delete the files created in the original distribution.
1.189     snj      4408:            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>
                   4409:            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.
1.135     wiz      4410:            The same methods to replace variables can be used as for
                   4411:            the <code class="filename">INSTALL</code> file.</p></dd>
1.76      rillig   4412: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4413: <dd>
                   4414: <p>This file is displayed after installation of the package.
1.87      wiz      4415:            Useful for things like legal notices on almost-free
                   4416:            software and hints for updating config files after
                   4417:            installing modules for apache, PHP etc.
                   4418:            Please note that you can modify variables in it easily by using
                   4419:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4420:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4421: <pre class="programlisting">
1.100     rillig   4422: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4423: </pre>
1.128     wiz      4424: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.87      wiz      4425:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4426:            performed for <code class="varname">PKGNAME</code>,
                   4427:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209     sevan    4428:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87      wiz      4429:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4430:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  4431:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      4432: <p>You can display a different or additional files by
                   4433:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4434:            default is <code class="filename">MESSAGE</code>, if the file
                   4435:            exists.</p>
1.75      rillig   4436: </dd>
1.78      rillig   4437: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174     asau     4438: <dd>
                   4439: <p>This file is used by the alternatives framework.
                   4440:            It creates, configures, and destroys generic wrappers used to
                   4441:            run programs with similar interfaces.
                   4442:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   4443:             for more information.</p>
                   4444: <p>Each line of the file contains two filenames, first
                   4445:            the wrapper and then the alternative provided by the package.
                   4446:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   4447: </dd>
1.78      rillig   4448: </dl></div>
                   4449: </div>
1.148     asau     4450: <div class="sect2">
1.78      rillig   4451: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4452: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.148     asau     4453: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4454: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4455: <dd><p>This file contains arbitrary things that could
                   4456:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4457:        to be used by more than one package. This file should only be
                   4458:        used when the packages that will use the file are known in
                   4459:        advance. For other purposes it is often better to write a
                   4460:        <code class="filename">*.mk</code> file and give it a good name that
                   4461:        describes what it does.</p></dd>
                   4462: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4463: <dd><p>This file contains the dependency information
1.110     hubertf  4464:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.78      rillig   4465: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4466: <dd><p>This file contains workarounds for compiler bugs
                   4467:        and similar things. It is included automatically by the pkgsrc
                   4468:        infrastructure, so you don't need an extra
                   4469:        <code class="literal">.include</code> line for
                   4470:        it.</p></dd>
                   4471: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4472: <dd><p>This file contains the code for the
1.110     hubertf  4473:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.78      rillig   4474:        selected by the user. If a package has only one or two options,
                   4475:        it is equally acceptable to put the code directly into the
                   4476:        <code class="filename">Makefile</code>.</p></dd>
                   4477: </dl></div>
                   4478: </div>
1.148     asau     4479: <div class="sect2">
1.78      rillig   4480: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4481: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.148     asau     4482: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4483: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4484: <dd><p>These files do not take place in the creation of
                   4485:        a package and thus are purely informative to the package
                   4486:        developer.</p></dd>
                   4487: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4488: <dd><p>This file contains things that need to be done
                   4489:        to make the package even
                   4490:        better.</p></dd>
1.75      rillig   4491: </dl></div>
                   4492: </div>
1.78      rillig   4493: </div>
1.148     asau     4494: <div class="sect1">
1.75      rillig   4495: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4496: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.93      rillig   4497: </h2></div></div></div>
1.110     hubertf  4498: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4499:     unpacked into the directory denoted by
                   4500:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4501:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4502:     directory is also used to keep various timestamp files.
                   4503:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4504:     The default is <code class="filename">${.CURDIR}/work</code>
                   4505:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4506:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4507: </div>
1.148     asau     4508: <div class="sect1">
1.75      rillig   4509: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4510: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.93      rillig   4511: </h2></div></div></div>
1.75      rillig   4512: <p>If you have any files that you wish to be placed in the package prior
1.87      wiz      4513:     to configuration or building, you could place these files here and use
1.110     hubertf  4514:     a <span class="command"><strong>${CP}</strong></span> command in the
1.128     wiz      4515:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.87      wiz      4516:     this. Alternatively, you could simply diff the file against
                   4517:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4518:     the creation of this file.</p>
                   4519: <p>If you want to share files in this way with other
                   4520:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4521:     to the other package's <code class="filename">files</code> directory,
                   4522:     e.g.:</p>
                   4523: <pre class="programlisting">
1.100     rillig   4524: FILESDIR=${.CURDIR}/../xemacs/files
                   4525: </pre>
1.75      rillig   4526: </div>
                   4527: </div>
1.148     asau     4528: <div class="chapter">
1.75      rillig   4529: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4530: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4531: <div class="toc">
                   4532: <p><b>Table of Contents</b></p>
1.210     leot     4533: <dl class="toc">
1.106     rillig   4534: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.128     wiz      4535: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.106     rillig   4536: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4537: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4538: <dd><dl>
                   4539: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.219   ! rillig   4540: <dt><span class="sect2"><a href="#passing-variable-to-shell">12.3.2. Passing variables to a shell command</a></span></dt>
        !          4541: <dt><span class="sect2"><a href="#quoting-guideline">12.3.3. Quoting guideline</a></span></dt>
1.75      rillig   4542: </dl></dd>
                   4543: </dl>
                   4544: </div>
1.76      rillig   4545: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4546:   each of which forms a well-defined part of the pkgsrc system. Using
1.189     snj      4547:   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
1.75      rillig   4548:   like pkgsrc requires some discipline to keep the code correct and
                   4549:   understandable.</p>
1.76      rillig   4550: <p>The basic ingredients for <code class="filename">Makefile</code>
1.75      rillig   4551:   programming are variables (which are actually macros) and shell
                   4552:   commands. Among these shell commands may even be more complex ones
1.189     snj      4553:   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
1.75      rillig   4554:   as intended it is necessary to quote all variables correctly when they
                   4555:   are used.</p>
                   4556: <p>This chapter describes some patterns, that appear quite often in
1.76      rillig   4557:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4558:   with them.</p>
1.148     asau     4559: <div class="sect1">
1.75      rillig   4560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4561: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.148     asau     4562: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97      rillig   4563: <p>When you are creating a file as a
                   4564:     target of a rule, always write the data to a temporary file first
                   4565:     and finally rename that file. Otherwise there might occur an error
                   4566:     in the middle of generating the file, and when the user runs
1.189     snj      4567:     <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
1.97      rillig   4568:     regenerated properly. Example:</p>
                   4569: <pre class="programlisting">
1.100     rillig   4570: wrong:
                   4571:         @echo "line 1" &gt; ${.TARGET}
                   4572:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4573:         @false
                   4574: 
                   4575: correct:
                   4576:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4577:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4578:         @false
                   4579:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4580: </pre>
1.110     hubertf  4581: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4582:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4583:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4584:     correct</strong></span> gives an error message twice, as expected.</p>
1.189     snj      4585: <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
1.97      rillig   4586:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4587:     happens when it is interrupted, for example by pressing
                   4588:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.189     snj      4589:     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>
1.97      rillig   4590: </li></ul></div>
                   4591: </div>
1.148     asau     4592: <div class="sect1">
1.97      rillig   4593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4594: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4595: <p><code class="filename">Makefile</code> variables contain strings that
1.75      rillig   4596:     can be processed using the five operators ``='', ``+='', ``?='',
1.189     snj      4597:     ``:='', 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
1.75      rillig   4598:     page.</p>
                   4599: <p>When a variable's value is parsed from a
1.76      rillig   4600:     <code class="filename">Makefile</code>, the hash character ``#'' and the
1.75      rillig   4601:     backslash character ``\'' are handled specially. If a backslash is
                   4602:     followed by a newline, any whitespace immediately in front of the
                   4603:     backslash, the backslash, the newline, and any whitespace
                   4604:     immediately behind the newline are replaced with a single space. A
                   4605:     backslash character and an immediately following hash character are
                   4606:     replaced with a single hash character. Otherwise, the backslash is
                   4607:     passed as is. In a variable assignment, any hash character that is
                   4608:     not preceded by a backslash starts a comment that continues upto the
                   4609:     end of the logical line.</p>
1.219   ! rillig   4610: <p>The evaluation of variables either happens immediately or lazy.
        !          4611:     It happens immediately when the variable occurs
        !          4612:     on the right-hand side of the ``:='' or the ``!='' operator, in a
        !          4613:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
        !          4614:     In the other cases, it is evaluated lazily.</p>
1.75      rillig   4615: <p>Some of the modifiers split the string into words and then
                   4616:     operate on the words, others operate on the string as a whole. When
1.219   ! rillig   4617:     a string is split into words, it is split like in <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>
1.75      rillig   4618: <p>There are several types of variables that should be handled
                   4619:     differently. Strings and two types of lists.</p>
1.148     asau     4620: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4621: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.75      rillig   4622:       characters. Nevertheless, you should restrict yourself to only
                   4623:       using printable characters. Examples are
                   4624:       <code class="varname">PREFIX</code> and
                   4625:       <code class="varname">COMMENT</code>.</p></li>
1.128     wiz      4626: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.75      rillig   4627:       are never exported to any shell command. Their elements are
                   4628:       separated by whitespace. Therefore, the elements themselves cannot
                   4629:       have embedded whitespace. Any other characters are allowed.
1.110     hubertf  4630:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.75      rillig   4631:       Examples are <code class="varname">DEPENDS</code> and
                   4632:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.128     wiz      4633: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.75      rillig   4634:       may be exported to a shell command. Their elements can contain any
                   4635:       characters, including whitespace. That's why they cannot be used
1.110     hubertf  4636:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.75      rillig   4637:       <code class="varname">DISTFILES</code> and
                   4638:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4639: </ul></div>
1.148     asau     4640: <div class="sect2">
1.75      rillig   4641: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4642: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.148     asau     4643: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4644: <li class="listitem"><p>All variable names starting with an underscore
1.75      rillig   4645:        are reserved for use by the pkgsrc infrastructure. They shall
                   4646:        not be used by package
1.76      rillig   4647:        <code class="filename">Makefile</code>s.</p></li>
1.128     wiz      4648: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4649:        lowercase variable names for the iteration
                   4650:        variables.</p></li>
1.128     wiz      4651: <li class="listitem"><p>All list variables should have a ``plural''
1.75      rillig   4652:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4653:        <code class="varname">DISTFILES</code>.</p></li>
                   4654: </ul></div>
                   4655: </div>
                   4656: </div>
1.148     asau     4657: <div class="sect1">
1.75      rillig   4658: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4659: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.75      rillig   4660: <p>This section presents you with some code snippets you should
                   4661:     use in your own code. If you don't find anything appropriate here,
                   4662:     you should test your code and add it here.</p>
1.148     asau     4663: <div class="sect2">
1.75      rillig   4664: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   4665: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.75      rillig   4666: <pre class="programlisting">
1.100     rillig   4667: STRING=                 foo * bar `date`
                   4668: INT_LIST=               # empty
                   4669: ANOTHER_INT_LIST=       apache-[0-9]*:../../www/apache
                   4670: EXT_LIST=               # empty
                   4671: ANOTHER_EXT_LIST=       a=b c=d
                   4672: 
                   4673: INT_LIST+=              ${STRING}               # 1
                   4674: INT_LIST+=              ${ANOTHER_INT_LIST}     # 2
                   4675: EXT_LIST+=              ${STRING:Q}             # 3
                   4676: EXT_LIST+=              ${ANOTHER_EXT_LIST}     # 4
1.1       grant    4677: </pre>
1.75      rillig   4678: <p>When you add a string to an external list (example 3), it
                   4679:       must be quoted. In all other cases, you must not add a quoting
                   4680:       level. You must not merge internal and external lists, unless you
                   4681:       are sure that all entries are correctly interpreted in both
                   4682:       lists.</p>
                   4683: </div>
1.148     asau     4684: <div class="sect2">
1.75      rillig   4685: <div class="titlepage"><div><div><h3 class="title">
1.219   ! rillig   4686: <a name="passing-variable-to-shell"></a>12.3.2. Passing variables to a shell command</h3></div></div></div>
1.79      rillig   4687: <p>Sometimes you may want to print an arbitrary string. There
                   4688:        are many ways to get it wrong and only few that can handle every
                   4689:        nastiness.</p>
1.75      rillig   4690: <pre class="programlisting">
1.100     rillig   4691: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
1.219   ! rillig   4692: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       grant    4693: 
1.100     rillig   4694: all:
                   4695:         echo ${STRING}                  # 1
1.219   ! rillig   4696:         echo ${STRING:Q}                # 2
        !          4697:         printf '%s\n' ${STRING:Q}''     # 3
        !          4698:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"' # 4
1.1       grant    4699: </pre>
1.75      rillig   4700: <p>Example 1 leads to a syntax error in the shell, as the
                   4701:       characters are just copied.</p>
1.219   ! rillig   4702: <p>Example 2 can handle all strings, except those starting
        !          4703:       with a dash or those containing backslashes.</p>
        !          4704: <p>Example 3 can handle arbitrary strings.</p>
        !          4705: <p>In example 4, the <code class="varname">EXT_LIST</code> does not
        !          4706:       need to be quoted because the quoting has already been done
        !          4707:       when adding elements to the list.</p>
1.75      rillig   4708: </div>
1.148     asau     4709: <div class="sect2">
1.75      rillig   4710: <div class="titlepage"><div><div><h3 class="title">
1.219   ! rillig   4711: <a name="quoting-guideline"></a>12.3.3. Quoting guideline</h3></div></div></div>
1.75      rillig   4712: <p>There are many possible sources of wrongly quoted variables.
                   4713:       This section lists some of the commonly known ones.</p>
1.148     asau     4714: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4715: <li class="listitem">
1.75      rillig   4716: <p>Whenever you use the value of a list, think
                   4717:        about what happens to leading or trailing whitespace. If the
                   4718:        list is a well-formed shell expression, you can apply the
                   4719:        <code class="varname">:M*</code> modifier to strip leading and trailing
                   4720:        whitespace from each word. The <code class="varname">:M</code> operator
                   4721:        first splits its argument according to the rules of the shell,
                   4722:        and then creates a new list consisting of all words that match
                   4723:        the shell glob expression <code class="varname">*</code>, that is: all.
                   4724:        One class of situations where this is needed is when adding a
                   4725:        variable like <code class="varname">CPPFLAGS</code> to
                   4726:        <code class="varname">CONFIGURE_ARGS</code>. If the configure script
                   4727:        invokes other configure scripts, it strips the leading and
                   4728:        trailing whitespace from the variable and then passes it to the
                   4729:        other configure scripts. But these configure scripts expect the
                   4730:        (child) <code class="varname">CPPFLAGS</code> variable to be the same as
                   4731:        the parent <code class="varname">CPPFLAGS</code>. That's why we better
                   4732:        pass the <code class="varname">CPPFLAGS</code> value properly trimmed. And
                   4733:        here is how we do it:</p>
                   4734: <pre class="programlisting">
1.100     rillig   4735: CPPFLAGS=               # empty
                   4736: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX:Q}\"
                   4737: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4738: 
                   4739: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4740: 
                   4741: all:
                   4742:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   4743:         echo x${CONFIGURE_ARGS}x        # properly trimmed
1.1       grant    4744: </pre>
1.75      rillig   4745: </li>
1.128     wiz      4746: <li class="listitem"><p>The example above contains one bug: The
1.75      rillig   4747:        <code class="varname">${PREFIX}</code> is a properly quoted shell
                   4748:        expression, but there is the C compiler after it, which also
                   4749:        expects a properly quoted string (this time in C syntax). The
                   4750:        version above is therefore only correct if
                   4751:        <code class="varname">${PREFIX}</code> does not have embedded backslashes
                   4752:        or double quotes. If you want to allow these, you have to add
                   4753:        another layer of quoting to each variable that is used as a C
                   4754:        string literal. You cannot use the <code class="varname">:Q</code>
                   4755:        operator for it, as this operator only works for the
                   4756:        shell.</p></li>
1.128     wiz      4757: <li class="listitem">
1.75      rillig   4758: <p>Whenever a variable can be empty, the
                   4759:        <code class="varname">:Q</code> operator can have surprising results. Here
                   4760:        are two completely different cases which can be solved with the
                   4761:        same trick.</p>
                   4762: <pre class="programlisting">
1.100     rillig   4763: EMPTY=                  # empty
                   4764: empty_test:
                   4765:         for i in a ${EMPTY:Q} c; do \
                   4766:             echo "$$i"; \
                   4767:         done
                   4768: 
                   4769: for_test:
                   4770: .for i in a:\ a:\test.txt
                   4771:         echo ${i:Q}
                   4772:         echo "foo"
                   4773: .endfor
1.1       grant    4774: </pre>
1.75      rillig   4775: <p>The first example will only print two of the three lines
                   4776:        we might have expected. This is because
                   4777:        <code class="varname">${EMPTY:Q}</code> expands to the empty string, which
                   4778:        the shell cannot see. The workaround is to write
                   4779:        <code class="varname">${EMPTY:Q}""</code>. This pattern can be often found
                   4780:        as <code class="varname">${TEST} -z ${VAR:Q}</code> or as <code class="varname">${TEST}
                   4781:        -f ${FNAME:Q}</code> (both of these are wrong).</p>
                   4782: <p>The second example will only print three lines instead of
                   4783:        four. The first line looks like <code class="varname">a:\ echo foo</code>.
                   4784:        This is because the backslash of the value
                   4785:        <code class="varname">a:\</code> is interpreted as a line-continuation by
1.189     snj      4786:        <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
                   4787:        <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
1.75      rillig   4788:        <code class="varname">${i:Q}""</code>.</p>
                   4789: </li>
                   4790: </ul></div>
                   4791: </div>
                   4792: </div>
                   4793: </div>
1.148     asau     4794: <div class="chapter">
1.75      rillig   4795: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   4796: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.75      rillig   4797: <div class="toc">
                   4798: <p><b>Table of Contents</b></p>
1.210     leot     4799: <dl class="toc">
1.106     rillig   4800: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.128     wiz      4801: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4802: <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>
1.106     rillig   4803: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   4804: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.128     wiz      4805: <dt><span class="sect1"><a href="#using-PLIST_SRC">13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
1.106     rillig   4806: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.197     wiz      4807: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   4808: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.75      rillig   4809: </dl>
                   4810: </div>
1.87      wiz      4811: <p>The <code class="filename">PLIST</code> file contains a package's
1.128     wiz      4812:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.87      wiz      4813:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4814:   directory it's been installed in) plus some additional statements
1.189     snj      4815:   - 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.
1.87      wiz      4816:   This chapter addresses some issues that need attention when
                   4817:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4818:   below!).</p>
1.148     asau     4819: <div class="sect1">
1.75      rillig   4820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4821: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.87      wiz      4822: <p>Be sure to add a RCS ID line as the first thing in any
                   4823:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   4824: <pre class="programlisting">
1.100     rillig   4825: @comment $NetBSD$
1.87      wiz      4826:     </pre>
1.75      rillig   4827: </div>
1.148     asau     4828: <div class="sect1">
1.75      rillig   4829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4830: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  4831: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      4832:     to output a PLIST that matches any new files since the package
1.110     hubertf  4833:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a> for
1.87      wiz      4834:     more information on this target.</p>
1.75      rillig   4835: </div>
1.148     asau     4836: <div class="sect1">
1.75      rillig   4837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.110     hubertf  4838: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   4839: </h2></div></div></div>
1.87      wiz      4840: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4841:     of AWK patterns and actions that are used to filter the output of
                   4842:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4843:     scripting you like to it, but be careful with quoting.</p>
                   4844: <p>For example, to get all files inside the
                   4845:     <code class="filename">libdata/foo</code> directory removed from the
                   4846:     resulting PLIST:</p>
                   4847: <pre class="programlisting">
1.100     rillig   4848: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.87      wiz      4849:     </pre>
1.75      rillig   4850: </div>
1.148     asau     4851: <div class="sect1">
1.75      rillig   4852: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4853: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      4854: <p>A number of variables are substituted automatically in
                   4855:     PLISTs when a package is installed on a system. This includes the
                   4856:     following variables:</p>
1.148     asau     4857: <div class="variablelist"><dl class="variablelist">
1.75      rillig   4858: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4859: <dd>
                   4860: <p>Some packages like emacs and perl embed information
1.87      wiz      4861:          about which architecture they were built on into the
                   4862:          pathnames where they install their files. To handle this
                   4863:          case, PLIST will be preprocessed before actually used, and
                   4864:          the symbol
1.128     wiz      4865:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.110     hubertf  4866:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      4867:          same is done if the string
                   4868:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4869:          PLIST somewhere - use this on packages that have GNU
                   4870:          autoconf-created configure scripts.</p>
1.148     asau     4871: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   4872: <h3 class="title">Legacy note</h3>
                   4873: <p>There used to be a symbol
1.128     wiz      4874:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.110     hubertf  4875:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      4876:            -m</strong></span>, but that's no longer supported and has
                   4877:            been removed.</p>
1.75      rillig   4878: </div>
                   4879: </dd>
                   4880: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4881: <dd>
                   4882: <p>Some packages want to embed the OS name and version
1.87      wiz      4883:          into some paths.  To do this, use these variables in the
                   4884:          <code class="filename">PLIST</code>:
                   4885:          </p>
1.148     asau     4886: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4887: <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>
                   4888: <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>
                   4889: <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>
1.75      rillig   4890: </ul></div>
                   4891: </dd>
                   4892: </dl></div>
1.199     tnn      4893: <p>For a list of values which are replaced by
                   4894:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4895: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4896: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87      wiz      4897: <p>If you want to change other variables not listed above, you
                   4898:     can add variables and their expansions to this variable in the
1.110     hubertf  4899:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, &#8220;Optional files&#8221;</a>):</p>
1.75      rillig   4900: <pre class="programlisting">
1.100     rillig   4901: PLIST_SUBST+=   SOMEVAR="somevalue"
1.87      wiz      4902:     </pre>
1.128     wiz      4903: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.87      wiz      4904:     in the <code class="filename">PLIST</code> with
1.128     wiz      4905:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.120     snj      4906: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   4907:     the common case of conditionally including some
                   4908:     <code class="filename">PLIST</code> entries. It can be done by adding
                   4909:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      4910:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   4911:     to <code class="literal">yes</code> if the entry should be included.
1.128     wiz      4912:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.119     mishka   4913:     in the <code class="filename">PLIST</code> with either
1.128     wiz      4914:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   4915:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.119     mishka   4916:     For example, in <code class="filename">Makefile</code>:</p>
                   4917: <pre class="programlisting">
                   4918: PLIST_VARS+=   foo
                   4919: .if <em class="replaceable"><code>condition</code></em>
                   4920: PLIST.foo=     yes
                   4921: .else
                   4922:     </pre>
                   4923: <p>And then in <code class="filename">PLIST</code>:</p>
                   4924: <pre class="programlisting">
                   4925: @comment $NetBSD$
                   4926: bin/bar
                   4927: man/man1/bar.1
                   4928: ${PLIST.foo}bin/foo
                   4929: ${PLIST.foo}man/man1/foo.1
                   4930: ${PLIST.foo}share/bar/foo.data
                   4931:     </pre>
1.75      rillig   4932: </div>
1.148     asau     4933: <div class="sect1">
1.75      rillig   4934: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4935: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.75      rillig   4936: <p>Man pages should be installed in compressed form if
1.87      wiz      4937:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   4938:     and uncompressed otherwise. To handle this in the
1.128     wiz      4939:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.87      wiz      4940:     appended/removed automatically for man pages according to
                   4941:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   4942:     or not, see above for details. This modification of the
                   4943:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   4944:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   4945: </div>
1.148     asau     4946: <div class="sect1">
1.75      rillig   4947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4948: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   4949: </h2></div></div></div>
1.76      rillig   4950: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      4951:     in generating the binary package, set the variable
                   4952:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.189     snj      4953:     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
1.87      wiz      4954:     important. The default for <code class="varname">PLIST_SRC</code> is
                   4955:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   4956: </div>
1.148     asau     4957: <div class="sect1">
1.75      rillig   4958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   4959: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   4960: <p>Some packages decide to install a different set of files based on
1.87      wiz      4961:     the operating system being used. These differences can be
                   4962:     automatically handled by using the following files:</p>
1.148     asau     4963: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4964: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   4965: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   4966: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   4967: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   4968: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   4969: </ul></div>
                   4970: </div>
1.148     asau     4971: <div class="sect1">
1.75      rillig   4972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.197     wiz      4973: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
                   4974: <p>Some packages decide to generate hard-to-guess file names
                   4975:     during installation that are hard to wire down.</p>
                   4976: <p>In such cases, you can set the
                   4977:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   4978:     terminated (with a semicolon) that will output PLIST entries which
                   4979:     will be appended to the PLIST</p>
                   4980: <p>You can find one example in editors/xemacs:</p>
                   4981: <pre class="programlisting">
                   4982:       GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   4983:     </pre>
                   4984: <p>which will append something like
                   4985:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   4986:     <code class="filename">PLIST</code>.
                   4987:     </p>
                   4988: </div>
                   4989: <div class="sect1">
                   4990: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4991: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.128     wiz      4992: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.87      wiz      4993:     multiple (and unrelated) packages install files.  These
1.125     wiz      4994:     directories were problematic because you had to add special
                   4995:     tricks in the PLIST to conditionally remove them, or have some
1.87      wiz      4996:     centralized package handle them.</p>
1.125     wiz      4997: <p>In pkgsrc, it is now easy: Each package should create
                   4998:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   4999:     will remove any directories left empty after uninstalling a
                   5000:     package.</p>
                   5001: <p>If a package needs an empty directory to work, create
                   5002:     the directory during installation as usual, and also add an
                   5003:     entry to the PLIST:
                   5004:     </p>
1.87      wiz      5005: <pre class="programlisting">
1.125     wiz      5006: @pkgdir path/to/empty/directory
1.87      wiz      5007:     </pre>
1.125     wiz      5008: <p>
1.197     wiz      5009:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   5010:     <code class="varname">OWN_DIRS</code>.
1.125     wiz      5011:     </p>
1.75      rillig   5012: </div>
                   5013: </div>
1.148     asau     5014: <div class="chapter">
1.75      rillig   5015: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5016: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.75      rillig   5017: <div class="toc">
                   5018: <p><b>Table of Contents</b></p>
1.210     leot     5019: <dl class="toc">
1.106     rillig   5020: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.128     wiz      5021: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5022: <dd><dl>
1.106     rillig   5023: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.133     wiz      5024: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   5025:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5026:       and
                   5027:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5028:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   5029: </dl></dd>
1.128     wiz      5030: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75      rillig   5031: <dd><dl>
1.128     wiz      5032: <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>
1.106     rillig   5033: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   5034: </dl></dd>
                   5035: </dl>
                   5036: </div>
                   5037: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      5038:   are seen by a package's configure and build processes.  This is implemented
                   5039:   in a two step process:</p>
1.128     wiz      5040: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5041: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87      wiz      5042:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   5043:       of <code class="varname">WRKDIR</code>.</p></li>
1.128     wiz      5044: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      5045:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   5046:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   5047:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   5048:       native compiler on some operating systems look like GCC, so that
                   5049:       packages that expect GCC won't require modifications to build with
                   5050:       those native compilers.</p></li>
1.75      rillig   5051: </ol></div>
                   5052: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      5053:   package may be built consistently despite what other software may be
                   5054:   installed. Please note that the normal system header and library paths,
                   5055:   e.g. <code class="filename">/usr/include</code>,
                   5056:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   5057:   designed to insulate the package build from non-system-supplied
                   5058:   software.</p>
1.148     asau     5059: <div class="sect1">
1.75      rillig   5060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5061: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   5062: <p>The process of converting packages to use the buildlink3
1.128     wiz      5063:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.87      wiz      5064:     The things to keep in mind are:</p>
1.128     wiz      5065: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5066: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87      wiz      5067:        instead of the actual toolchain.  Some packages are tricky,
                   5068:        and the only way to know for sure is the check
                   5069:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   5070:        wrappers are being invoked.</p></li>
1.128     wiz      5071: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87      wiz      5072:        the package Makefile, e.g. Java VMs, standalone shells,
                   5073:        etc., because the code to symlink files into
                   5074:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128     wiz      5075:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
1.87      wiz      5076:        </p></li>
1.128     wiz      5077: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87      wiz      5078:        <code class="filename">buildlink3.mk</code> files that you list in a
                   5079:        package's Makefile are added as dependencies for that package.
                   5080:        </p></li>
1.75      rillig   5081: </ol></div>
1.87      wiz      5082: <p>If a dependency on a particular package is required for its libraries and
                   5083:     headers, then we replace:</p>
1.75      rillig   5084: <pre class="programlisting">
1.100     rillig   5085: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   5086: </pre>
1.75      rillig   5087: <p>with</p>
                   5088: <pre class="programlisting">
1.100     rillig   5089: .include "../../category/foo/buildlink3.mk"
                   5090: </pre>
1.75      rillig   5091: <p>The buildlink3.mk files usually define the required dependencies.
                   5092:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      5093:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   5094: <pre class="programlisting">
1.100     rillig   5095: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   5096: .include "../../category/foo/buildlink3.mk"
                   5097: </pre>
1.76      rillig   5098: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      5099:     files in <code class="filename">pkgsrc/mk</code>
                   5100:     that handle special package issues:</p>
1.148     asau     5101: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5102: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      5103:        the native or a pkgsrc Berkeley DB implementation based on
                   5104:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   5105:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128     wiz      5106: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      5107:        comes with neither Curses nor NCurses, this will take care
1.189     snj      5108:        to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.128     wiz      5109: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      5110:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   5111:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   5112:        require a Kerberos 5 implementation.</p></li>
1.128     wiz      5113: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88      wiz      5114:        system-provided Motif installation or adds a dependency on
1.189     snj      5115:        <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
1.128     wiz      5116:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.151     obache   5117:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span> or
                   5118:        <span class="quote">&#8220;<span class="quote">openmotif</span>&#8221;</span> to choose
1.88      wiz      5119:        which Motif version will be used.</p></li>
1.161     ryoon    5120: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162     wiz      5121:        system-provided GNU readline or editline (libedit) installation,
1.189     snj      5122:        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>,
                   5123:        <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
1.161     ryoon    5124:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   5125:        If your package really needs GNU readline library, its Makefile
                   5126:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   5127:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128     wiz      5128: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      5129:        variables that may be used by packages that use the
                   5130:        Open Sound System (OSS) API.</p></li>
1.128     wiz      5131: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142     wiz      5132:        any of the Postgres versions in the variable
                   5133:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   5134:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87      wiz      5135:        the file for more information.</p></li>
1.128     wiz      5136: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      5137:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.189     snj      5138:        a dependency on <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.128     wiz      5139: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      5140:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   5141:        library.</p></li>
1.75      rillig   5142: </ul></div>
1.76      rillig   5143: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      5144:     files provide a more complete
                   5145:     description of how to use them properly.</p>
1.75      rillig   5146: </div>
1.148     asau     5147: <div class="sect1">
1.75      rillig   5148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5149: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   5150: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      5151:     included by Makefiles to indicate the need to compile and link
                   5152:     against header files and libraries provided by the package.  A
                   5153:     <code class="filename">buildlink3.mk</code> file should always provide
                   5154:     enough information to add the correct type of dependency
                   5155:     relationship and include any other
                   5156:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   5157:     headers and libraries that it needs in turn.</p>
                   5158: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.189     snj      5159:     file for further editing, Rene Hexel's <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.87      wiz      5160:     package is highly recommended.  For most packages, the following
                   5161:     command will generate a good starting point for
                   5162:     <code class="filename">buildlink3.mk</code> files:</p>
                   5163: <pre class="screen">
                   5164: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   5165: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   5166:     </pre>
1.148     asau     5167: <div class="sect2">
1.75      rillig   5168: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5169: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   5170: <p>The following real-life example
1.87      wiz      5171:       <code class="filename">buildlink3.mk</code> is taken
                   5172:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   5173: <pre class="programlisting">
1.120     snj      5174: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    5175: 
1.120     snj      5176: BUILDLINK_TREE+=       tiff
1.1       grant    5177: 
1.120     snj      5178: .if !defined(TIFF_BUILDLINK3_MK)
                   5179: TIFF_BUILDLINK3_MK:=
1.87      wiz      5180: 
1.120     snj      5181: BUILDLINK_API_DEPENDS.tiff+=   tiff&gt;=3.6.1
                   5182: BUILDLINK_ABI_DEPENDS.tiff+=   tiff&gt;=3.7.2nb1
                   5183: BUILDLINK_PKGSRCDIR.tiff?=     ../../graphics/tiff
1.87      wiz      5184: 
1.100     rillig   5185: .include "../../devel/zlib/buildlink3.mk"
                   5186: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      5187: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      5188: 
1.120     snj      5189: BUILDLINK_TREE+=       -tiff
1.100     rillig   5190: </pre>
1.87      wiz      5191: <p>The header and footer manipulate
1.120     snj      5192:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      5193:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      5194:       the dependency tree.</p>
                   5195: <p>The main section is protected from multiple inclusion
1.87      wiz      5196:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   5197:       added.  Several important variables are set in the section:</p>
1.148     asau     5198: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5199: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5200:          is the actual dependency recorded in the installed
                   5201:          package; this should always be set using
1.110     hubertf  5202:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      5203:          we're appending to any pre-existing list of values.  This
                   5204:          variable should be set to the first version of the
1.133     wiz      5205:          package that had an backwards-incompatible API change.
1.87      wiz      5206:          </p></li>
1.128     wiz      5207: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5208:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   5209:          pkgsrc directory.</p></li>
1.128     wiz      5210: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5211:          (not shown above) controls whether we use
                   5212:          <code class="varname">BUILD_DEPENDS</code> or
                   5213:          <code class="varname">DEPENDS</code> to add the dependency on
                   5214:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   5215:          selected by setting
                   5216:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5217:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.87      wiz      5218:          used.</p></li>
1.128     wiz      5219: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5220:            and
                   5221:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   5222:            (not shown above) are lists of subdirectories of
1.76      rillig   5223:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5224:            to add to the header and library search paths.  These
1.128     wiz      5225:            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>
1.87      wiz      5226:          respectively.</p></li>
1.128     wiz      5227: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5228:            (not shown above) is the list of preprocessor flags to add
                   5229:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128     wiz      5230:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.75      rillig   5231:            should be avoided and instead be handled using
                   5232:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      5233:          above.</p></li>
1.75      rillig   5234: </ul></div>
1.87      wiz      5235: <p>The following variables are all optionally defined within
                   5236:       this second section (protected against multiple inclusion) and
                   5237:       control which package files are symlinked into
                   5238:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   5239:       transformed during the symlinking:</p>
1.148     asau     5240: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5241: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5242:            (not shown above) is a shell glob pattern relative to
1.76      rillig   5243:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   5244:            to be symlinked into
1.76      rillig   5245:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      5246:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.128     wiz      5247: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      5248:            (not shown above) is a shell pipeline that
                   5249:            outputs to stdout a list of files relative to
                   5250:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   5251:            The resulting files are to be symlinked
                   5252:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   5253:            this takes the <code class="filename">+CONTENTS</code> of a
                   5254:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   5255:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128     wiz      5256: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5257:            (not shown above) is a filter command that filters
1.76      rillig   5258:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   5259:            relative to
1.76      rillig   5260:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194     bsiegert 5261:            on stdout.  By default,
1.75      rillig   5262:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   5263:            outputs the contents of the <code class="filename">include</code>
                   5264:            and <code class="filename">lib</code> directories in the package
1.194     bsiegert 5265:            <code class="filename">+CONTENTS</code>.</p></li>
1.128     wiz      5266: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   5267:            (not shown above) is a list of sed arguments used to
                   5268:            transform the name of the source filename into a
1.110     hubertf  5269:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      5270:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   5271: </ul></div>
1.120     snj      5272: <p>This section can additionally include any
1.87      wiz      5273:       <code class="filename">buildlink3.mk</code> needed for
                   5274:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   5275:       Including these <code class="filename">buildlink3.mk</code> files
                   5276:       means that the headers and libraries for these
                   5277:       dependencies are also symlinked into
                   5278:       <code class="filename">${BUILDLINK_DIR}</code>
                   5279:       whenever the <em class="replaceable"><code>pkg</code></em>
                   5280:       <code class="filename">buildlink3.mk</code>
1.120     snj      5281:       file is included. Dependencies are only added for directly
                   5282:       include <code class="filename">buildlink3.mk</code> files.</p>
1.153     wiz      5283: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   5284:       including other <code class="filename">buildlink3.mk</code> files in it,
1.156     wiz      5285:       please only add necessary ones, i.e., those whose libraries or
1.153     wiz      5286:       header files are automatically exposed when the package is
                   5287:       use.</p>
                   5288: <p>In particular, if only an executable
                   5289:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   5290:       library does not need to be propagated in the
                   5291:       <code class="filename">buildlink3.mk</code> file.</p>
                   5292: <p>The following steps should help you decide if a
                   5293:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   5294:       </p>
                   5295: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5296: <li class="listitem"><p>Look at the installed header files: What
                   5297:        headers do they include? The packages providing these files
                   5298:        must be buildlinked.</p></li>
1.155     wiz      5299: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   5300:        libraries and look against what other libraries they link.
                   5301:        Some of the packages providing these probably need to be
                   5302:        buildlinked; however, it's not automatic, since e.g. GTK on
                   5303:        some systems pulls in the X libraries, so they will show up in
                   5304:        the <code class="filename">ldd</code> output, while on others (like OS
1.156     wiz      5305:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.155     wiz      5306:        used as a hint.</p></li>
1.153     wiz      5307: </ul></div>
                   5308: <p>
                   5309:       </p>
1.75      rillig   5310: </div>
1.148     asau     5311: <div class="sect2">
1.75      rillig   5312: <div class="titlepage"><div><div><h3 class="title">
1.133     wiz      5313: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.87      wiz      5314:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      5315:       and
                   5316:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5317:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   5318: <p>These two variables differ in that one describes source
                   5319:       compatibility (API) and the other binary compatibility (ABI).
                   5320:       The difference is that a change in the API breaks compilation of
                   5321:       programs while changes in the ABI stop compiled programs from
                   5322:       running.</p>
                   5323: <p>Changes to the
1.134     wiz      5324:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      5325:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   5326:       very rarely. One possible reason is that all packages depending
                   5327:       on this already need a newer version. In case it is bumped see
                   5328:       the description below.</p>
                   5329: <p>The most common example of an ABI change is that the major
                   5330:       version of a shared library is increased. In this case,
                   5331:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5332:       should be adjusted to require at least the new package version.
                   5333:       Then the packages that depend on this package need their
                   5334:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   5335:       <code class="filename">buildlink3.mk</code> files, their
                   5336:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5337:       adjusted, too. This is needed so pkgsrc will require the correct
                   5338:       package dependency and not settle for an older one when building
                   5339:       the source.</p>
1.218     rillig   5340: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, &#8220;Handling dependencies&#8221;</a> for
1.133     wiz      5341:       more information about dependencies on other packages,
                   5342:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      5343:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   5344: <p>Please take careful consideration before adjusting
                   5345:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5346:       or
                   5347:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5348:       as we don't want to cause unneeded package deletions and
                   5349:       rebuilds.  In many cases, new versions of packages work just
                   5350:       fine with older dependencies.</p>
                   5351: <p>Also it is not needed to set
1.133     wiz      5352:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   5353:       when it is identical to
1.87      wiz      5354:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   5355: </div>
                   5356: </div>
1.148     asau     5357: <div class="sect1">
1.75      rillig   5358: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5359: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      5360: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   5361:       coincide with headers and libraries present in the base system.
1.76      rillig   5362:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   5363:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   5364:       file that includes the necessary checks to decide whether using
                   5365:       the built-in software or the pkgsrc software is
1.87      wiz      5366:     appropriate.</p>
                   5367: <p>The only requirements of a builtin.mk file for
                   5368:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.128     wiz      5369: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5370: <li class="listitem"><p>It should set
1.87      wiz      5371:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5372:        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>
1.87      wiz      5373:        after it is included.</p></li>
1.128     wiz      5374: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87      wiz      5375:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5376:        which is already set before the
                   5377:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.128     wiz      5378: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.87      wiz      5379:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   5380:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   5381: </ol></div>
1.148     asau     5382: <div class="sect2">
1.75      rillig   5383: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5384: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75      rillig   5385: <p>The following is the recommended template for builtin.mk
1.87      wiz      5386:       files:</p>
1.75      rillig   5387: <pre class="programlisting">
1.100     rillig   5388: .if !defined(IS_BUILTIN.foo)
                   5389: #
                   5390: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   5391: # genuinely exists in the system or not.
                   5392: #
                   5393: IS_BUILTIN.foo?=        no
                   5394: 
                   5395: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   5396: # version can be determined.
                   5397: #
                   5398: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   5399: BUILTIN_PKG.foo?=       foo-1.0
                   5400: .  endif
                   5401: .endif  # IS_BUILTIN.foo
                   5402: 
                   5403: .if !defined(USE_BUILTIN.foo)
                   5404: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5405: .  if defined(BUILTIN_PKG.foo)
                   5406: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5407: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5408: USE_BUILTIN.foo!=                                                       \
                   5409:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5410:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5411: .      endif
                   5412: .    endfor
                   5413: .  endif
                   5414: .endif  # USE_BUILTIN.foo
                   5415: 
                   5416: CHECK_BUILTIN.foo?=     no
                   5417: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5418: #
                   5419: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5420: # "yes" or "no".
                   5421: #
                   5422: .endif  # CHECK_BUILTIN.foo
                   5423: </pre>
1.87      wiz      5424: <p>The first section sets
                   5425:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5426:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5427:       in the base system.  This should not be a base system software
                   5428:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128     wiz      5429:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.87      wiz      5430:       included as part of the base system.  This variable is only
                   5431:       used internally within the <code class="filename">builtin.mk</code>
                   5432:       file.</p>
                   5433: <p>The second section sets
                   5434:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5435:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5436:       system if it exists (if
                   5437:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5438:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.87      wiz      5439:       within the <code class="filename">builtin.mk</code> file.</p>
                   5440: <p>The third section sets
                   5441:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5442:       and is <span class="emphasis"><em>required</em></span> in all
                   5443:       <code class="filename">builtin.mk</code> files.  The code in this
                   5444:       section must make the determination whether the built-in
                   5445:       software is adequate to satisfy the dependencies listed in
                   5446:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5447:       This is typically done by comparing
                   5448:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5449:       against each of the dependencies in
                   5450:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5451:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5452:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5453:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5454:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5455:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.87      wiz      5456:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5457:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.87      wiz      5458:       that the built-in version of the software is similar enough to
                   5459:       be used as a replacement.</p>
                   5460: <p>The last section is guarded by
                   5461:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5462:       and includes code that uses the value of
                   5463:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5464:       set in the previous section.  This typically includes, e.g.,
                   5465:       adding additional dependency restrictions and listing additional
                   5466:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5467:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5468: </div>
1.148     asau     5469: <div class="sect2">
1.75      rillig   5470: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5471: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5472: <p>When building packages, it's possible to choose whether to set
                   5473:        a global preference for using either the built-in (native)
                   5474:        version or the pkgsrc version of software to satisfy a
                   5475:        dependency.  This is controlled by setting
                   5476:        <code class="varname">PREFER_PKGSRC</code> and
                   5477:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.128     wiz      5478:        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
1.87      wiz      5479:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5480:        use the pkgsrc versions of software, while
                   5481:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5482:        built-in versions.  Preferences are determined by the most
                   5483:        specific instance of the package in either
                   5484:        <code class="varname">PREFER_PKGSRC</code> or
                   5485:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5486:        in neither or in both variables, then
                   5487:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5488:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5489:        using pkgsrc versions of software for all but the most basic
                   5490:       bits on a NetBSD system, you can set:</p>
                   5491: <pre class="programlisting">
1.100     rillig   5492: PREFER_PKGSRC=  yes
                   5493: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5494: </pre>
1.87      wiz      5495: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5496:       <code class="filename">builtin.mk</code>
                   5497:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5498:       otherwise it is simply ignored in that list.</p>
1.75      rillig   5499: </div>
                   5500: </div>
                   5501: </div>
1.148     asau     5502: <div class="chapter">
1.75      rillig   5503: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5504: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.75      rillig   5505: <div class="toc">
                   5506: <p><b>Table of Contents</b></p>
1.210     leot     5507: <dl class="toc">
1.106     rillig   5508: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5509: <dd><dl>
1.106     rillig   5510: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   5511: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.75      rillig   5512: </dl></dd>
1.106     rillig   5513: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.75      rillig   5514: <dd><dl>
1.128     wiz      5515: <dt><span class="sect2"><a href="#conf-files-sysconfdir">15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
1.106     rillig   5516: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   5517: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   5518: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   5519: </dl></dd>
                   5520: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   5521: <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>
                   5522: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   5523: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   5524: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5525: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   5526: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75      rillig   5527: </dl>
                   5528: </div>
                   5529: <p>This chapter describes the framework known as
                   5530: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148     asau     5531: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5532: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75      rillig   5533:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5534: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75      rillig   5535:     provided that packages are correctly designed.</p></li>
1.128     wiz      5536: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5537: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5538: <li class="listitem"><p>Registration of system shells.</p></li>
                   5539: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75      rillig   5540: </ul></div>
                   5541: <p>The following sections inspect each of the above points in detail.</p>
                   5542: <p>You may be thinking that many of the things described here could be
                   5543: easily done with simple code in the package's post-installation target
                   5544: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5545: as the code in them is only executed when building from source.  Machines
                   5546: using binary packages could not benefit from it at all (as the code itself
                   5547: could be unavailable).  Therefore, the only way to achieve any of the items
                   5548: described above is by means of the installation scripts, which are
                   5549: automatically generated by pkginstall.</p>
1.148     asau     5550: <div class="sect1">
1.75      rillig   5551: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5552: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5553: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5554: of files and directories that belong to a package.  The names used in it
1.76      rillig   5555: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5556: which means that it cannot register files outside this directory (absolute
                   5557: path names are not allowed).  Despite this restriction, some packages need
                   5558: to install files outside this location; e.g., under
1.76      rillig   5559: <code class="filename">${VARBASE}</code> or
1.87      wiz      5560: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5561: is to create such files during installation time by using
                   5562: installation scripts.</p>
                   5563: <p>The generic installation scripts are shell scripts that can
                   5564: contain arbitrary code.  The list of scripts to execute is taken from
                   5565: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5566: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5567: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5568: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5569: commands, so they have the potential to create and manage files
                   5570: anywhere in the file system.</p>
                   5571: <p>Using these general installation files is not recommended, but
                   5572: may be needed in some special cases.  One reason for avoiding them is
                   5573: that the user has to trust the packager that there is no unwanted or
                   5574: simply erroneous code included in the installation script. Also,
                   5575: previously there were many similar scripts for the same functionality,
                   5576: and fixing a common error involved finding and changing all of
                   5577: them.</p>
                   5578: <p>The pkginstall framework offers another, standardized way.  It
                   5579: provides generic scripts to abstract the manipulation of such files
                   5580: and directories based on variables set in the package's
                   5581: <code class="filename">Makefile</code>.  The rest of this section describes
                   5582: these variables.</p>
1.148     asau     5583: <div class="sect2">
1.75      rillig   5584: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5585: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5586: <p>The following variables can be set to request the creation of
                   5587: directories anywhere in the file system:</p>
1.148     asau     5588: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218     rillig   5589: <li class="listitem">
                   5590: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75      rillig   5591:     contain a list of directories that should be created and should attempt
                   5592:     to be destroyed by the installation scripts.  The difference between
                   5593:     the two is that the latter prompts the administrator to remove any
                   5594:     directories that may be left after deinstallation (because they were
1.218     rillig   5595:     not empty), while the former does not.  Example:</p>
                   5596: <pre class="programlisting">
                   5597: MAKE_DIRS+=             ${VARBASE}/foo/private
                   5598: </pre>
                   5599: </li>
1.128     wiz      5600: <li class="listitem">
1.75      rillig   5601: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5602:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5603:     which directories should be created and should attempt to be destroyed
                   5604:     by the installation scripts.  Each tuple holds the following values,
                   5605:     separated by spaces: the directory name, its owner, its group and its
                   5606:     numerical mode.  For example:</p>
                   5607: <pre class="programlisting">
1.218     rillig   5608: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5609:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5610: </pre>
1.75      rillig   5611: <p>The difference between the two is exactly the same as their
                   5612:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5613: </li>
                   5614: </ul></div>
                   5615: </div>
1.148     asau     5616: <div class="sect2">
1.75      rillig   5617: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5618: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5619: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5620: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5621: To overcome this problem, the only solution is to extract the file in the
                   5622: known place (i.e., inside the installation prefix) and copy it to the
                   5623: appropriate location during installation (done by the installation scripts
                   5624: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5625: file</em></span> in the following paragraphs, which describe the variables
                   5626: that can be used to automatically and consistently handle files outside the
                   5627: installation prefix:</p>
1.148     asau     5628: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5629: <li class="listitem">
1.75      rillig   5630: <p><code class="varname">CONF_FILES</code> and
1.137     wiz      5631:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75      rillig   5632:     During installation time, the master file is copied to the target one
                   5633:     if and only if the latter does not exist.  Upon deinstallation, the
                   5634:     target file is removed provided that it was not modified by the
                   5635:     installation.</p>
                   5636: <p>The difference between the two is that the latter prompts the
                   5637:     administrator to remove any files that may be left after
                   5638:     deinstallation (because they were not empty), while the former does
                   5639:     not.</p>
                   5640: </li>
1.128     wiz      5641: <li class="listitem">
1.75      rillig   5642: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137     wiz      5643:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75      rillig   5644:     files as well as their target locations.  For each of them, it also
                   5645:     specifies their owner, their group and their numeric permissions, in
                   5646:     this order.  For example:</p>
                   5647: <pre class="programlisting">
1.218     rillig   5648: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5649:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5650: </pre>
1.75      rillig   5651: <p>The difference between the two is exactly the same as their
                   5652:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5653: </li>
                   5654: </ul></div>
                   5655: </div>
                   5656: </div>
1.148     asau     5657: <div class="sect1">
1.75      rillig   5658: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5659: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.75      rillig   5660: <p>Configuration files are special in the sense that they are installed
                   5661: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5662: need special treatment during installation (most of which is automated by
                   5663: pkginstall).  The main concept you must bear in mind is that files marked
                   5664: as configuration files are automatically copied to the right place (somewhere
                   5665: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5666: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5667: be removed if they have local modifications.  This ensures that
                   5668: administrators never lose any custom changes they may have made.</p>
1.148     asau     5669: <div class="sect2">
1.75      rillig   5670: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5671: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   5672: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5673: specifies where configuration files shall be installed.  Its contents are
                   5674: set based upon the following variables:</p>
1.148     asau     5675: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5676: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5677:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5678:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5679:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5680:     Packages must not use it directly.</p></li>
1.128     wiz      5681: <li class="listitem">
1.75      rillig   5682: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5683:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5684:     for the package being built shall be installed.  The definition of this
                   5685:     variable only makes sense in the package's
1.76      rillig   5686:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5687: <p>As an example, consider the Apache package,
1.189     snj      5688:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.75      rillig   5689:     configuration files under the
1.76      rillig   5690:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5691:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5692:     Makefile.</p>
                   5693: </li>
1.128     wiz      5694: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75      rillig   5695:     variable that holds this package's configuration directory (if
                   5696:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5697:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5698:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128     wiz      5699: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75      rillig   5700:     directory where the configuration files for the package identified by
                   5701:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5702: </ul></div>
                   5703: <p>Based on the above variables, pkginstall determines the value of
                   5704: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5705: variable that can be used within a package to refer to its configuration
                   5706: directory.  The algorithm used to set its value is basically the
                   5707: following:</p>
1.128     wiz      5708: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5709: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75      rillig   5710:     its value is used.</p></li>
1.128     wiz      5711: <li class="listitem"><p>If the previous variable is not defined but
1.75      rillig   5712:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5713:     <code class="filename">Makefile</code>, the resulting value is
                   5714:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128     wiz      5715: <li class="listitem"><p>Otherwise, it is set to
1.76      rillig   5716:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5717: </ol></div>
1.76      rillig   5718: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.117     jnemeth  5719: 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
                   5720: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5721: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   5722: </div>
1.148     asau     5723: <div class="sect2">
1.75      rillig   5724: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5725: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5726: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5727: known place, you need to teach each package where it shall install its
                   5728: files.  In some cases you will have to patch the package Makefiles to
                   5729: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5730: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5731: generated files:</p>
                   5732: <pre class="programlisting">
1.100     rillig   5733: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    5734: </pre>
1.75      rillig   5735: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5736: for</em></span> its configuration files, not where they will be originally
                   5737: installed (although the difference is never explicit,
                   5738: unfortunately).</p>
                   5739: </div>
1.148     asau     5740: <div class="sect2">
1.75      rillig   5741: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5742: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.75      rillig   5743: <p>As said before, pkginstall automatically handles configuration files.
                   5744: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   5745: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   5746: directly</strong></span>.  Bad news is that many software installation scripts
                   5747: will, out of the box, mess with the contents of that directory.  So what is
                   5748: the correct procedure to fix this issue?</p>
                   5749: <p>You must teach the package (usually by manually patching it) to
                   5750: install any configuration files under the examples hierarchy,
1.76      rillig   5751: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5752: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   5753: has the original copies available.</p>
                   5754: <p>Once the required configuration files are in place (i.e., under the
                   5755: examples hierarchy), the pkginstall framework can use them as master copies
                   5756: during the package installation to update what is in
1.76      rillig   5757: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   5758: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.110     hubertf  5759: used.  Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, &#8220;File manipulation&#8221;</a> for information
1.75      rillig   5760: about their syntax and their purpose.  Here is an example, taken from the
1.189     snj      5761: <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.75      rillig   5762: <pre class="programlisting">
1.100     rillig   5763: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5764: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    5765: </pre>
1.75      rillig   5766: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5767: package and has no meaning outside it.</p>
                   5768: </div>
1.148     asau     5769: <div class="sect2">
1.75      rillig   5770: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5771: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   5772: <p>The automatic copying of config files can be toggled by setting the
                   5773: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5774: installation.</p>
                   5775: </div>
                   5776: </div>
1.148     asau     5777: <div class="sect1">
1.75      rillig   5778: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5779: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.75      rillig   5780: <p>System startup scripts are special files because they must be
                   5781: installed in a place known by the underlying OS, usually outside the
1.110     hubertf  5782: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.75      rillig   5783: can be used.  However, pkginstall provides a special mechanism to handle
                   5784: these files.</p>
                   5785: <p>In order to provide system startup scripts, the package has
                   5786: to:</p>
1.128     wiz      5787: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5788: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   5789:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.189     snj      5790:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
1.76      rillig   5791:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128     wiz      5792: <li class="listitem">
1.75      rillig   5793: <p>Tell pkginstall to handle it, appending the name of the script,
                   5794:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5795:     Continuing the previous example:</p>
                   5796: <pre class="programlisting">
1.100     rillig   5797: RCD_SCRIPTS+=   cupsd
1.1       grant    5798: </pre>
1.75      rillig   5799: </li>
                   5800: </ol></div>
                   5801: <p>Once this is done, pkginstall will do the following steps for each
                   5802: script in an automated fashion:</p>
1.128     wiz      5803: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5804: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76      rillig   5805:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   5806:     variable.</p></li>
1.128     wiz      5807: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76      rillig   5808:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   5809:     that this master file must be explicitly registered in the
1.76      rillig   5810:     <code class="filename">PLIST</code>.</p></li>
1.128     wiz      5811: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75      rillig   5812:     from the examples hierarchy into the system-wide startup scripts
                   5813:     directory.</p></li>
                   5814: </ol></div>
1.148     asau     5815: <div class="sect2">
1.75      rillig   5816: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5817: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   5818: <p>The automatic copying of config files can be toggled by setting the
                   5819: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5820: installation.  Note that the scripts will be always copied inside the
1.76      rillig   5821: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   5822: matter what the value of this variable is.</p>
                   5823: </div>
                   5824: </div>
1.148     asau     5825: <div class="sect1">
1.75      rillig   5826: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5827: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.75      rillig   5828: <p>If a package needs to create special users and/or groups during
                   5829: installation, it can do so by using the pkginstall framework.</p>
                   5830: <p>Users can be created by adding entries to the
                   5831: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5832: syntax:</p>
                   5833: <pre class="programlisting">
1.100     rillig   5834: user:group
1.1       grant    5835: </pre>
1.87      wiz      5836: <p>Further specification of user details may be done by setting
                   5837: per-user variables.
                   5838: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5839: numeric UID for the user.
                   5840: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5841: user's description or comment.
                   5842: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5843: user's home directory, and defaults to
                   5844: <code class="filename">/nonexistent</code> if not specified.
                   5845: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 5846: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      5847: not specified.</p>
1.75      rillig   5848: <p>Similarly, groups can be created by adding entries to the
                   5849: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5850: <pre class="programlisting">
1.100     rillig   5851: group
1.1       grant    5852: </pre>
1.93      rillig   5853: <p>The numeric GID of the group may be set by defining
1.75      rillig   5854: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5855: <p>If a package needs to create the users and groups at an earlier
                   5856: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to
                   5857: either <code class="literal">configure</code> or <code class="literal">build</code> to
                   5858: indicate the phase before which the users and groups are created.  In
                   5859: this case, the numeric UIDs and GIDs of the created users and groups
                   5860: are automatically hardcoded into the final installation scripts.</p>
                   5861: </div>
1.148     asau     5862: <div class="sect1">
1.75      rillig   5863: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5864: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.75      rillig   5865: <p>Packages that install system shells should register them in the shell
1.76      rillig   5866: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   5867: administrator.  This must be done from the installation scripts to keep
                   5868: binary packages working on any system.  pkginstall provides an easy way to
                   5869: accomplish this task.</p>
                   5870: <p>When a package provides a shell interpreter, it has to set the
                   5871: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5872: add some hooks to the installation scripts to handle it.  Consider the
1.189     snj      5873: following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.75      rillig   5874: <pre class="programlisting">
1.100     rillig   5875: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    5876: </pre>
1.148     asau     5877: <div class="sect2">
1.75      rillig   5878: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5879: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   5880: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   5881: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   5882: environment variable to <code class="literal">NO</code>.</p>
                   5883: </div>
                   5884: </div>
1.148     asau     5885: <div class="sect1">
1.75      rillig   5886: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5887: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.75      rillig   5888: <p>Packages that install X11 fonts should update the database files
                   5889: that index the fonts within each fonts directory.  This can easily be
                   5890: accomplished within the pkginstall framework.</p>
                   5891: <p>When a package installs X11 fonts, it must list the directories in
                   5892: which fonts are installed in the
                   5893: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128     wiz      5894: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5895: <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
1.75      rillig   5896: installation scripts to run the appropriate commands to update the fonts
                   5897: database files within each of those directories.  For convenience, if the
                   5898: directory path is relative, it is taken to be relative to the package's
1.189     snj      5899: installation prefix.  Consider the following example, taken from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   5900: <pre class="programlisting">
1.175     wiz      5901: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       grant    5902: </pre>
1.148     asau     5903: <div class="sect2">
1.75      rillig   5904: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   5905: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   5906: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   5907: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   5908: environment variable to <code class="literal">NO</code>.</p>
                   5909: </div>
                   5910: </div>
                   5911: </div>
1.148     asau     5912: <div class="chapter">
1.75      rillig   5913: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   5914: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.75      rillig   5915: <div class="toc">
                   5916: <p><b>Table of Contents</b></p>
1.210     leot     5917: <dl class="toc">
1.106     rillig   5918: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.128     wiz      5919: <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>
1.106     rillig   5920: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.107     rillig   5921: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   5922: </dl>
                   5923: </div>
                   5924: <p>Many packages have the ability to be built to support different
1.76      rillig   5925: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   5926: in pkgsrc that provides generic handling of those options that
                   5927: determine different ways in which the packages can be built.  It's
                   5928: possible for the user to specify exactly which sets of options will be
                   5929: built into a package or to allow a set of global default options
                   5930: apply.</p>
1.107     rillig   5931: <p>There are two broad classes of behaviors that one might want to
                   5932: control via options.  One is whether some particular feature is
                   5933: enabled in a program that will be built anyway, often by including or
                   5934: not including a dependency on some other package.  The other is
                   5935: whether or not an additional program will be built as part of the
                   5936: package.  Generally, it is better to make a split package for such
                   5937: additional programs instead of using options, because it enables
                   5938: binary packages to be built which can then be added separately.  For
                   5939: example, the foo package might have minimal dependencies (those
                   5940: packages without which foo doesn't make sense), and then the foo-gfoo
                   5941: package might include the GTK frontend program gfoo.  This is better
                   5942: than including a gtk option to foo that adds gfoo, because either that
                   5943: option is default, in which case binary users can't get foo without
                   5944: gfoo, or not default, in which case they can't get gfoo.  With split
                   5945: packages, they can install foo without having GTK, and later decide to
                   5946: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5947: source users too, avoiding the need for rebuilds.</p>
                   5948: <p>Plugins with widely varying dependencies should usually be split
                   5949: instead of options.</p>
                   5950: <p>It is often more work to maintain split packages, especially if
                   5951: the upstream package does not support this.  The decision of split
                   5952: vs. option should be made based on the likelihood that users will want
                   5953: or object to the various pieces, the size of the dependencies that are
                   5954: included, and the amount of work.</p>
                   5955: <p>A further consideration is licensing.  Non-free parts, or parts
                   5956: that depend on non-free dependencies (especially plugins) should
                   5957: almost always be split if feasible.</p>
1.148     asau     5958: <div class="sect1">
1.75      rillig   5959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5960: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.75      rillig   5961: <p>Global default options are listed in
                   5962: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5963: that should be built into every package if that option is supported.
1.110     hubertf  5964: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5965: </div>
1.148     asau     5966: <div class="sect1">
1.75      rillig   5967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   5968: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   5969: </h2></div></div></div>
1.75      rillig   5970: <p>The following example shows how
1.76      rillig   5971: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   5972: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   5973: <code class="filename">Makefile</code>, or in a file,
                   5974: e.g. <code class="filename">options.mk</code>, that is included by the
                   5975: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5976: <pre class="programlisting">
1.100     rillig   5977: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5978: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5979: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5980: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5981: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5982: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5983: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5984: 
                   5985: .include "../../mk/bsd.prefs.mk"
                   5986: 
                   5987: # this package was previously named wibble2
                   5988: .if defined(PKG_OPTIONS.wibble2)
                   5989: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5990: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5991:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5992: .endif
                   5993: 
                   5994: .include "../../mk/bsd.options.mk"
                   5995: 
                   5996: # Package-specific option-handling
                   5997: 
                   5998: ###
                   5999: ### FOO support
                   6000: ###
                   6001: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   6002: CONFIGURE_ARGS+=    --enable-foo
                   6003: .endif
                   6004: 
                   6005: ###
                   6006: ### LDAP support
                   6007: ###
                   6008: .if !empty(PKG_OPTIONS:Mldap)
                   6009: .  include "../../databases/openldap-client/buildlink3.mk"
                   6010: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   6011: .endif
                   6012: 
                   6013: ###
                   6014: ### database support
                   6015: ###
                   6016: .if !empty(PKG_OPTIONS:Mmysql)
                   6017: .  include "../../mk/mysql.buildlink3.mk"
                   6018: .endif
                   6019: .if !empty(PKG_OPTIONS:Mpgsql)
                   6020: .  include "../../mk/pgsql.buildlink3.mk"
                   6021: .endif
1.75      rillig   6022: </pre>
                   6023: <p>The first section contains the information about which build
                   6024: options are supported by the package, and any default options settings
                   6025: if needed.</p>
1.128     wiz      6026: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6027: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.189     snj      6028: <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
1.75      rillig   6029: options.  It should be set to
1.78      rillig   6030: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   6031: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   6032: at the point where the options are processed.</p></li>
1.128     wiz      6033: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75      rillig   6034: build options supported by the package.</p></li>
1.128     wiz      6035: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75      rillig   6036: list of names of groups of mutually exclusive options.  The options in
                   6037: each group are listed in
                   6038: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   6039: The most specific setting of any option from the group takes
                   6040: precedence over all other options in the group.  Options from the
                   6041: groups will be automatically added to
                   6042: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128     wiz      6043: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75      rillig   6044: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   6045: packages will fail if no option from the group is
                   6046: selected.</p></li>
1.128     wiz      6047: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75      rillig   6048: of names of sets of options.  At least one option from each set must
                   6049: be selected.  The options in each set are listed in
                   6050: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   6051: Options from the sets will be automatically added to
                   6052: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   6053: fail if no option from the set is selected.</p></li>
1.128     wiz      6054: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75      rillig   6055: build options which are enabled by default.</p></li>
1.128     wiz      6056: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75      rillig   6057: of
1.128     wiz      6058: <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>
1.110     hubertf  6059: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   6060: their option counterparts.  Pairs should be added with
1.128     wiz      6061: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.75      rillig   6062: warning will be issued if the user uses a legacy
                   6063: variable.</p></li>
1.128     wiz      6064: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75      rillig   6065: of
1.128     wiz      6066: <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>
1.75      rillig   6067: pairs that map options that have been renamed to their new
1.128     wiz      6068: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.75      rillig   6069: the listing of global legacy options.  A warning will be issued if
                   6070: the user uses a legacy option.</p></li>
1.128     wiz      6071: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75      rillig   6072: options implied by deprecated variables used.  This can be used for
                   6073: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   6074: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   6075: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128     wiz      6076: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75      rillig   6077: a list of warnings about deprecated variables or options used, and
                   6078: what to use instead.</p></li>
                   6079: </ol></div>
                   6080: <p>A package should never modify
                   6081: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   6082: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   6083: To suggest a default set of options, use
                   6084: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   6085: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   6086: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   6087: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   6088: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   6089: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   6090: happen with platform-specific options if none of them is supported on
                   6091: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   6092: empty list and the package is otherwise treated as not using the
                   6093: options framework.</p>
1.76      rillig   6094: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   6095: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   6096: build options, properly filtered to remove unsupported and duplicate
                   6097: options.</p>
                   6098: <p>The remaining sections contain the logic that is specific to
                   6099: each option.  The correct way to check for an option is to check
                   6100: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   6101: <pre class="programlisting">
1.100     rillig   6102: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   6103: </pre>
                   6104: </div>
1.148     asau     6105: <div class="sect1">
1.75      rillig   6106: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6107: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.75      rillig   6108: <p>Options that enable similar features in different packages (like
                   6109: optional support for a library) should use a common name in all
                   6110: packages that support it (like the name of the library).  If another
                   6111: package already has an option with the same meaning, use the same
                   6112: name.</p>
                   6113: <p>Options that enable features specific to one package, where it's
                   6114: unlikely that another (unrelated) package has the same (or a similar)
                   6115: optional feature, should use a name prefixed with
                   6116: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   6117: <p>If a group of related packages share an optional feature
                   6118: specific to that group, prefix it with the name of the
1.128     wiz      6119: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.75      rillig   6120: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   6121: <p>For new options, add a line to
1.76      rillig   6122: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   6123: fields, separated by tab.  The first field is the option name, the
                   6124: second its description.  The description should be a whole sentence
                   6125: (starting with an uppercase letter and ending with a period) that
1.128     wiz      6126: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   6127: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.75      rillig   6128: </div>
1.148     asau     6129: <div class="sect1">
1.107     rillig   6130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6131: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  6132: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107     rillig   6133: different dependencies based on the options with which the package was
                   6134: built. For querying these options, the file
                   6135: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   6136: typical example looks like this:</p>
                   6137: <pre class="programlisting">
                   6138: pkgbase := libpurple
                   6139: .include "../../mk/pkg-build-options.mk"
                   6140: 
                   6141: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   6142: ...
                   6143: .endif
                   6144: </pre>
                   6145: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   6146: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   6147: options of the libpurple package, which can then be queried like
                   6148: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   6149: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   6150: details.</p>
                   6151: </div>
1.75      rillig   6152: </div>
1.148     asau     6153: <div class="chapter">
1.75      rillig   6154: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   6155: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.75      rillig   6156: <div class="toc">
                   6157: <p><b>Table of Contents</b></p>
1.210     leot     6158: <dl class="toc">
1.106     rillig   6159: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   6160: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   6161: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   6162: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.128     wiz      6163: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   6164: <dd><dl>
                   6165: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   6166: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   6167: </dl></dd>
1.128     wiz      6168: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   6169: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   6170: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   6171: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   6172: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   6173: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6174: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6175: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   6176: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6177: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.106     rillig   6178: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   6179: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.75      rillig   6180: </dl>
                   6181: </div>
1.148     asau     6182: <div class="sect1">
1.75      rillig   6183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6184: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.75      rillig   6185: <p>This chapter gives a detailed description on how a package is
1.87      wiz      6186:     built. Building a package is separated into different
                   6187:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   6188:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      6189:     described in the following sections. Each phase is split into
1.87      wiz      6190:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   6191:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   6192:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   6193:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   6194:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   6195: <p>Never override the regular targets (like
                   6196:     <code class="varname">fetch</code>), if you have to, override the
                   6197:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   6198: <p>The basic steps for building a program are always the same.  First
1.87      wiz      6199:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   6200:     the local system and then extracted. After any pkgsrc-specific patches
                   6201:     to compile properly are applied, the software can be configured, then
                   6202:     built (usually by compiling), and finally the generated binaries, etc.
                   6203:     can be put into place on the system.</p>
1.97      rillig   6204: <p>To get more details about what is happening at each step,
                   6205:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   6206:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   6207:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   6208: </div>
1.148     asau     6209: <div class="sect1">
1.75      rillig   6210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6211: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.75      rillig   6212: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      6213:     the next section, here's a brief discussion on where programs are
                   6214:     installed, and which variables influence this.</p>
1.75      rillig   6215: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      6216:     where all files of the final program shall be installed. It is
                   6217:     usually set to <code class="varname">LOCALBASE</code>
                   6218:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      6219:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      6220:     <code class="varname">PREFIX</code> needs to be put
                   6221:     into the various places in the program's source where paths to
1.219   ! rillig   6222:     these files are encoded.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> and <a class="xref" href="#fixes.libtool" title="19.3.1. Shared libraries - libtool">Section 19.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
1.75      rillig   6223: <p>When choosing which of these variables to use,
1.87      wiz      6224:     follow the following rules:</p>
1.148     asau     6225: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6226: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88      wiz      6227:        where the current pkg will be installed.  When referring to a
                   6228:        pkg's own installation path, use
1.128     wiz      6229:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   6230: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88      wiz      6231:        are installed.  If you need to construct a -I or -L argument
                   6232:        to the compiler to find includes and libraries installed by
1.128     wiz      6233:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.87      wiz      6234:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   6235:        installed all packages in <code class="filename">/usr/local</code>. As
                   6236:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   6237:        administrator, this variable is a misnomer.</p></li>
1.128     wiz      6238: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88      wiz      6239:        distribution (from xsrc, etc.) is installed. When looking for
                   6240:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128     wiz      6241:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.209     sevan    6242: <li class="listitem"><p>X11-based packages using imake must set
                   6243:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   6244:        <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      6245: <li class="listitem">
1.209     sevan    6246: <p>To determine the prefix of an
1.88      wiz      6247:        installed package, the <code class="varname">EVAL_PREFIX</code>
                   6248:        definition can be used. It takes pairs in the format
1.189     snj      6249:        <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>
1.88      wiz      6250:        variable <code class="varname">DIRNAME</code> will be set to the prefix
                   6251:        of the installed package &lt;package&gt;, or
1.209     sevan    6252:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> if the package is not
1.88      wiz      6253:        installed.</p>
1.75      rillig   6254: <p>This is best illustrated by example.</p>
                   6255: <p>The following lines are taken from
1.87      wiz      6256:        <code class="filename">pkgsrc/wm/scwm/Makefile</code>:</p>
1.75      rillig   6257: <pre class="programlisting">
1.100     rillig   6258: EVAL_PREFIX+=           GTKDIR=gtk+
                   6259: CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE:Q}
                   6260: CONFIGURE_ARGS+=        --with-gtk-prefix=${GTKDIR:Q}
                   6261: CONFIGURE_ARGS+=        --enable-multibyte
                   6262: </pre>
1.88      wiz      6263: <p>Specific defaults can be defined for the packages
                   6264:        evaluated using <code class="varname">EVAL_PREFIX</code>, by using a
                   6265:        definition of the form:</p>
1.75      rillig   6266: <pre class="programlisting">
1.100     rillig   6267: GTKDIR_DEFAULT= ${LOCALBASE}
                   6268: </pre>
1.75      rillig   6269: <p>where <code class="varname">GTKDIR</code> corresponds
1.87      wiz      6270:        to the first definition in
                   6271:        the <code class="varname">EVAL_PREFIX</code> pair.</p>
1.75      rillig   6272: </li>
1.128     wiz      6273: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.189     snj      6274:        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
1.87      wiz      6275:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   6276:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   6277: </ul></div>
                   6278: </div>
1.148     asau     6279: <div class="sect1">
1.75      rillig   6280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6281: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 6282: <p>When building a package, various directories are used to store
1.87      wiz      6283:     source files, temporary files, pkgsrc-internal files, and so on. These
                   6284:     directories are explained here.</p>
1.75      rillig   6285: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      6286:     are two common base directories for these relative directories:
                   6287:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   6288:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   6289:     inside the package itself.</p>
1.148     asau     6290: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6291: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   6292: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      6293:       root directory. Generally, you don't need
                   6294:       it.</p></dd>
1.97      rillig   6295: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   6296: <dd><p>This is an absolute pathname that points to the
                   6297:       current package.</p></dd>
1.75      rillig   6298: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   6299: <dd><p>This is a pathname relative to
1.87      wiz      6300:       <code class="varname">PKGSRCDIR</code> that points to the current
                   6301:       package.</p></dd>
1.75      rillig   6302: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   6303: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   6304:       where all work takes place. The distfiles are extracted to this
1.87      wiz      6305:       directory. It also contains temporary directories and log files used by
                   6306:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   6307:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   6308: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   6309: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      6310:       where the distfiles are extracted. It is usually a direct subdirectory
                   6311:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   6312:       that isn't hidden. This variable may be changed by a package
                   6313:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   6314: </dl></div>
1.114     jmcneill 6315: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   6316:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   6317:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 6318:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   6319:     If users would like to have their pkgsrc trees behave in a
                   6320:     read-only manner, then the value of
                   6321:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   6322:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   6323: </div>
1.148     asau     6324: <div class="sect1">
1.75      rillig   6325: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6326: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.110     hubertf  6327: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      6328:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   6329:     phase. This will automatically run all phases that are required for this
                   6330:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  6331:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      6332:     the package will be built, but not installed.</p>
1.75      rillig   6333: </div>
1.148     asau     6334: <div class="sect1">
1.75      rillig   6335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6336: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   6337: <p>The first step in building a package is to fetch the
1.88      wiz      6338:     distribution files (distfiles) from the sites that are providing
                   6339:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   6340:     phase.</p>
1.148     asau     6341: <div class="sect2">
1.81      rillig   6342: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6343: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      6344: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   6345:       defines all URLs from where the distfile, whose name is
                   6346:       derived from the <code class="varname">DISTNAME</code> variable, is
                   6347:       fetched. The more complicated cases are described
                   6348:       below.</p>
                   6349: <p>The variable <code class="varname">DISTFILES</code> specifies
                   6350:       the list of distfiles that have to be fetched. Its value
1.174     asau     6351:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   6352:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88      wiz      6353:       so that most packages don't need to define it at all.
                   6354:       <code class="varname">EXTRACT_SUFX</code> is
                   6355:       <code class="literal">.tar.gz</code> by default, but can be changed
                   6356:       freely. Note that if your package requires additional
                   6357:       distfiles to the default one, you cannot just append the
                   6358:       additional filenames using the <code class="literal">+=</code>
                   6359:       operator, but you have write for example:</p>
1.81      rillig   6360: <pre class="programlisting">
1.174     asau     6361: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100     rillig   6362: </pre>
1.88      wiz      6363: <p>Each distfile is fetched from a list of sites, usually
                   6364:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   6365:       <code class="varname">DISTFILES</code> or multiple
                   6366:       <code class="varname">PATCHFILES</code> from different sites, you can
                   6367:       set
                   6368:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   6369:       to the list of URLs where the file
                   6370:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   6371:       (including the suffix) can be found.</p>
                   6372: <pre class="programlisting">
1.100     rillig   6373: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   6374: DISTFILES+=     foo-file.tar.gz
                   6375: SITES.foo-file.tar.gz= \
                   6376: http://www.somewhere.com/somehow/ \
                   6377: http://www.somewhereelse.com/mirror/somehow/
                   6378: </pre>
1.81      rillig   6379: <p>When actually fetching the distfiles, each item from
1.88      wiz      6380:       <code class="varname">MASTER_SITES</code> or
                   6381:       <code class="varname">SITES.*</code> gets the name of each distfile
                   6382:       appended to it, without an intermediate slash. Therefore,
                   6383:       all site values have to end with a slash or other separator
                   6384:       character. This allows for example to set
                   6385:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   6386:       that gets the name of the distfile as a parameter. In this
                   6387:       case, the definition would look like:</p>
1.81      rillig   6388: <pre class="programlisting">
1.100     rillig   6389: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   6390: </pre>
1.125     wiz      6391: <p> The exception to this rule are URLs starting with a dash.
1.174     asau     6392:       In that case the URL is taken as is, fetched and the result
                   6393:       stored under the name of the distfile. You can use this style
                   6394:       for the case when the download URL style does not match the
                   6395:       above common case. For example, if permanent download URL is a
                   6396:       redirector to the real download URL, or the download file name
                   6397:       is offered by an HTTP Content-Disposition header. In the
                   6398:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   6399:       created instead of the default
                   6400:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   6401: <pre class="programlisting">
                   6402: DISTNAME=       foo-1.0.0
                   6403: MASTER_SITES=   -http://www.example.com/archive/v1.0.0.tar.gz
                   6404: </pre>
1.81      rillig   6405: <p>There are some predefined values for
1.88      wiz      6406:       <code class="varname">MASTER_SITES</code>, which can be used in
                   6407:       packages.  The names of the variables should speak for
                   6408:       themselves.</p>
                   6409: <pre class="programlisting">
1.100     rillig   6410: ${MASTER_SITE_APACHE}
                   6411: ${MASTER_SITE_BACKUP}
                   6412: ${MASTER_SITE_CYGWIN}
                   6413: ${MASTER_SITE_DEBIAN}
                   6414: ${MASTER_SITE_FREEBSD}
                   6415: ${MASTER_SITE_FREEBSD_LOCAL}
                   6416: ${MASTER_SITE_GENTOO}
                   6417: ${MASTER_SITE_GNOME}
                   6418: ${MASTER_SITE_GNU}
                   6419: ${MASTER_SITE_GNUSTEP}
1.174     asau     6420: ${MASTER_SITE_HASKELL_HACKAGE}
1.100     rillig   6421: ${MASTER_SITE_IFARCHIVE}
                   6422: ${MASTER_SITE_KDE}
                   6423: ${MASTER_SITE_MOZILLA}
1.174     asau     6424: ${MASTER_SITE_MOZILLA_ALL}
                   6425: ${MASTER_SITE_MOZILLA_ESR}
1.100     rillig   6426: ${MASTER_SITE_MYSQL}
1.174     asau     6427: ${MASTER_SITE_NETLIB}
1.100     rillig   6428: ${MASTER_SITE_OPENOFFICE}
1.208     ryoon    6429: ${MASTER_SITE_OSDN}
1.100     rillig   6430: ${MASTER_SITE_PERL_CPAN}
                   6431: ${MASTER_SITE_PGSQL}
1.174     asau     6432: ${MASTER_SITE_RUBYGEMS}
1.100     rillig   6433: ${MASTER_SITE_R_CRAN}
                   6434: ${MASTER_SITE_SOURCEFORGE}
                   6435: ${MASTER_SITE_SUNSITE}
                   6436: ${MASTER_SITE_SUSE}
                   6437: ${MASTER_SITE_TEX_CTAN}
                   6438: ${MASTER_SITE_XCONTRIB}
                   6439: ${MASTER_SITE_XEMACS}
1.174     asau     6440: ${MASTER_SITE_XORG}
1.100     rillig   6441: </pre>
1.88      wiz      6442: <p>Some explanations for the less self-explaining ones:
                   6443:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133     wiz      6444:       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
1.132     spz      6445:       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>
1.88      wiz      6446: <p>If you choose one of these predefined sites, you may
                   6447:       want to specify a subdirectory of that site. Since these
                   6448:       macros may expand to more than one actual site, you
                   6449:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6450:       specify a subdirectory:</p>
1.81      rillig   6451: <pre class="programlisting">
1.100     rillig   6452: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6453: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6454: </pre>
1.81      rillig   6455: <p>Note the trailing slash after the subdirectory
1.88      wiz      6456:       name.</p>
1.81      rillig   6457: </div>
1.148     asau     6458: <div class="sect2">
1.81      rillig   6459: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   6460: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6461: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6462:       all the distfiles exist in a local directory
1.93      rillig   6463:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6464:       user). If the files do not exist, they are fetched using
                   6465:       commands of the form</p>
1.75      rillig   6466: <pre class="programlisting">
1.100     rillig   6467: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6468: </pre>
1.88      wiz      6469: <p>where <code class="literal">${site}</code> varies through
                   6470:       several possibilities in turn: first,
                   6471:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6472:       sites specified in either <code class="varname">SITES.file</code> if
                   6473:       defined, else <code class="varname">MASTER_SITES</code> or
                   6474:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6475:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6476:       all except the first and the last can be optionally sorted
                   6477:       by the user, via setting either
                   6478:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6479:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6480:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  6481: <p> The specific command and arguments used depend on the
                   6482:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6483:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   6484: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6485:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6486:       distfiles, if they are freely distributable.  Packages setting
                   6487:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128     wiz      6488:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.97      rillig   6489:       mirrored.</p>
1.81      rillig   6490: </div>
1.75      rillig   6491: </div>
1.148     asau     6492: <div class="sect1">
1.75      rillig   6493: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6494: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6495: <p>After the distfile(s) are fetched, their checksum is
                   6496:     generated and compared with the checksums stored in the
                   6497:     distinfo file. If the checksums don't match, the build is
                   6498:     aborted. This is to ensure the same distfile is used for
                   6499:     building, and that the distfile wasn't changed, e.g. by some
                   6500:     malign force, deliberately changed distfiles on the master
                   6501:     distribution site or network lossage.</p>
1.75      rillig   6502: </div>
1.148     asau     6503: <div class="sect1">
1.75      rillig   6504: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6505: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6506: <p>When the distfiles are present on the local system, they
1.88      wiz      6507:     need to be extracted, as they usually come in the form of some
                   6508:     compressed archive format.</p>
1.75      rillig   6509: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6510:     extracted. If you only need some of them, you can set the
                   6511:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6512:     files.</p>
                   6513: <p>Extracting the files is usually done by a little
1.93      rillig   6514:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6515:     already knows how to extract various archive formats, so most
                   6516:     likely you will not need to change anything here. But if you
                   6517:     need, the following variables may help you:</p>
1.148     asau     6518: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6519: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6520: <dd><p>Use these variables to override the default
1.88      wiz      6521:       options for an extract command, which are defined in
1.93      rillig   6522:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6523: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6524: <dd><p>This variable can be set to
1.114     jmcneill 6525:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6526:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      6527:       absolute pathname pointing to the command with which tar
1.114     jmcneill 6528:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6529:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   6530: </dl></div>
1.88      wiz      6531: <p>If the <code class="filename">extract</code> program doesn't
                   6532:     serve your needs, you can also override the
                   6533:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6534:     command used for extracting the files. This command is
                   6535:     executed in the <code class="filename">${WRKSRC}</code>
                   6536:     directory. During execution of this command, the shell
                   6537:     variable <code class="varname">extract_file</code> holds the absolute
                   6538:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6539: <p>And if that still does not suffice, you can override the
1.88      wiz      6540:     <code class="varname">do-extract</code> target in the package
                   6541:     Makefile.</p>
1.75      rillig   6542: </div>
1.148     asau     6543: <div class="sect1">
1.75      rillig   6544: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6545: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6546: <p>After extraction, all the patches named by the
1.88      wiz      6547:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6548:     subdirectory of the package as well as in
                   6549:     $LOCALPATCHES/$PKGPATH (e.g.
                   6550:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6551:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6552:     <code class="filename">.gz</code> are uncompressed before they are
                   6553:     applied, files ending in <code class="filename">.orig</code> or
                   6554:     <code class="filename">.rej</code> are ignored. Any special options to
1.189     snj      6555:     <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
1.219   ! rillig   6556:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="11.3. patches/*">Section 11.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more details.</p>
1.189     snj      6557: <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
1.88      wiz      6558:     it fail if the patches apply with some lines of fuzz. Please
                   6559:     fix (regen) the patches so that they apply cleanly. The
                   6560:     rationale behind this is that patches that don't apply cleanly
                   6561:     may end up being applied in the wrong place, and cause severe
                   6562:     harm there.</p>
1.75      rillig   6563: </div>
1.148     asau     6564: <div class="sect1">
1.75      rillig   6565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6566: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.110     hubertf  6567: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.88      wiz      6568:     </p>
1.75      rillig   6569: </div>
1.148     asau     6570: <div class="sect1">
1.75      rillig   6571: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6572: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6573: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6574:     linkers. The following variables can be used to tweak the
                   6575:     wrappers.</p>
1.148     asau     6576: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6577: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6578: <dd><p>The command used to print progress
1.88      wiz      6579:       messages. Does nothing by default. Set to
                   6580:       <code class="literal">${ECHO}</code> to see the progress
                   6581:       messages.</p></dd>
1.75      rillig   6582: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6583: <dd><p>This variable can be set to
1.88      wiz      6584:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6585:       depending on whether you want additional information in the
                   6586:       wrapper log file.</p></dd>
1.75      rillig   6587: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6588: <dd><p>This variable can be set to
1.88      wiz      6589:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6590:       on whether the wrapper should use its cache, which will
                   6591:       improve the speed. The default value is
                   6592:       <code class="literal">yes</code>, but is forced to
                   6593:       <code class="literal">no</code> if the platform does not support
                   6594:       it.</p></dd>
1.75      rillig   6595: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6596: <dd><p>A list of reordering commands. A reordering
                   6597:       command has the form
                   6598:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6599:       It ensures that that
                   6600:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6601:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6602:       </p></dd>
1.75      rillig   6603: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6604: <dd><p>A list of transformation commands. [TODO:
1.88      wiz      6605:       investigate further]</p></dd>
1.75      rillig   6606: </dl></div>
                   6607: </div>
1.148     asau     6608: <div class="sect1">
1.75      rillig   6609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6610: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6611: <p>Most pieces of software need information on the header
                   6612:     files, system calls, and library routines which are available
                   6613:     on the platform they run on. The process of determining this
                   6614:     information is known as configuration, and is usually
                   6615:     automated. In most cases, a script is supplied with the
                   6616:     distfiles, and its invocation results in generation of header
                   6617:     files, Makefiles, etc.</p>
                   6618: <p>If the package contains a configure script, this can be
                   6619:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128     wiz      6620:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.88      wiz      6621:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128     wiz      6622:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.88      wiz      6623:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6624: <pre class="programlisting">
1.100     rillig   6625: .for d in ${CONFIGURE_DIRS}
                   6626:         cd ${WRKSRC} \
                   6627:         &amp;&amp; cd ${d} \
                   6628:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6629: .endfor
                   6630: </pre>
1.88      wiz      6631: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128     wiz      6632:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6633:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6634:     configure script is run with the environment
                   6635:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6636:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6637:     <code class="varname">CONFIGURE_ENV</code>,
                   6638:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128     wiz      6639:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.88      wiz      6640:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6641:     package.</p>
1.144     wiz      6642: <p>If the program uses the Perl way of configuration (mainly Perl
                   6643:     modules, but not only), i.e. a file called
                   6644:     <code class="filename">Makefile.PL</code>, it should include
                   6645:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6646:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6647:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88      wiz      6648: <p>If the program uses an <code class="filename">Imakefile</code>
                   6649:     for configuration, the appropriate steps can be invoked by
                   6650:     setting <code class="varname">USE_IMAKE</code> to
1.209     sevan    6651:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
                   6652:     You can add variables to xmkmf's environment by adding them to the
1.97      rillig   6653:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   6654: <p>If the program uses <code class="filename">cmake</code>
                   6655:     for configuration, the appropriate steps can be invoked by
1.128     wiz      6656:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.111     rillig   6657:     You can add variables to cmake's environment by adding them to the
                   6658:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6659:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6660:     The top directory argument is given by the
                   6661:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128     wiz      6662:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   6663: <p>If there is no configure step at all, set
1.128     wiz      6664:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6665: </div>
1.148     asau     6666: <div class="sect1">
1.75      rillig   6667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6668: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6669: <p>For building a package, a rough equivalent of the
                   6670:     following code is executed.</p>
1.75      rillig   6671: <pre class="programlisting">
1.100     rillig   6672: .for d in ${BUILD_DIRS}
                   6673:         cd ${WRKSRC} \
                   6674:         &amp;&amp; cd ${d} \
                   6675:         &amp;&amp; env ${MAKE_ENV} \
                   6676:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6677:                 -f ${MAKE_FILE} \
                   6678:                 ${BUILD_TARGET}
                   6679: .endfor
                   6680: </pre>
1.88      wiz      6681: <p><code class="varname">BUILD_DIRS</code> (default:
1.128     wiz      6682:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6683:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6684:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6685:     <code class="varname">MAKE_ENV</code> and arguments
                   6686:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6687:     <code class="varname">MAKE_ENV</code>,
                   6688:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6689:     <code class="varname">MAKE_FILE</code> and
                   6690:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6691:     package.</p>
1.75      rillig   6692: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128     wiz      6693:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6694:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
1.88      wiz      6695:     default value of <code class="varname">MAKE_FILE</code> is
1.128     wiz      6696:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6697:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.97      rillig   6698: <p>If there is no build step at all, set
1.128     wiz      6699:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6700: </div>
1.148     asau     6701: <div class="sect1">
1.75      rillig   6702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6703: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6704: <p>[TODO]</p>
                   6705: </div>
1.148     asau     6706: <div class="sect1">
1.75      rillig   6707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6708: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6709: <p>Once the build stage has completed, the final step is to
1.88      wiz      6710:     install the software in public directories, so users can
                   6711:     access the programs and files.</p>
1.75      rillig   6712: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6713:     equivalent of the following code is executed. Additionally,
                   6714:     before and after this code, much magic is performed to do
                   6715:     consistency checks, registering the package, and so on.</p>
                   6716: <pre class="programlisting">
1.100     rillig   6717: .for d in ${INSTALL_DIRS}
                   6718:         cd ${WRKSRC} \
                   6719:         &amp;&amp; cd ${d} \
                   6720:         &amp;&amp; env ${MAKE_ENV} \
                   6721:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6722:                 -f ${MAKE_FILE} \
                   6723:                 ${INSTALL_TARGET}
                   6724: .endfor
                   6725: </pre>
1.75      rillig   6726: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6727:     <span class="emphasis"><em>build</em></span> phase.
                   6728:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6729:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128     wiz      6730:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6731:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.88      wiz      6732:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6733:     defined.</p>
1.75      rillig   6734: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6735:     variables are useful. They are all variations of the
1.189     snj      6736:     <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
1.88      wiz      6737:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6738:     install command. The specialized variants, together with their
                   6739:     intended use, are:</p>
1.148     asau     6740: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6741: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6742: <dd><p>directories that contain
                   6743:       binaries</p></dd>
1.75      rillig   6744: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6745: <dd><p>directories that contain
                   6746:       scripts</p></dd>
1.75      rillig   6747: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6748: <dd><p>directories that contain shared and static
                   6749:       libraries</p></dd>
1.75      rillig   6750: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6751: <dd><p>directories that contain data
                   6752:       files</p></dd>
1.75      rillig   6753: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6754: <dd><p>directories that contain man
                   6755:       pages</p></dd>
1.210     leot     6756: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6757: <dd><p>directories that contain data files for games
                   6758:       </p></dd>
1.75      rillig   6759: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6760: <dd><p>binaries that can be stripped from debugging
                   6761:       symbols</p></dd>
1.75      rillig   6762: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6763: <dd><p>binaries that cannot be
                   6764:       stripped</p></dd>
1.75      rillig   6765: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6766: <dd><p>game
                   6767:       binaries</p></dd>
1.75      rillig   6768: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6769: <dd><p>shared and static
                   6770:       libraries</p></dd>
1.75      rillig   6771: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6772: <dd><p>data files</p></dd>
                   6773: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6774: <dd><p>data files for
                   6775:       games</p></dd>
1.75      rillig   6776: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6777: <dd><p>man pages</p></dd>
                   6778: </dl></div>
                   6779: <p>Some other variables are:</p>
1.148     asau     6780: <div class="variablelist"><dl class="variablelist">
1.216     tnn      6781: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
                   6782: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?strip+1+NetBSD-5.0.1+i386"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
                   6783:       when installing binaries. Any debugging sections and symbols present in
                   6784:       binaries will be preserved.
                   6785:       </p></dd>
1.75      rillig   6786: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6787: <dd><p>A list of directories relative to
1.88      wiz      6788:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      6789:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6790:       The package is supposed to create all needed directories itself
                   6791:       before installing files to it and list all other directories here.
                   6792:       </p></dd>
1.75      rillig   6793: </dl></div>
1.97      rillig   6794: <p>In the rare cases that a package shouldn't install anything,
1.128     wiz      6795:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.97      rillig   6796:     mostly relevant for packages in the <code class="filename">regress</code>
                   6797:     category.</p>
1.75      rillig   6798: </div>
1.148     asau     6799: <div class="sect1">
1.75      rillig   6800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6801: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      6802: <p>Once the install stage has completed, a binary package of
                   6803:     the installed files can be built.  These binary packages can be
                   6804:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  6805:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6806:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      6807: <p>By default, the binary packages are created in
                   6808:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6809:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6810:     one for each category in the <code class="varname">CATEGORIES</code>
                   6811:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6812:     <code class="filename">pkgsrc/packages</code>.</p>
                   6813: </div>
1.148     asau     6814: <div class="sect1">
1.88      wiz      6815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6816: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.88      wiz      6817: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  6818:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      6819:     to clean the work directories of all dependencies too, use
1.110     hubertf  6820:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   6821: </div>
1.148     asau     6822: <div class="sect1">
1.75      rillig   6823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   6824: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.148     asau     6825: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6826: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      6827: <dd><p>For any of the main targets described in the
                   6828:          previous section, two auxiliary targets exist with
1.128     wiz      6829:          <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
1.87      wiz      6830:          prefix for the main target's name.  These targets are
1.88      wiz      6831:          invoked before and after the main target is called,
                   6832:          allowing extra configuration or installation steps be
                   6833:          performed from a package's Makefile, for example, which
                   6834:          a program's configure script or install target
                   6835:          omitted.</p></dd>
1.75      rillig   6836: <dt><span class="term">do-*</span></dt>
1.88      wiz      6837: <dd><p>Should one of the main targets do the wrong thing,
                   6838:          and should there be no variable to fix this, you can
                   6839:          redefine it with the do-* target.  (Note that redefining
                   6840:          the target itself instead of the do-* target is a bad
                   6841:          idea, as the pre-* and post-* targets won't be called
                   6842:          anymore, etc.) You will not usually need to do
                   6843:          this.</p></dd>
1.75      rillig   6844: <dt><span class="term">reinstall</span></dt>
1.88      wiz      6845: <dd>
1.110     hubertf  6846: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      6847:          you noticed some file was not installed properly, you
                   6848:          can repeat the installation with this target, which will
1.128     wiz      6849:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.88      wiz      6850: <p>This is the default value of
                   6851:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  6852:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      6853:          package</strong></span>, where the defaults are
1.128     wiz      6854:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
1.88      wiz      6855:          respectively.</p>
                   6856: </dd>
1.75      rillig   6857: <dt><span class="term">deinstall</span></dt>
                   6858: <dd>
1.189     snj      6859: <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
1.88      wiz      6860:          current directory, effectively de-installing the
                   6861:          package. The following variables can be used to tune the
                   6862:          behaviour:</p>
1.148     asau     6863: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6864: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.189     snj      6865: <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>
1.75      rillig   6866: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      6867: <dd><p>Remove all packages that require (depend on)
                   6868:                the given package.  This can be used to remove any
                   6869:                packages that may have been pulled in by a given
1.110     hubertf  6870:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      6871:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      6872:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6873:                likely to remove whole KDE. Works by adding
1.189     snj      6874:                <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>
1.88      wiz      6875:                command line.</p></dd>
1.75      rillig   6876: </dl></div>
                   6877: </dd>
1.88      wiz      6878: <dt><span class="term">bin-install</span></dt>
                   6879: <dd><p>Install a binary package from local disk and via FTP
                   6880:          from a list of sites (see the
                   6881:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  6882:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      6883:          available anywhere.  The arguments given to
1.110     hubertf  6884:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      6885:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6886:          operation, etc.</p></dd>
1.205     wiz      6887: <dt><span class="term">install-clean</span></dt>
                   6888: <dd><p>This target removes the state files for the "install" and later
                   6889:          phases so that the "install" target may be re-invoked. This can be
                   6890:          used after editing the PLIST to install the package without
                   6891:          rebuilding it.</p></dd>
                   6892: <dt><span class="term">build-clean</span></dt>
                   6893: <dd><p>This target removes the state files for the "build" and later
                   6894:          phases so that the "build" target may be re-invoked.</p></dd>
1.75      rillig   6895: <dt><span class="term">update</span></dt>
                   6896: <dd>
1.88      wiz      6897: <p>This target causes the current package to be
                   6898:          updated to the latest version.  The package and all
                   6899:          depending packages first get de-installed, then current
                   6900:          versions of the corresponding packages get compiled and
                   6901:          installed.  This is similar to manually noting which
                   6902:          packages are currently installed, then performing a
1.110     hubertf  6903:          series of <span class="command"><strong>make deinstall</strong></span> and
                   6904:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      6905:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   6906:          packages.</p>
1.128     wiz      6907: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.110     hubertf  6908:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      6909:          update</strong></span> was interrupted for some reason.
                   6910:          However, in this case, make sure you don't call
1.110     hubertf  6911:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      6912:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   6913:          Otherwise, you lose the ability to automatically update
                   6914:          the current package along with the dependent packages
                   6915:          you have installed.</p>
1.110     hubertf  6916: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      6917:          update</strong></span> will only work as long as the package
                   6918:          tree remains unchanged.  If the source code for one of
                   6919:          the packages to be updated has been changed, resuming
1.110     hubertf  6920:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      6921:          fail!</p>
                   6922: <p>The following variables can be used either on the
1.110     hubertf  6923:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   6924:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      6925:          update</strong></span>:</p>
1.148     asau     6926: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6927: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      6928: <dd><p>Install target to recursively use for the
                   6929:                updated package and the dependent packages.
                   6930:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128     wiz      6931:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.110     hubertf  6932:                <span class="command"><strong>make update</strong></span>.  Other good
1.128     wiz      6933:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   6934:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   6935:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.88      wiz      6936:                endless loop!</p></dd>
1.75      rillig   6937: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      6938: <dd><p>Don't clean up after updating.  Useful if
                   6939:                you want to leave the work sources of the updated
                   6940:                packages around for inspection or other purposes.
                   6941:                Be sure you eventually clean up the source tree
1.128     wiz      6942:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.88      wiz      6943:                or you may run into troubles with old source code
                   6944:                still lying around on your next
1.110     hubertf  6945:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      6946:                update</strong></span>.</p></dd>
1.75      rillig   6947: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      6948: <dd><p>Deinstall each package before installing
                   6949:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   6950:                may be necessary if the
1.128     wiz      6951:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.110     hubertf  6952:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      6953:                update</strong></span>.</p></dd>
1.75      rillig   6954: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      6955: <dd><p>Allows you to disable recursion and hardcode
                   6956:                the target for packages.  The default is
1.128     wiz      6957:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.88      wiz      6958:                facilitating a recursive update of prerequisite
                   6959:                packages.  Only set
                   6960:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   6961:                disable recursive updates. Use
                   6962:                <code class="varname">UPDATE_TARGET</code> instead to just
                   6963:                set a specific target for each package to be
1.110     hubertf  6964:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      6965:                (see above).</p></dd>
1.75      rillig   6966: </dl></div>
                   6967: </dd>
                   6968: <dt><span class="term">clean-update</span></dt>
                   6969: <dd>
1.88      wiz      6970: <p>Clean the source tree for all packages that would
1.110     hubertf  6971:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      6972:          from the current directory.  This target should not be
                   6973:          used if the current package (or any of its depending
                   6974:          packages) have already been de-installed (e.g., after
1.110     hubertf  6975:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      6976:          some packages you intended to update. As a rule of
                   6977:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  6978:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      6979:          and only if you have a dirty package tree (e.g., if you
                   6980:          used <code class="varname">NOCLEAN</code>).</p>
                   6981: <p>If you are unsure about whether your tree is
1.110     hubertf  6982:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      6983:          clean</strong></span> at the top of the tree, or use the
                   6984:          following sequence of commands from the directory of the
                   6985:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  6986:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      6987:          time, otherwise you lose all the packages you wanted to
                   6988:          update!):</p>
1.87      wiz      6989: <pre class="screen">
                   6990: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   6991: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      6992: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   6993:          </pre>
1.88      wiz      6994: <p>The following variables can be used either on the
1.110     hubertf  6995:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   6996:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.148     asau     6997: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6998: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  6999: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      7000:                reconstruct the list of directories to update for
1.110     hubertf  7001:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      7002:                update</strong></span> successfully installed all
                   7003:                packages you wanted to update.  Normally, this is
1.110     hubertf  7004:                done automatically on <span class="command"><strong>make
1.88      wiz      7005:                update</strong></span>, but may have been suppressed by
                   7006:                the <code class="varname">NOCLEAN</code> variable (see
                   7007:                above).</p></dd>
1.75      rillig   7008: </dl></div>
                   7009: </dd>
1.88      wiz      7010: <dt><span class="term">replace</span></dt>
                   7011: <dd>
                   7012: <p>Update the installation of the current package.  This
                   7013:          differs from update in that it does not replace dependent
1.189     snj      7014:          packages.  You will need to install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.88      wiz      7015:          target to work.</p>
                   7016: <p><span class="emphasis"><em>Be careful when using this
                   7017:          target!</em></span> There are no guarantees that dependent
                   7018:          packages will still work, in particular they will most
1.110     hubertf  7019:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      7020:          library package whose shared library major version changed
                   7021:          between your installed version and the new one.  For this
                   7022:          reason, this target is not officially supported and only
                   7023:          recommended for advanced users.</p>
                   7024: </dd>
1.75      rillig   7025: <dt><span class="term">info</span></dt>
1.189     snj      7026: <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
1.88      wiz      7027:          package. You can use this to check which version of a
                   7028:          package is installed.</p></dd>
                   7029: <dt><span class="term">index</span></dt>
                   7030: <dd>
                   7031: <p>This is a top-level command, i.e. it should be used in
                   7032:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   7033:          database of all packages in the local pkgsrc tree, including
                   7034:          dependencies, comment, maintainer, and some other useful
                   7035:          information.  Individual entries are created by running
1.110     hubertf  7036:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      7037:          directories.  This index file is saved as
                   7038:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  7039:          verbose format by running <span class="command"><strong>make
1.88      wiz      7040:          print-index</strong></span>.  You can search in it with
1.110     hubertf  7041:          <span class="command"><strong>make search
1.88      wiz      7042:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   7043:          extract a list of all packages that depend on a particular
1.110     hubertf  7044:          one by running <span class="command"><strong>make show-deps
1.88      wiz      7045:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   7046: <p>Running this command takes a very long time, some
                   7047:          hours even on fast machines!</p>
                   7048: </dd>
1.75      rillig   7049: <dt><span class="term">readme</span></dt>
1.88      wiz      7050: <dd>
                   7051: <p>This target generates a
                   7052:          <code class="filename">README.html</code> file, which can be
1.189     snj      7053:          viewed using a browser such as <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.88      wiz      7054:          contain references to any packages which are in the
                   7055:          <code class="varname">PACKAGES</code> directory on the local
                   7056:          host. The generated files can be made to refer to URLs
                   7057:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   7058:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   7059:          wanted to generate <code class="filename">README.html</code>
                   7060:          files which pointed to binary packages on the local
                   7061:          machine, in the directory
                   7062:          <code class="filename">/usr/packages</code>, set
                   7063:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   7064:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   7065:          <code class="varname">${PACKAGES}</code> directory and its
                   7066:          subdirectories will be searched for all the binary
                   7067:          packages.</p>
                   7068: <p>The target can be run at the toplevel or in category
                   7069:          directories, in which case it descends recursively.</p>
                   7070: </dd>
1.75      rillig   7071: <dt><span class="term">readme-all</span></dt>
1.88      wiz      7072: <dd><p>This is a top-level command, run it in
                   7073:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   7074:          file <code class="filename">README-all.html</code> which contains a
                   7075:          list of all packages currently available in the NetBSD
                   7076:          Packages Collection, together with the category they belong
                   7077:          to and a short description. This file is compiled from the
                   7078:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  7079:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      7080:          readme</strong></span>.</p></dd>
1.75      rillig   7081: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      7082: <dd><p>This is very much the same as the
1.128     wiz      7083:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.88      wiz      7084:          used when generating a pkgsrc tree to be written to a
                   7085:          CD-ROM.  This target also produces
                   7086:          <code class="filename">README.html</code> files, and can be made
                   7087:          to refer to URLs based on
                   7088:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      7089:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   7090: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      7091: <dd><p>This target shows which distfiles and patchfiles
                   7092:          are needed to build the package
                   7093:          (<code class="varname">ALLFILES</code>, which contains all
                   7094:          <code class="varname">DISTFILES</code> and
1.87      wiz      7095:          <code class="varname">PATCHFILES</code>, but not
                   7096:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   7097: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      7098: <dd><p>This target shows nothing if the package is not
                   7099:          installed. If a version of this package is installed,
                   7100:          but is not the version provided in this version of
                   7101:          pkgsrc, then a warning message is displayed. This target
                   7102:          can be used to show which of your installed packages are
                   7103:          downlevel, and so the old versions can be deleted, and
                   7104:          the current ones added.</p></dd>
1.75      rillig   7105: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      7106: <dd><p>This target shows the directory in the pkgsrc
                   7107:          hierarchy from which the package can be built and
                   7108:          installed. This may not be the same directory as the one
                   7109:          from which the package was installed. This target is
                   7110:          intended to be used by people who may wish to upgrade
                   7111:          many packages on a single host, and can be invoked from
                   7112:          the top-level pkgsrc Makefile by using the
1.128     wiz      7113:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.75      rillig   7114: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      7115: <dd><p>This target shows which installed packages match
                   7116:          the current package's <code class="varname">DEPENDS</code>. Useful
                   7117:          if out of date dependencies are causing build
                   7118:          problems.</p></dd>
1.205     wiz      7119: <dt><span class="term">print-build-depends-list</span></dt>
                   7120: <dd><p>This target shows the list of packages that the current package
                   7121:            depends on for building.</p></dd>
                   7122: <dt><span class="term">print-run-depends-list</span></dt>
                   7123: <dd><p>This target shows the list of packages that the current package
                   7124:            depends on for running.</p></dd>
1.75      rillig   7125: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      7126: <dd><p>After a package is installed, check all its
                   7127:          binaries and (on ELF platforms) shared libraries to see
                   7128:          if they find the shared libs they need.  Run by default
1.110     hubertf  7129:          if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.75      rillig   7130: <dt><span class="term">print-PLIST</span></dt>
                   7131: <dd>
1.128     wiz      7132: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.88      wiz      7133:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  7134:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      7135:          -newer work/.extract_done</strong></span>.  An attempt is made
                   7136:          to care for shared libs etc., but it is
1.87      wiz      7137:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   7138:          result before putting it into
                   7139:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   7140:          diff the output of this command against an already
                   7141:          existing <code class="filename">PLIST</code> file.</p>
1.189     snj      7142: <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
1.88      wiz      7143:          other methods that don't update file access times, be
                   7144:          sure to add these files manually to your
1.128     wiz      7145:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   7146:          -newer</span>&#8221;</span> command used by this target won't catch
1.87      wiz      7147:          them!</p>
1.128     wiz      7148: <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
1.87      wiz      7149:          information on this target.</p>
1.75      rillig   7150: </dd>
                   7151: <dt><span class="term">bulk-package</span></dt>
                   7152: <dd>
1.88      wiz      7153: <p>Used to do bulk builds. If an appropriate binary
                   7154:          package already exists, no action is taken. If not, this
                   7155:          target will compile, install and package it (and its
                   7156:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.174     asau     7157:          properly. See <a class="xref" href="#bulk" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 7, <i>Creating binary packages for everything in pkgsrc (bulk
                   7158: builds)</i></a>).
1.88      wiz      7159:          After creating the binary package, the sources, the
                   7160:          just-installed package and its required packages are
                   7161:          removed, preserving free disk space.</p>
                   7162: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7163:          all packages installed on a system!</em></span></p>
1.75      rillig   7164: </dd>
                   7165: <dt><span class="term">bulk-install</span></dt>
                   7166: <dd>
1.88      wiz      7167: <p>Used during bulk-installs to install required
                   7168:          packages. If an up-to-date binary package is available,
1.189     snj      7169:          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,
1.110     hubertf  7170:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      7171:          but the installed binary won't be removed.</p>
1.88      wiz      7172: <p>A binary package is considered
1.128     wiz      7173:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.189     snj      7174:          <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>
1.148     asau     7175: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7176: <li class="listitem"><p>None of the package's files
1.88      wiz      7177:              (<code class="filename">Makefile</code>, ...) were modified
                   7178:              since it was built.</p></li>
1.128     wiz      7179: <li class="listitem"><p>None of the package's required (binary)
1.88      wiz      7180:              packages were modified since it was built.</p></li>
1.75      rillig   7181: </ul></div>
1.88      wiz      7182: <p><span class="emphasis"><em>Beware that this target may deinstall
                   7183:          all packages installed on a system!</em></span></p>
1.75      rillig   7184: </dd>
                   7185: </dl></div>
                   7186: </div>
                   7187: </div>
1.148     asau     7188: <div class="chapter">
1.75      rillig   7189: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7190: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.75      rillig   7191: <div class="toc">
                   7192: <p><b>Table of Contents</b></p>
1.210     leot     7193: <dl class="toc">
1.106     rillig   7194: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   7195: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   7196: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   7197: <dt><span class="sect1"><a href="#tools.questions">18.4. Questions regarding the tools</a></span></dt>
1.75      rillig   7198: </dl>
                   7199: </div>
1.87      wiz      7200: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   7201: by pkgsrc and also for individual packages to define what commands
                   7202: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   7203: or for later run-time of an installed packaged (such as
                   7204: <code class="varname">DEPENDS</code>).
                   7205: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      7206: package will not be used.</p>
                   7207: <p>When building a package, the replacement tools are
1.75      rillig   7208: made available in a directory (as symlinks or wrapper scripts)
                   7209: that is early in the executable search path. Just like the buildlink
1.87      wiz      7210: system, this helps with consistent builds.</p>
                   7211: <p>A tool may be needed to help build a specific package. For example,
                   7212: perl, GNU make (gmake) or yacc may be needed.</p>
                   7213: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   7214: tool may be inefficient for building a package with pkgsrc.
                   7215: For example, a package may need GNU awk, bison (instead of
1.87      wiz      7216: yacc) or a better sed.</p>
                   7217: <p>The tools used by a package can be listed by running
1.110     hubertf  7218: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     7219: <div class="sect1">
1.75      rillig   7220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7221: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      7222: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   7223: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  7224: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   7225: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   7226: These can be seen by running:
1.110     hubertf  7227: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      7228: <p>If a package needs a specific program to build
1.75      rillig   7229: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      7230: to define the tools needed.</p>
1.75      rillig   7231: </div>
1.148     asau     7232: <div class="sect1">
1.75      rillig   7233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7234: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.135     wiz      7235: <p>In the following examples, the :run means that it is needed at
                   7236: run-time (and becomes a DEPENDS).
1.75      rillig   7237: The default is a build dependency which can be set with
                   7238: :build. (So in this example, it is the same as gmake:build
1.87      wiz      7239: and pkg-config:build.)</p>
1.75      rillig   7240: <pre class="programlisting">
                   7241: USE_TOOLS+=     gmake perl:run pkg-config
                   7242: </pre>
1.87      wiz      7243: <p>When using the tools framework, a
1.75      rillig   7244: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   7245: which contains the full path to the appropriate tool. For example,
1.128     wiz      7246: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.87      wiz      7247: on Linux systems.</p>
                   7248: <p>If you always need a pkgsrc version of the
1.75      rillig   7249: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   7250: </p>
                   7251: </div>
1.148     asau     7252: <div class="sect1">
1.75      rillig   7253: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7254: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      7255: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   7256: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   7257: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   7258: the name of the common tools. For example:</p>
                   7259: <pre class="programlisting">
                   7260: .if exists(/usr/bin/bzcat)
                   7261: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   7262: .elif exists(/usr/bin/bzip2)
                   7263: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   7264: .endif
1.69      rillig   7265: 
1.75      rillig   7266: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   7267: </pre>
                   7268: </div>
1.148     asau     7269: <div class="sect1">
1.97      rillig   7270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7271: <a name="tools.questions"></a>18.4. Questions regarding the tools</h2></div></div></div>
1.148     asau     7272: <div class="qandaset">
1.219   ! rillig   7273: <a name="idm83808672"></a><dl>
1.106     rillig   7274: <dt>18.4.1. <a href="#tools.new">How do I add a new tool?</a>
1.97      rillig   7275: </dt>
1.106     rillig   7276: <dt>18.4.2. <a href="#tools.listall">How do I get a list of all available
1.97      rillig   7277:        tools?</a>
                   7278: </dt>
1.106     rillig   7279: <dt>18.4.3. <a href="#tools.used">How can I get a list of all the tools that a
1.97      rillig   7280:        package is using while being built? I want to know whether it
                   7281:        uses sed or not.</a>
                   7282: </dt>
                   7283: </dl>
1.148     asau     7284: <table border="0" style="width: 100%;">
                   7285: <colgroup>
1.97      rillig   7286: <col align="left" width="1%">
1.128     wiz      7287: <col>
1.148     asau     7288: </colgroup>
1.97      rillig   7289: <tbody>
1.148     asau     7290: <tr class="question">
1.97      rillig   7291: <td align="left" valign="top">
1.219   ! rillig   7292: <a name="tools.new"></a><a name="idm83808288"></a><p><b>18.4.1.</b></p>
1.97      rillig   7293: </td>
                   7294: <td align="left" valign="top"><p>How do I add a new tool?</p></td>
                   7295: </tr>
                   7296: <tr class="answer">
                   7297: <td align="left" valign="top"></td>
                   7298: <td align="left" valign="top"><p>TODO</p></td>
                   7299: </tr>
1.148     asau     7300: <tr class="question">
1.97      rillig   7301: <td align="left" valign="top">
1.219   ! rillig   7302: <a name="tools.listall"></a><a name="idm83807264"></a><p><b>18.4.2.</b></p>
1.97      rillig   7303: </td>
                   7304: <td align="left" valign="top"><p>How do I get a list of all available
                   7305:        tools?</p></td>
                   7306: </tr>
                   7307: <tr class="answer">
                   7308: <td align="left" valign="top"></td>
                   7309: <td align="left" valign="top"><p>TODO</p></td>
                   7310: </tr>
1.148     asau     7311: <tr class="question">
1.97      rillig   7312: <td align="left" valign="top">
1.219   ! rillig   7313: <a name="tools.used"></a><a name="idm83806240"></a><p><b>18.4.3.</b></p>
1.97      rillig   7314: </td>
                   7315: <td align="left" valign="top"><p>How can I get a list of all the tools that a
                   7316:        package is using while being built? I want to know whether it
                   7317:        uses sed or not.</p></td>
                   7318: </tr>
                   7319: <tr class="answer">
                   7320: <td align="left" valign="top"></td>
                   7321: <td align="left" valign="top"><p>Currently, you can't. (TODO: But I want to be able
                   7322:        to do it.)</p></td>
                   7323: </tr>
                   7324: </tbody>
                   7325: </table>
                   7326: </div>
                   7327: </div>
1.75      rillig   7328: </div>
1.148     asau     7329: <div class="chapter">
1.75      rillig   7330: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   7331: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.75      rillig   7332: <div class="toc">
                   7333: <p><b>Table of Contents</b></p>
1.210     leot     7334: <dl class="toc">
1.106     rillig   7335: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.75      rillig   7336: <dd><dl>
1.218     rillig   7337: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">19.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                   7338: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   7339: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   7340: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   7341: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   7342: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   7343: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   7344: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7345: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   7346: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7347: <dt><span class="sect2"><a href="#fixes.subst">19.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
1.106     rillig   7348: </dl></dd>
1.218     rillig   7349: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig   7350: <dd><dl>
                   7351: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7352: <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>
1.199     tnn      7353: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.106     rillig   7354: </dl></dd>
1.218     rillig   7355: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.106     rillig   7356: <dd><dl>
                   7357: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   7358: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7359: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   7360: </dl></dd>
                   7361: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   7362: <dd><dl>
                   7363: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   7364: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   7365: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.147     wiz      7366: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   7367: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.106     rillig   7368: </dl></dd>
1.218     rillig   7369: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.106     rillig   7370: <dd><dl>
                   7371: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7372: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.128     wiz      7373: <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>
1.106     rillig   7374: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   7375: </dl></dd>
1.218     rillig   7376: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.106     rillig   7377: <dd><dl>
                   7378: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   7379: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   7380: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   7381: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7382: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7383: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   7384: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   7385: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.107     rillig   7386: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.119     mishka   7387: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.106     rillig   7388: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   7389: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   7390: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   7391: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7392: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   7393: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   7394: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   7395: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.87      wiz      7396:     emulation</a></span></dt>
1.106     rillig   7397: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7398: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7399: </dl></dd>
1.106     rillig   7400: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7401: </dl>
                   7402: </div>
1.148     asau     7403: <div class="sect1">
1.75      rillig   7404: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   7405: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.78      rillig   7406: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   7407:   different platforms. As a result, it is important to ensure,
                   7408:   where possible, that packages in pkgsrc are portable. This
                   7409:   chapter mentions some particular details you should pay
                   7410:   attention to while working on pkgsrc.</p>
1.148     asau     7411: <div class="sect2">
1.78      rillig   7412: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7413: <a name="pulling-vars-from-etc-mk.conf"></a>19.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93      rillig   7414: </h3></div></div></div>
1.78      rillig   7415: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7416:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7417:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7418:     want to use those variables in the preprocessor directives of
1.189     snj      7419:     <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
1.87      wiz      7420:     <code class="literal">.for</code>), you need to include the file
                   7421:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7422:     loads the user preferences.</p>
1.78      rillig   7423: <p>But note that some variables may not be completely defined
1.219   ! rillig   7424:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
        !          7425:     included, as they may contain references to variables that are
        !          7426:     not yet defined. In shell commands (the lines in
        !          7427:     <code class="filename">Makefile</code> that are indented with a tab) this
        !          7428:     is no problem, since variables are only expanded when they are
        !          7429:     used. But in the preprocessor directives mentioned above and in
        !          7430:     dependency lines (of the form <code class="literal">target:
        !          7431:     dependencies</code>) the variables are expanded at load
        !          7432:     time.</p>
1.148     asau     7433: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7434: <h3 class="title">Note</h3>
1.218     rillig   7435: <p>To check whether a variable can be used at load time,
                   7436:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7437: </div>
                   7438: </div>
1.148     asau     7439: <div class="sect2">
1.78      rillig   7440: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7441: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.88      wiz      7442: <p>Occasionally, packages require interaction from the user,
                   7443:     and this can be in a number of ways:</p>
1.148     asau     7444: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7445: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7446:        interaction such as entering username/password or accepting a
                   7447:        license on a web page.</p></li>
1.128     wiz      7448: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7449:        passwords.</p></li>
1.128     wiz      7450: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7451: <li class="listitem"><p>help during the build process</p></li>
                   7452: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7453: </ul></div>
1.218     rillig   7454: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7455:     variable to define which stages need interaction. This should be
                   7456:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7457: <pre class="programlisting">
1.100     rillig   7458: INTERACTIVE_STAGE=      configure install
1.87      wiz      7459:     </pre>
1.88      wiz      7460: <p>The user can then decide to skip this package by setting the
1.218     rillig   7461:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7462:     are also excluded from bulk builds.</p>
1.75      rillig   7463: </div>
1.148     asau     7464: <div class="sect2">
1.75      rillig   7465: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7466: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.98      wiz      7467: <p>Authors of software can choose the licence under which
                   7468:     software can be copied.  This is due to copyright law, and reasons
                   7469:     for license choices are outside the scope of pkgsrc.  The pkgsrc
                   7470:     system recognizes that there are a number of licenses which some
                   7471:     users may find objectionable or difficult or impossible to comply
                   7472:     with.  The Free Software Foundation has declared some licenses
                   7473:     "Free", and the Open Source Initiative has a definition of "Open
1.219   ! rillig   7474:     Source".  The pkgsrc system, as a policy choice, does not label
        !          7475:     packages which have licenses that are Free or Open Source.
        !          7476:     However, packages without a license meeting either of those tests
        !          7477:     are labeled with a license tag denoting the license.  Note that a
        !          7478:     package with no license to copy trivially does not meet either the
        !          7479:     Free or Open Source test.</p>
1.98      wiz      7480: <p>For packages which are not Free or Open Source, pkgsrc will
                   7481:     not build the package unless the user has indicated to pkgsrc that
                   7482:     packages with that particular license may be built.  Note that
                   7483:     this documentation avoids the term "accepted the license".  The
                   7484:     pkgsrc system is merely providing a mechanism to avoid
1.99      rillig   7485:     accidentally building a package with a non-free license;
1.98      wiz      7486:     judgement and responsibility remain with the user.  (Installation
                   7487:     of binary packages are not currently subject to this mechanism;
                   7488:     this is a bug.)</p>
                   7489: <p>One might want to only install packages with a BSD license,
1.218     rillig   7490:     or the GPL, and not the other.  The free licenses are added to the
1.121     jnemeth  7491:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The
                   7492:     user can override the default by setting the
                   7493:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
                   7494:     of "+=".  The licenses accepted by default are:
                   7495:     </p>
                   7496: <pre class="programlisting">
1.154     rodent   7497:        apache-1.1 apache-2.0
                   7498:        arphic-public
                   7499:        artistic artistic-2.0
                   7500:        boost-license
                   7501:        cc-by-sa-v3.0
1.161     ryoon    7502:        cc0-1.0-universal
1.154     rodent   7503:        cddl-1.0
                   7504:        cpl-1.0
                   7505:        epl-v1.0
                   7506:        gnu-fdl-v1.1 gnu-fdl-v1.2 gnu-fdl-v1.3
                   7507:        gnu-gpl-v1
                   7508:        gnu-gpl-v2 gnu-lgpl-v2 gnu-lgpl-v2.1
                   7509:        gnu-gpl-v3 gnu-lgpl-v3
                   7510:        ibm-public-license-1.0
                   7511:        ipafont
                   7512:        isc
                   7513:        lppl-1.3c
                   7514:        lucent
                   7515:        miros
                   7516:        mit
                   7517:        mpl-1.0 mpl-1.1 mpl-2.0
                   7518:        mplusfont
                   7519:        ofl-v1.0 ofl-v1.1
                   7520:        original-bsd modified-bsd 2-clause-bsd
                   7521:        php
                   7522:        png-license
                   7523:        postgresql-license
                   7524:        public-domain
                   7525:        python-software-foundation
                   7526:        qpl-v1.0
1.158     rodent   7527:        sgi-free-software-b-v2.0
1.154     rodent   7528:        sleepycat-public
                   7529:        unlicense
                   7530:        x11
                   7531:        zlib
                   7532:        zpl
1.121     jnemeth  7533:     </pre>
                   7534: <p>
                   7535:     </p>
1.78      rillig   7536: <p>The license tag mechanism is intended to address
1.87      wiz      7537:     copyright-related issues surrounding building, installing and
                   7538:     using a package, and not to address redistribution issues (see
                   7539:     <code class="varname">RESTRICTED</code> and
1.121     jnemeth  7540:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).  
                   7541:     Packages with redistribution restrictions should set these
                   7542:     tags.</p>
1.98      wiz      7543: <p>Denoting that a package may be copied according to a
                   7544:     particular license is done by placing the license in
1.87      wiz      7545:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7546:     <code class="varname">LICENSE</code> variable to a string identifying the
1.189     snj      7547:     license, e.g. in <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7548: <pre class="programlisting">
1.100     rillig   7549: LICENSE=        xv-license
1.87      wiz      7550:     </pre>
                   7551: <p>When trying to build, the user will get a notice that the
1.98      wiz      7552:     package is covered by a license which has not been placed in the
                   7553:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7554: <pre class="programlisting">
1.100     rillig   7555: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7556: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7557: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7558: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7559: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7560: *** Error code 1
1.87      wiz      7561:     </pre>
1.110     hubertf  7562: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7563:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7564:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7565:     convey to pkgsrc that it should not in the future fail because of
                   7566:     that license:</p>
1.78      rillig   7567: <pre class="programlisting">
1.100     rillig   7568: ACCEPTABLE_LICENSES+=xv-license
1.87      wiz      7569:     </pre>
1.154     rodent   7570: <p>When adding a package with a new license, the following steps
                   7571:     are required:</p>
                   7572: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7573: <li class="listitem">
                   7574: <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>
                   7575: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7576: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7577: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.158     rodent   7578: <li class="listitem"><p>the ACCEPTABLE_LICENSES list in <code class="filename">pkgsrc/doc/guide/files/fixes.xml</code></p></li>
1.154     rodent   7579: </ul></div>
                   7580: <p>with the proper syntax as demonstrated in those files, respectively.</p>
                   7581: </li>
                   7582: <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>
                   7583: </ol></div>
1.98      wiz      7584: <p>When the license changes (in a way other than formatting),
                   7585:     please make sure that the new license has a different name (e.g.,
                   7586:     append the version number if it exists, or the date).  Just
                   7587:     because a user told pkgsrc to build programs under a previous
                   7588:     version of a license does not mean that pkgsrc should build
1.99      rillig   7589:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7590:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7591:     test is a mechanistic test of whether a particular text has been
                   7592:     approved by either of two bodies.</p>
1.78      rillig   7593: <p>The use of <code class="varname">LICENSE=shareware</code>,
1.98      wiz      7594:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7595:     is deprecated because it does not crisply refer to a particular
                   7596:     license text.  Another problem with such usage is that it does not
                   7597:     enable a user to tell pkgsrc to proceed for a single package
                   7598:     without also telling pkgsrc to proceed for all packages with that
                   7599:     tag.</p>
1.75      rillig   7600: </div>
1.148     asau     7601: <div class="sect2">
1.75      rillig   7602: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7603: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7604: <p>Some licenses restrict how software may be re-distributed.
1.98      wiz      7605:     Because a license tag is required unless the package is Free or
                   7606:     Open Source, all packages with restrictions should have license
                   7607:     tags.  By declaring the restrictions, package tools can
                   7608:     automatically refrain from e.g. placing binary packages on FTP
                   7609:     sites.</p>
                   7610: <p>There are four restrictions that may be encoded, which are
                   7611:     the cross product of sources (distfiles) and binaries not being
                   7612:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7613:     language in any license, and because non-Free licenses tend to be
                   7614:     different from each other, pkgsrc adopts a definition of FTP and
                   7615:     CD-ROM.  Pkgsrc uses "FTP" to mean that the source or binary file
                   7616:     should not be made available over the Internet at no charge.
                   7617:     Pkgsrc uses "CD-ROM" to mean that the source or binary may not be
                   7618:     made available on some kind of media, together with other source
                   7619:     and binary packages, and which is sold for a distribution charge.
                   7620:     </p>
                   7621: <p>In order to encode these restrictions, the package system
1.87      wiz      7622:     defines five make variables that can be set to note these
                   7623:     restrictions:</p>
1.148     asau     7624: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7625: <li class="listitem">
1.75      rillig   7626: <p><code class="varname">RESTRICTED</code></p>
                   7627: <p>This variable should be set whenever a restriction
1.87      wiz      7628:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7629:        string containing the reason for the restriction.  It should
                   7630:        be understood that those wanting to understand the restriction
                   7631:        will have to read the license, and perhaps seek advice of
                   7632:        counsel.</p>
1.75      rillig   7633: </li>
1.128     wiz      7634: <li class="listitem">
1.75      rillig   7635: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7636: <p>Binaries may not be placed on CD-ROM containing other
                   7637:        binary packages, for which a distribution charge may be made.
                   7638:        In this case, set this variable to
                   7639:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7640: </li>
1.128     wiz      7641: <li class="listitem">
1.75      rillig   7642: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7643: <p>Binaries may not made available on the Internet without
                   7644:        charge.  In this case, set this variable to
                   7645:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7646:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7647: </li>
1.128     wiz      7648: <li class="listitem">
1.75      rillig   7649: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7650: <p>Distfiles may not be placed on CD-ROM, together with
                   7651:        other distfiles, for which a fee may be charged.  In this
                   7652:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7653:        </p>
1.75      rillig   7654: </li>
1.128     wiz      7655: <li class="listitem">
1.75      rillig   7656: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7657: <p>Distfiles may not made available via FTP at no charge.
                   7658:        In this case, set this variable to
                   7659:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7660:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7661: </li>
                   7662: </ul></div>
1.139     wiz      7663: <p>Please note that packages will to be removed from pkgsrc
                   7664:     when the distfiles are not distributable and cannot be obtained
                   7665:     for a period of one full quarter branch. Packages with manual /
                   7666:     interactive fetch must have a maintainer and it is his/her
                   7667:     responsibility to ensure this.</p>
1.75      rillig   7668: </div>
1.148     asau     7669: <div class="sect2">
1.75      rillig   7670: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7671: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.75      rillig   7672: <p>Your package may depend on some other package being present
1.88      wiz      7673:     - and there are various ways of expressing this dependency.
                   7674:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7675:     <code class="varname">DEPENDS</code> definitions, the
                   7676:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7677:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7678:     to handle dependencies, and which uses the variables named above.
1.110     hubertf  7679:     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.75      rillig   7680: <p>The basic difference between the two variables is as
1.87      wiz      7681:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7682:     that pre-requisite in the binary package so it will be pulled in
                   7683:     when the binary package is later installed, whilst the
                   7684:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7685:     dependency that is only needed for building the package.</p>
1.75      rillig   7686: <p>This means that if you only need a package present whilst
1.87      wiz      7687:     you are building, it should be noted as a
                   7688:     <code class="varname">BUILD_DEPENDS</code>.</p>
1.75      rillig   7689: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
1.87      wiz      7690:     <code class="varname">DEPENDS</code> definition is:</p>
1.75      rillig   7691: <pre class="programlisting">
1.100     rillig   7692: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.87      wiz      7693:     </pre>
1.128     wiz      7694: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7695:     may include any of the wildcard version numbers recognized by
1.189     snj      7696:     <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>
1.128     wiz      7697: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7698: <li class="listitem">
1.75      rillig   7699: <p>If your package needs another package's binaries or
1.160     wiz      7700:        libraries to build and run, and if that package has a
1.87      wiz      7701:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7702: <pre class="programlisting">
1.100     rillig   7703: .include "../../graphics/jpeg/buildlink3.mk"
1.87      wiz      7704:        </pre>
1.75      rillig   7705: </li>
1.128     wiz      7706: <li class="listitem">
1.160     wiz      7707: <p>If your package needs another package's binaries or
                   7708:        libraries only for building, and if that package has a
                   7709:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7710: <pre class="programlisting">
                   7711: .include "../../graphics/jpeg/buildlink3.mk"
                   7712:        </pre>
                   7713: <p>but set
                   7714:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7715:        to make it a build dependency only. This case is rather
                   7716:        rare.</p>
                   7717: </li>
                   7718: <li class="listitem">
1.132     spz      7719: <p>If your package needs binaries from another package to build,
                   7720:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.75      rillig   7721: <pre class="programlisting">
1.132     spz      7722: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.87      wiz      7723:        </pre>
1.75      rillig   7724: </li>
1.132     spz      7725: <li class="listitem"><p>If your package needs a library with which to link and
                   7726:        there is no <code class="filename">buildlink3.mk</code> file
                   7727:        available, create one. Using
                   7728:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7729:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7730: <li class="listitem">
1.132     spz      7731: <p>If your package needs some executable to be able to run
                   7732:        correctly and if there's no
                   7733:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7734:        using the <code class="varname">DEPENDS</code> variable. The
1.189     snj      7735:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.132     spz      7736:        be able to execute the latex binary from the teTeX package
                   7737:        when it runs, and that is specified:</p>
1.75      rillig   7738: <pre class="programlisting">
1.132     spz      7739: DEPENDS+=        teTeX-[0-9]*:../../print/teTeX
1.87      wiz      7740:        </pre>
1.132     spz      7741: </li>
                   7742: <li class="listitem">
                   7743: <p>You can use wildcards in package dependencies. Note that
                   7744:        such wildcard dependencies are retained when creating binary
                   7745:        packages. The dependency is checked when installing the binary
                   7746:        package and any package which matches the pattern will be
                   7747:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7748: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7749:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7750:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7751:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7752: <p>Wildcards can also be used to specify that a package
1.87      wiz      7753:        will only build against a certain minimum version of a
                   7754:        pre-requisite:</p>
1.75      rillig   7755: <pre class="programlisting">
1.132     spz      7756: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.87      wiz      7757:        </pre>
1.132     spz      7758: <p>This means that the package will build using version 6.0
                   7759:        of ImageMagick or newer. Such a dependency may be warranted
                   7760:        if, for example, the command line options of an executable
                   7761:        have changed.</p>
                   7762: <p>If you need to depend on minimum versions of libraries,
                   7763:        see the buildlink section of the pkgsrc guide.</p>
1.75      rillig   7764: <p>For security fixes, please update the package
1.218     rillig   7765:        vulnerabilities file. See <a class="xref" href="#security-handling" title="19.1.9. Handling packages with security problems">Section 19.1.9, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      7766:        information.</p>
1.75      rillig   7767: </li>
                   7768: </ol></div>
                   7769: <p>If your package needs files from another package to build,
1.87      wiz      7770:     add the relevant distribution files to
                   7771:     <code class="varname">DISTFILES</code>, so they will be extracted
1.189     snj      7772:     automatically. See the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      7773:     (It relies on the jpeg sources being present in source form
                   7774:     during the build.)</p>
1.75      rillig   7775: </div>
1.148     asau     7776: <div class="sect2">
1.75      rillig   7777: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7778: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7779: <p>Your package may conflict with other packages a user might
1.87      wiz      7780:     already have installed on his system, e.g. if your package
1.88      wiz      7781:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7782:     tree or has the same <code class="varname">PKGNAME</code>.</p>
                   7783: <p>These cases are handled automatically by the packaging tools
                   7784:     at package installation time and do not need to be handled
                   7785:     manually.</p>
                   7786: <p>In case the conflicts can not be recognized automatically
                   7787:     (e.g., packages using the same config file location but no other
                   7788:     shared files), you can set <code class="varname">CONFLICTS</code> to a
1.87      wiz      7789:     space-separated list of packages (including version string) your
                   7790:     package conflicts with.</p>
1.190     wiz      7791: <p>For example, if both <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
                   7792:     and <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
                   7793:     use the same config file, you would set in
                   7794:     <code class="filename">foo/bar/Makefile</code>:</p>
1.87      wiz      7795: <pre class="programlisting">
1.190     wiz      7796: CONFLICTS=      baz-[0-9]*
1.87      wiz      7797:     </pre>
1.190     wiz      7798: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.75      rillig   7799: <pre class="programlisting">
1.190     wiz      7800: CONFLICTS=      bar-[0-9]*
1.87      wiz      7801:     </pre>
1.75      rillig   7802: </div>
1.148     asau     7803: <div class="sect2">
1.75      rillig   7804: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7805: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7806: <p>There are several reasons why a package might be
1.88      wiz      7807:     instructed to not build under certain circumstances.  If the
1.87      wiz      7808:     package builds and runs on most platforms, the exceptions
1.193     dholland 7809:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7810:     the package builds and runs on a small handful of platforms,
                   7811:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7812:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7813:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7814:     (OS-version-platform) that can use glob-style
                   7815:     wildcards.</p>
                   7816: <p>If a package is not appropriate for some platforms (as
                   7817:     oopposed to merely broken), a different set of variables should be
                   7818:     used as this affects failure reporting and statistics.
                   7819:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7820:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7821:     the package is appropriate for only a small handful of platforms
                   7822:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7823:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7824:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7825:     (OS-version-platform) that can use glob-style
                   7826:     wildcards.</p>
1.88      wiz      7827: <p>Some packages are tightly bound to a specific version of an
1.189     snj      7828:     operating system, e.g. LKMs or <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      7829:     backwards compatible with other versions of the OS, and should be
                   7830:     uploaded to a version specific directory on the FTP server.  Mark
                   7831:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7832:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7833:     the package system internals, but may be used in the
                   7834:     future.</p>
1.75      rillig   7835: <p>If the package should be skipped (for example, because it
1.87      wiz      7836:     provides functionality already provided by the system), set
1.88      wiz      7837:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7838:     the package should fail because some preconditions are not met,
                   7839:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7840:     message.</p>
1.75      rillig   7841: </div>
1.148     asau     7842: <div class="sect2">
1.75      rillig   7843: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7844: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7845: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7846:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7847:     be set in the package Makefile. This will be carried into any
                   7848:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7849:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.189     snj      7850:     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
1.128     wiz      7851:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7852: </div>
1.148     asau     7853: <div class="sect2">
1.75      rillig   7854: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7855: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7856: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7857:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7858:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7859:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7860: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7861:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7862:     course not necessary if the problem is fixed by using a newer
                   7863:     release of the software), and the pattern in the
                   7864:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7865: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7866:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7867: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7868:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7869: </div>
1.148     asau     7870: <div class="sect2">
1.75      rillig   7871: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7872: <a name="bumping-pkgrevision"></a>19.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   7873: <p>When making fixes to an existing package it can be useful
1.87      wiz      7874:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7875:     avoid conflicting with future versions by the original author, a
1.128     wiz      7876:     <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
1.87      wiz      7877:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7878:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7879:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7880: <pre class="programlisting">
1.100     rillig   7881: DISTNAME=       foo-17.42
                   7882: PKGREVISION=    9
1.87      wiz      7883:     </pre>
1.75      rillig   7884: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7885:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7886:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7887:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7888:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7889: <p>When a new release of the package is released, the
1.87      wiz      7890:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7891:     minor release of the above package, things should be like:</p>
1.75      rillig   7892: <pre class="programlisting">
1.100     rillig   7893: DISTNAME=       foo-17.43
1.87      wiz      7894:     </pre>
                   7895: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7896:     non-trivial change in the resulting binary package.  Without a
                   7897:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7898:     version installed has no way of knowing that their package is out
                   7899:     of date.  Thus, changes without increasing
                   7900:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7901:     trivial that no reasonable person would want to upgrade", and this
                   7902:     is the rough test for when increasing
                   7903:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7904:     changes that do not merit increasing
                   7905:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7906: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7907: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.114     jmcneill 7908:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.100     rillig   7909:       or comments in Makefile.</p></li>
1.128     wiz      7910: <li class="listitem"><p>
1.100     rillig   7911:       Changing build variables if the resulting binary package is the same.</p></li>
1.128     wiz      7912: <li class="listitem"><p>
1.100     rillig   7913:       Changing <code class="filename">DESCR</code>.</p></li>
1.128     wiz      7914: <li class="listitem"><p>
1.100     rillig   7915:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   7916: </ul></div>
1.87      wiz      7917: <p>Examples of changes that do merit an increase to
                   7918:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7919: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7920: <li class="listitem"><p>
1.100     rillig   7921:       Security fixes</p></li>
1.128     wiz      7922: <li class="listitem"><p>
1.100     rillig   7923:       Changes or additions to a patch file</p></li>
1.128     wiz      7924: <li class="listitem"><p>
1.100     rillig   7925:       Changes to the <code class="filename">PLIST</code></p></li>
1.128     wiz      7926: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.100     rillig   7927: </ul></div>
1.78      rillig   7928: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7929:     changes.</p>
1.75      rillig   7930: </div>
1.148     asau     7931: <div class="sect2">
1.79      rillig   7932: <div class="titlepage"><div><div><h3 class="title">
1.218     rillig   7933: <a name="fixes.subst"></a>19.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   7934: <p>When you want to replace the same text in multiple files
1.87      wiz      7935:     or when the replacement text varies, patches alone cannot help.
                   7936:     This is where the SUBST framework comes in. It provides an
                   7937:     easy-to-use interface for replacing text in files.
                   7938:     Example:</p>
                   7939: <pre class="programlisting">
1.100     rillig   7940: SUBST_CLASSES+=                 fix-paths
                   7941: SUBST_STAGE.fix-paths=          pre-configure
                   7942: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7943: SUBST_FILES.fix-paths=          src/*.c
                   7944: SUBST_FILES.fix-paths+=         scripts/*.sh
                   7945: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7946: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.87      wiz      7947:     </pre>
1.79      rillig   7948: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      7949:     that are used to identify the different SUBST blocks that are
                   7950:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7951:     important to always use the <code class="literal">+=</code> operator with
                   7952:     this variable. Otherwise some substitutions may be
                   7953:     skipped.</p>
1.79      rillig   7954: <p>The remaining variables of each SUBST block are
1.87      wiz      7955:     parameterized with the identifier from the first line
                   7956:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7957:     parameters to a function call.</p>
1.79      rillig   7958: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      7959:     which the replacement will take place. All combinations of
                   7960:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7961:     <code class="literal">post-</code> together with a phase name are
                   7962:     possible, though only few are actually used. Most commonly used
                   7963:     are <code class="literal">post-patch</code> and
                   7964:     <code class="literal">pre-configure</code>. Of these two,
                   7965:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  7966:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      7967:     have the state after applying the patches but before making any
                   7968:     other changes. This is especially useful when you are debugging
                   7969:     a package in order to create new patches for it. Similarly,
                   7970:     <code class="literal">post-build</code> is preferred over
                   7971:     <code class="literal">pre-install</code>, because the install phase should
                   7972:     generally be kept as simple as possible. When you use
                   7973:     <code class="literal">post-build</code>, you have the same files in the
                   7974:     working directory that will be installed later, so you can check
                   7975:     if the substitution has succeeded.</p>
1.79      rillig   7976: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      7977:     that is printed just before the substitution is done.</p>
1.79      rillig   7978: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      7979:     globbing patterns that specifies the files in which the
                   7980:     substitution will take place. The patterns are interpreted
                   7981:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   7982: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.189     snj      7983:     <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
1.87      wiz      7984:     command should be prefixed with <code class="literal">-e</code>, so that
                   7985:     all SUBST blocks look uniform.</p>
1.79      rillig   7986: <p>There are some more variables, but they are so seldomly
1.87      wiz      7987:     used that they are only documented in the
                   7988:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   7989: </div>
1.75      rillig   7990: </div>
1.148     asau     7991: <div class="sect1">
1.75      rillig   7992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   7993: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     7994: <div class="sect2">
1.75      rillig   7995: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   7996: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   7997: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  7998:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      7999:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8000:     with the name of each file to download as an argument, expecting
                   8001:     it to output the URL of the directory from which to download
1.189     snj      8002:     it. <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      8003:     example of this usage.</p>
1.75      rillig   8004: <p>If the download can't be automated, because the user must
1.87      wiz      8005:     submit personal information to apply for a password, or must pay
                   8006:     for the source, or whatever, you can set
                   8007:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8008:     displayed to the user before aborting the build. Example:</p>
                   8009: <pre class="programlisting">
1.100     rillig   8010: FETCH_MESSAGE=  "Please download the files"
                   8011: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8012: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.87      wiz      8013:     </pre>
1.75      rillig   8014: </div>
1.148     asau     8015: <div class="sect2">
1.75      rillig   8016: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8017: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   8018: <p>Sometimes authors of a software package make some
1.87      wiz      8019:     modifications after the software was released, and they put up a
                   8020:     new distfile without changing the package's version number. If a
                   8021:     package is already in pkgsrc at that time, the checksum will
                   8022:     no longer match. The contents of the new distfile should be
                   8023:     compared against the old one before changing anything, to make
                   8024:     sure the distfile was really updated on purpose, and that
                   8025:     no trojan horse or so crept in.
1.97      rillig   8026:     Please mention that the distfiles were compared and what was found
1.159     rodent   8027:     in your commit message.</p>
                   8028: <p>Then, the correct way to work around this is to
1.87      wiz      8029:     set <code class="varname">DIST_SUBDIR</code> to a unique directory name,
                   8030:     usually based on <code class="varname">PKGNAME_NOREV</code>. All
                   8031:     <code class="varname">DISTFILES</code> and
1.93      rillig   8032:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.97      rillig   8033:     subdirectory of the local distfiles directory.
1.218     rillig   8034:     (See <a class="xref" href="#bumping-pkgrevision" title="19.1.10. How to handle incrementing versions when fixing an existing package">Section 19.1.10, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.)
1.97      rillig   8035:     In case this
1.87      wiz      8036:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
                   8037:     including the <code class="filename">nbX</code> suffix) or a date stamp
1.159     rodent   8038:     can be appended, like <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
                   8039: <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>
                   8040: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8041:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8042:     path in the filenames.
1.159     rodent   8043:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8044:     Furthermore, a mail to the package's authors seems appropriate
                   8045:     telling them that changing distfiles after releases without
                   8046:     changing the file names is not good practice.</p>
1.75      rillig   8047: </div>
1.199     tnn      8048: <div class="sect2">
                   8049: <div class="titlepage"><div><div><h3 class="title">
                   8050: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.200     tnn      8051: <p>Helper methods exist for packages hosted on github.com which will often have distfile names that clash with other packages, for example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes from below:
                   8052:     </p>
1.199     tnn      8053: <div class="sect3">
                   8054: <div class="titlepage"><div><div><h4 class="title">
                   8055: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
                   8056: <p>
                   8057:         If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/archive/v1.0.zip</code>, then you are packaging a tagged release.
                   8058:       </p>
                   8059: <pre class="programlisting">
                   8060: DISTNAME=       exampleproject-1.0
1.200     tnn      8061: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8062: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   8063: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8064: EXTRACT_SUFX=   .zip
                   8065: </pre>
                   8066: </div>
                   8067: <div class="sect3">
                   8068: <div class="titlepage"><div><div><h4 class="title">
                   8069: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
                   8070: <p>
                   8071:         If your distfile URL looks similar to <code class="literal">http://github.com/example/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>, then you are packaging a specific commit not tied to a release.
                   8072:       </p>
                   8073: <pre class="programlisting">
                   8074: DISTNAME=       example-1.0
1.217     jnemeth  8075: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.200     tnn      8076: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   8077: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.199     tnn      8078:       </pre>
                   8079: </div>
                   8080: <div class="sect3">
                   8081: <div class="titlepage"><div><div><h4 class="title">
                   8082: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
                   8083: <p>
                   8084:         If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/releases/download/rel-1.6/offensive-1.6.zip</code>, then you are packaging a release.
                   8085:       </p>
                   8086: <pre class="programlisting">
                   8087: DISTNAME=       offensive-1.6
1.200     tnn      8088: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8089: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8090: GITHUB_PROJECT= exampleproject
                   8091: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8092: EXTRACT_SUFX=   .zip
1.199     tnn      8093:       </pre>
                   8094: </div>
                   8095: </div>
1.75      rillig   8096: </div>
1.148     asau     8097: <div class="sect1">
1.75      rillig   8098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   8099: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8100: <div class="sect2">
1.75      rillig   8101: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8102: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8103: <p>pkgsrc supports many different machines, with different
1.87      wiz      8104:     object formats like a.out and ELF, and varying abilities to do
                   8105:     shared library and dynamic loading at all. To accompany this,
                   8106:     varying commands and options have to be passed to the
                   8107:     compiler, linker, etc. to get the Right Thing, which can be
                   8108:     pretty annoying especially if you don't have all the machines
                   8109:     at your hand to test things.  The
1.189     snj      8110:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128     wiz      8111:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      8112:     both static and dynamic libraries from a set of source files,
                   8113:     thus being platform-independent.</p>
                   8114: <p>Here's how to use libtool in a package in seven simple
                   8115:     steps:</p>
1.128     wiz      8116: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8117: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8118:        Makefile.</p></li>
1.128     wiz      8119: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8120:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      8121:        add it to the definition of <code class="varname">CC</code>, if only
                   8122:        libraries are being built in a given Makefile. This one command
                   8123:        will build both PIC and non-PIC library objects, so you need not
                   8124:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8125: <li class="listitem">
1.75      rillig   8126: <p>For the linking of the library, remove any
1.128     wiz      8127:        <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
                   8128:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   8129: <pre class="programlisting">
1.100     rillig   8130: ${LIBTOOL} --mode=link \
                   8131:     ${CC} -o ${.TARGET:.a=.la} \
                   8132:         ${OBJS:.o=.lo} \
                   8133:         -rpath ${PREFIX}/lib \
                   8134:         -version-info major:minor
1.87      wiz      8135:        </pre>
1.75      rillig   8136: <p>Note that the library is changed to have a
1.87      wiz      8137:        <code class="filename">.la</code> extension, and the objects are
                   8138:        changed to have a <code class="filename">.lo</code>
                   8139:        extension. Change <code class="varname">OBJS</code> as
                   8140:        necessary. This automatically creates all of the
                   8141:        <code class="filename">.a</code>,
                   8142:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8143:        necessary) in the build directory. Be sure to include
1.128     wiz      8144:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      8145:        minor are zero, as libtool will otherwise strip off the
                   8146:        shared library version.</p>
1.75      rillig   8147: <p>From the libtool manual:</p>
                   8148: <pre class="programlisting">
1.100     rillig   8149: So, libtool library versions are described by three integers:
1.69      rillig   8150: 
1.100     rillig   8151: CURRENT
                   8152: The most recent interface number that this library implements.
1.69      rillig   8153: 
1.100     rillig   8154: REVISION
                   8155: The implementation number of the CURRENT interface.
1.69      rillig   8156: 
1.100     rillig   8157: AGE
                   8158: The difference between the newest and oldest interfaces that
                   8159: this library implements.  In other words, the library implements
                   8160: all the interface numbers in the range from number `CURRENT -
                   8161: AGE' to `CURRENT'.
1.1       grant    8162: 
1.100     rillig   8163: If two libraries have identical CURRENT and AGE numbers, then the
                   8164: dynamic linker chooses the library with the greater REVISION number.
1.87      wiz      8165:        </pre>
1.128     wiz      8166: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      8167:        different results for a.out and ELF (excluding symlinks)
                   8168:        in only one case. An ELF library of the form
1.128     wiz      8169:        <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>
1.87      wiz      8170:        will have a symlink of
1.128     wiz      8171:        <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>
1.87      wiz      8172:        on an a.out platform. This is handled
                   8173:        automatically.</p>
1.128     wiz      8174: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      8175:        directory of the library being built.</p>
1.76      rillig   8176: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8177:        <code class="filename">.la</code> file, the other files will be
                   8178:        added automatically.</p>
1.75      rillig   8179: </li>
1.128     wiz      8180: <li class="listitem">
1.76      rillig   8181: <p>When linking shared object (<code class="filename">.so</code>)
1.189     snj      8182:        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
1.128     wiz      8183:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8184:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      8185:        tacked on.</p>
1.76      rillig   8186: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8187:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8188: </li>
1.128     wiz      8189: <li class="listitem">
1.75      rillig   8190: <p>When linking programs that depend on these libraries
1.87      wiz      8191:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.189     snj      8192:        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}
1.128     wiz      8193:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      8194:        libraries (static or shared), but please be aware that
                   8195:        libtool will not allow you to specify a relative path in
1.128     wiz      8196:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      8197:        expects you to change that argument to be the
                   8198:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8199: <pre class="programlisting">
1.100     rillig   8200: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.87      wiz      8201:        </pre>
1.75      rillig   8202: <p>should be changed to:</p>
                   8203: <pre class="programlisting">
1.100     rillig   8204: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.87      wiz      8205:        </pre>
1.75      rillig   8206: <p>and it will do the right thing with the libraries.</p>
                   8207: </li>
1.128     wiz      8208: <li class="listitem">
1.189     snj      8209: <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>
                   8210:        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}
1.128     wiz      8211:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      8212:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8213: <pre class="programlisting">
1.126     jakllsch 8214: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.87      wiz      8215:        </pre>
1.76      rillig   8216: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8217:        shared library, any needed symlinks, and run
1.189     snj      8218:        <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>
1.75      rillig   8219: </li>
1.128     wiz      8220: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8221:        the <code class="filename">.la</code>
                   8222:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8223: </ol></div>
                   8224: </div>
1.148     asau     8225: <div class="sect2">
1.75      rillig   8226: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8227: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8228: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8229:     package Makefile. This will override the package's own libtool
                   8230:     in most cases.  For older libtool using packages,  libtool is
                   8231:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8232:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8233:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8234: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8235:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      8236:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8237:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      8238:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8239: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8240:     libraries built and installed, then use
                   8241:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8242: <p>If your package makes use of the platform-independent library
1.87      wiz      8243:     for loading dynamic shared objects, that comes with libtool
                   8244:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8245: <p>Some packages use libtool incorrectly so that the package
                   8246:     may not work or build in some circumstances. Some of the more
                   8247:     common errors are:</p>
1.148     asau     8248: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8249: <li class="listitem">
1.75      rillig   8250: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8251:        executable or library. This in itself isn't a problem if one of two things
                   8252:        has been done:</p>
1.128     wiz      8253: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8254: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8255:            <code class="filename">libfoo.la</code>, not
                   8256:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8257: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8258: </ol></div>
                   8259: </li>
1.128     wiz      8260: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8261:        The function lt_dlinit() should be called and the macro
                   8262:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8263:        executables.</p></li>
1.75      rillig   8264: </ul></div>
                   8265: </div>
1.148     asau     8266: <div class="sect2">
1.75      rillig   8267: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8268: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8269: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8270:     to regenerate the configure script and Makefile.in makefile
                   8271:     templates, then they should be executed in a pre-configure
                   8272:     target.</p>
1.75      rillig   8273: <p>For packages that need only autoconf:</p>
                   8274: <pre class="programlisting">
1.100     rillig   8275: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8276: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8277: ...
1.1       grant    8278: 
1.100     rillig   8279: pre-configure:
                   8280:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8281: 
1.100     rillig   8282: ...
1.87      wiz      8283:     </pre>
1.75      rillig   8284: <p>and for packages that need automake and autoconf:</p>
                   8285: <pre class="programlisting">
1.100     rillig   8286: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8287: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8288: ...
                   8289: 
                   8290: pre-configure:
                   8291:         set -e; cd ${WRKSRC}; \
                   8292:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8293: 
1.100     rillig   8294: ...
1.87      wiz      8295:     </pre>
1.75      rillig   8296: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8297:     require GNU Make.</p>
1.75      rillig   8298: <p>There are times when the configure process makes
1.87      wiz      8299:     additional changes to the generated files, which then causes
                   8300:     the build process to try to re-execute the automake sequence.
                   8301:     This is prevented by touching various files in the configure
                   8302:     stage. If this causes problems with your package you can set
                   8303:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8304:     Makefile.</p>
1.75      rillig   8305: </div>
                   8306: </div>
1.148     asau     8307: <div class="sect1">
1.75      rillig   8308: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   8309: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.148     asau     8310: <div class="sect2">
1.87      wiz      8311: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8312: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8313: <p>Compilers for the C, C++, and Fortran languages comes with
                   8314:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8315:     is written in C and will hide all other compilers (via the wrapper
1.110     hubertf  8316:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8317: <p>To declare which language's compiler a package needs, set
                   8318:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      8319:     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
                   8320:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8321:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8322:     written in C++, usually need a C compiler for the configure
                   8323:     phase.</p>
                   8324: </div>
1.148     asau     8325: <div class="sect2">
1.87      wiz      8326: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8327: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.87      wiz      8328: <p>If a program is written in Java, use the Java framework in
                   8329:     pkgsrc.  The package must include
                   8330:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8331:     provides the following variables:</p>
1.148     asau     8332: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8333: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8334:       dependency on the JDK is added.  If
1.128     wiz      8335:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      8336:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      8337:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      8338:       JDK.</p></li>
1.128     wiz      8339: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8340:       a package needs a Java2 implementation.  The supported values
1.128     wiz      8341:       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
                   8342:       <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
                   8343:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8344:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      8345:       above. This variable is not set by default.</p></li>
1.130     wiz      8346: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8347:       automatically set to the runtime location of the used Java
                   8348:       implementation dependency. It may be used to set
                   8349:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8350:       needs this variable to be defined.
                   8351:       </p></li>
1.87      wiz      8352: </ul></div>
                   8353: </div>
1.148     asau     8354: <div class="sect2">
1.87      wiz      8355: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8356: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8357: <p>If your package contains interpreted perl scripts, add
1.128     wiz      8358:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8359:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8360:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8361:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8362:     that you want adjusted. Every occurrence of
                   8363:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   8364:     replaced with the full path to the perl executable.</p>
1.87      wiz      8365: <p>If a particular version of perl is needed, set the
                   8366:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      8367:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.110     hubertf  8368: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      8369:     about handling perl modules.</p>
                   8370: </div>
1.148     asau     8371: <div class="sect2">
1.87      wiz      8372: <div class="titlepage"><div><div><h3 class="title">
1.147     wiz      8373: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
                   8374: <p><code class="varname">REPLACE_SH</code>,
                   8375:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8376:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   8377:     hash bangs in files. Please use the appropriate one, prefering
                   8378:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      8379:     Each should contain a list of scripts, relative to
                   8380:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8381:     occurrence of the matching shell in a she-bang line will be
                   8382:     replaced with the full path to the shell executable.
1.147     wiz      8383:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8384:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8385: </div>
1.148     asau     8386: <div class="sect2">
1.147     wiz      8387: <div class="titlepage"><div><div><h3 class="title">
                   8388: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      8389: <p>Currently, there is no special handling for other languages
                   8390:     in pkgsrc.  If a compiler package provides a
                   8391:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8392:     just add a (build) dependency on the appropriate compiler
                   8393:     package.</p>
                   8394: </div>
                   8395: </div>
1.148     asau     8396: <div class="sect1">
1.87      wiz      8397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   8398: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8399: <p>The most common failures when building a package are that
                   8400:        some platforms do not provide certain header files, functions or
                   8401:        libraries, or they provide the functions in a library that the
                   8402:        original package author didn't know. To work around this, you
                   8403:        can rewrite the source code in most cases so that it does not
                   8404:        use the missing functions or provides a replacement function.</p>
1.148     asau     8405: <div class="sect2">
1.77      rillig   8406: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8407: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8408: <p>If a package already comes with a GNU configure script, the
                   8409:        preferred way to fix the build failure is to change the
                   8410:        configure script, not the code. In the other cases, you can
                   8411:        utilize the C preprocessor, which defines certain macros
                   8412:        depending on the operating system and hardware architecture it
                   8413:        compiles for. These macros can be queried using for example
                   8414:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8415:        system, hardware architecture and compiler has its own macro.
                   8416:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8417:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8418:        are all defined, you know that you are using NetBSD on an i386
                   8419:        compatible CPU, and your compiler is GCC.</p>
                   8420: <p>The list of the following macros for hardware and
                   8421:        operating system depends on the compiler that is used. For
                   8422:        example, if you want to conditionally compile code on Solaris,
                   8423:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8424:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8425: <div class="sect3">
1.75      rillig   8426: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8427: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8428: <p>To distinguish between 4.4 BSD-derived systems and the
                   8429:         rest of the world, you should use the following code.</p>
                   8430: <pre class="programlisting">
1.100     rillig   8431: #include &lt;sys/param.h&gt;
                   8432: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8433: /* BSD-specific code goes here */
                   8434: #else
                   8435: /* non-BSD-specific code goes here */
                   8436: #endif
1.75      rillig   8437: </pre>
1.77      rillig   8438: <p>If this distinction is not fine enough, you can also test
                   8439:        for the following macros.</p>
1.75      rillig   8440: <pre class="programlisting">
1.151     obache   8441: Cygwin      __CYGWIN__
                   8442: DragonFly   __DragonFly__
1.100     rillig   8443: FreeBSD     __FreeBSD__
1.151     obache   8444: Haiku       __HAIKU__
1.100     rillig   8445: Interix     __INTERIX
                   8446: IRIX        __sgi (TODO: get a definite source for this)
                   8447: Linux       linux, __linux, __linux__
1.193     dholland 8448: Mac OS X    __APPLE__
1.151     obache   8449: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8450: Minix3      __minix
1.100     rillig   8451: NetBSD      __NetBSD__
                   8452: OpenBSD     __OpenBSD__
                   8453: Solaris     sun, __sun
1.75      rillig   8454: </pre>
                   8455: </div>
1.148     asau     8456: <div class="sect3">
1.75      rillig   8457: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8458: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8459: <pre class="programlisting">
1.100     rillig   8460: i386        i386, __i386, __i386__
                   8461: MIPS        __mips
                   8462: SPARC       sparc, __sparc
1.75      rillig   8463: </pre>
                   8464: </div>
1.148     asau     8465: <div class="sect3">
1.75      rillig   8466: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8467: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8468: <pre class="programlisting">
1.100     rillig   8469: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8470: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8471: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8472: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8473: </pre>
                   8474: </div>
                   8475: </div>
1.148     asau     8476: <div class="sect2">
1.78      rillig   8477: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8478: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8479: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8480:         combinations of compiler version and architecture and almost
                   8481:         always relation to optimisation being enabled.  Common symptoms
                   8482:         are gcc internal errors or never finishing compiling a
1.78      rillig   8483:        file.</p>
                   8484: <p>Typically, a workaround involves testing the
                   8485:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8486:         optimisation for that combination of file,
1.198     tnn      8487:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8488: <p>This used to be a big problem in the past, but is rarely
                   8489:        needed now as compiler technology has matured. If you still need
                   8490:        to add a compiler specific workaround, please do so in the file
                   8491:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8492:        compiler version as detailed as possible.</p>
1.78      rillig   8493: </div>
1.148     asau     8494: <div class="sect2">
1.78      rillig   8495: <div class="titlepage"><div><div><h3 class="title">
1.128     wiz      8496: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   8497: </h3></div></div></div>
1.92      rillig   8498: <p>This error message often means that a package did not
1.78      rillig   8499:        link to a shared library it needs. The following functions are
                   8500:        known to cause this error message over and over.</p>
                   8501: <div class="informaltable">
1.216     tnn      8502: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   8503: <colgroup>
                   8504: <col>
                   8505: <col>
                   8506: <col>
                   8507: </colgroup>
                   8508: <thead><tr>
                   8509: <th>Function</th>
                   8510: <th>Library</th>
                   8511: <th>Affected platforms</th>
                   8512: </tr></thead>
                   8513: <tbody>
                   8514: <tr>
                   8515: <td>accept, bind, connect</td>
                   8516: <td>-lsocket</td>
                   8517: <td>Solaris</td>
                   8518: </tr>
                   8519: <tr>
                   8520: <td>crypt</td>
                   8521: <td>-lcrypt</td>
                   8522: <td>DragonFly, NetBSD</td>
                   8523: </tr>
                   8524: <tr>
                   8525: <td>dlopen, dlsym</td>
                   8526: <td>-ldl</td>
                   8527: <td>Linux</td>
                   8528: </tr>
                   8529: <tr>
                   8530: <td>gethost*</td>
                   8531: <td>-lnsl</td>
                   8532: <td>Solaris</td>
                   8533: </tr>
                   8534: <tr>
                   8535: <td>inet_aton</td>
                   8536: <td>-lresolv</td>
                   8537: <td>Solaris</td>
                   8538: </tr>
                   8539: <tr>
                   8540: <td>nanosleep, sem_*, timer_*</td>
                   8541: <td>-lrt</td>
                   8542: <td>Solaris</td>
                   8543: </tr>
                   8544: <tr>
                   8545: <td>openpty</td>
                   8546: <td>-lutil</td>
                   8547: <td>Linux</td>
                   8548: </tr>
                   8549: </tbody>
                   8550: </table>
                   8551: </div>
                   8552: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8553:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8554:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8555:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8556:     bmake</strong></span>.</p>
1.148     asau     8557: <div class="sect3">
1.92      rillig   8558: <div class="titlepage"><div><div><h4 class="title">
1.106     rillig   8559: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8560: <p>When you are using the SunPro compiler, there is another
                   8561: possibility. That compiler cannot handle the following code:</p>
                   8562: <pre class="programlisting">
1.100     rillig   8563: extern int extern_func(int);
1.93      rillig   8564: 
1.100     rillig   8565: static inline int
                   8566: inline_func(int x)
                   8567: {
1.92      rillig   8568:         return extern_func(x);
1.100     rillig   8569: }
1.93      rillig   8570: 
1.100     rillig   8571: int main(void)
                   8572: {
1.92      rillig   8573:         return 0;
1.100     rillig   8574: }
1.92      rillig   8575: </pre>
                   8576: <p>It generates the code for <code class="function">inline_func</code> even if
                   8577: that function is never used. This code then refers to
                   8578: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8579: solve this problem you can try to tell the package to disable inlining
                   8580: of functions.</p>
                   8581: </div>
1.87      wiz      8582: </div>
1.148     asau     8583: <div class="sect2">
1.87      wiz      8584: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8585: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.87      wiz      8586: <p>Sometimes packages fail to build because the compiler runs
                   8587:     into an operating system specific soft limit.  With the
                   8588:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      8589:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8590:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8591:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span>.
1.87      wiz      8592:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8593:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8594:     segment size or maximum stack size of a process, respectively, to
                   8595:     their hard limits.</p>
1.78      rillig   8596: </div>
1.75      rillig   8597: </div>
1.148     asau     8598: <div class="sect1">
1.75      rillig   8599: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.218     rillig   8600: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     8601: <div class="sect2">
1.75      rillig   8602: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8603: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8604: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8605:     with some operating systems cannot create more than one
                   8606:     directory at a time. As such, you should call
                   8607:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8608: <pre class="programlisting">
1.100     rillig   8609: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8610: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.87      wiz      8611:     </pre>
1.128     wiz      8612: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8613:     dir2</code></span>&#8221;</span> to the
1.87      wiz      8614:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8615:     automatically do the right thing.</p>
1.75      rillig   8616: </div>
1.148     asau     8617: <div class="sect2">
1.75      rillig   8618: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8619: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8620: <p>In general, documentation should be installed into
1.87      wiz      8621:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8622:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8623:     includes the version number of the package).</p>
1.84      wiz      8624: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8625:     directory where HTML documentation is installed with the
1.128     wiz      8626:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      8627:     is needed because otherwise the documentation ends up in
                   8628:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8629:     places.</p>
                   8630: <p>An exception to the above is that library API documentation
1.189     snj      8631:     generated with the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      8632:     browsers (devhelp) should be left at their default location, which
                   8633:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8634:     documentation can be recognized from files ending in
                   8635:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8636:     (It is also acceptable to install such files in
                   8637:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8638:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8639:     <code class="filename">.devhelp*</code> file must be directly in that
                   8640:     directory then, no additional subdirectory level is allowed in
                   8641:     this case. This is usually achieved by using
1.128     wiz      8642:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8643:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8644:     though.)</p>
1.75      rillig   8645: </div>
1.148     asau     8646: <div class="sect2">
1.75      rillig   8647: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8648: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8649: <p>Certain packages, most of them in the games category, install
1.87      wiz      8650:     a score file that allows all users on the system to record their
                   8651:     highscores.  In order for this to work, the binaries need to be
                   8652:     installed setgid and the score files owned by the appropriate
1.142     wiz      8653:     group and/or owner (traditionally the "games" user/group).  Set
                   8654:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8655:     following variables, documented in more detail in
                   8656:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8657:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8658:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8659:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8660:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8661:     <code class="varname">GAMEDATA_PERMS</code> and
                   8662:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8663: <p>An example that illustrates some of the variables described above is
                   8664:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8665:     used to properly set directory permissions of the directory where the
                   8666:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8667:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8668:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8669:     binary:</p>
                   8670: <pre class="programlisting">
                   8671: USE_GAMESGROUP=                yes
                   8672: 
                   8673: BUILD_DEFS+=           VARBASE
                   8674: 
                   8675: OWN_DIRS_PERMS+=       ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8676: REQD_FILES_PERMS+=     /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8677: SPECIAL_PERMS+=                ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
                   8678:     </pre>
                   8679: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8680:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8681:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8682:     needed to be accessed by setgid games and
                   8683:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8684: <p>A package should therefore never hard code file ownership or
1.210     leot     8685:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8686:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8687:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8688:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8689: </div>
1.148     asau     8690: <div class="sect2">
1.75      rillig   8691: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8692: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8693: <p><code class="varname">DESTDIR</code> support means that a package
                   8694:     installs into a staging directory, not the final location of the
                   8695:     files. Then a binary package is created which can be used for
                   8696:     installation as usual. There are two ways: Either the package must
1.128     wiz      8697:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8698:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8699: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8700: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.145     wiz      8701:       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
                   8702:       <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>. By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
                   8703:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8704:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8705:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8706:       the inclusion.</p></li>
1.128     wiz      8707: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8708:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8709: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8710:       automatically. Many manual rules and pre/post-install often are
                   8711:       incorrect; fix them.</p></li>
1.128     wiz      8712: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8713:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8714: <li class="listitem"><p>In general, packages should support
1.103     wiz      8715:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8716:       DESTDIR.</p></li>
                   8717: </ul></div>
                   8718: </div>
1.148     asau     8719: <div class="sect2">
1.103     wiz      8720: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8721: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8722: <p>Your package may also contain scripts with hardcoded paths to
                   8723:       other interpreters besides (or as well as) perl.  To correct the
                   8724:       full pathname to the script interpreter, you need to set the
                   8725:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8726:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8727: <pre class="programlisting">
1.100     rillig   8728: REPLACE_INTERPRETER+=   tcl
                   8729: REPLACE.tcl.old=        .*/bin/tclsh
                   8730: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8731: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8732: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.87      wiz      8733:     </pre>
1.148     asau     8734: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8735: <h3 class="title">Note</h3>
                   8736: <p>Before March 2006, these variables were called
1.87      wiz      8737:     <code class="varname">_REPLACE.*</code> and
                   8738:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8739: </div>
                   8740: </div>
1.148     asau     8741: <div class="sect2">
1.75      rillig   8742: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8743: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8744: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8745:     the Makefile fragment
                   8746:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8747:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8748:     configuration for such modules as well as various hooks to tune
                   8749:     this configuration.  See comments in this file for
                   8750:     details.</p>
1.75      rillig   8751: <p>Perl5 modules will install into different places depending
1.87      wiz      8752:     on the version of perl used during the build process.  To
                   8753:     address this, pkgsrc will append lines to the
                   8754:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8755:     the installed <code class="filename">.packlist</code> file generated by
                   8756:     most perl5 modules.  This is invoked by defining
                   8757:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8758:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8759:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8760:     e.g.:</p>
1.75      rillig   8761: <pre class="programlisting">
1.153     wiz      8762: PERL5_PACKLIST= auto/Pg/.packlist
1.87      wiz      8763:     </pre>
1.153     wiz      8764: <p>The perl5 config variables
                   8765:     <code class="varname">installarchlib</code>,
                   8766:     <code class="varname">installscript</code>,
                   8767:     <code class="varname">installvendorbin</code>,
                   8768:     <code class="varname">installvendorscript</code>,
                   8769:     <code class="varname">installvendorarch</code>,
                   8770:     <code class="varname">installvendorlib</code>,
                   8771:     <code class="varname">installvendorman1dir</code>, and
                   8772:     <code class="varname">installvendorman3dir</code> represent those
                   8773:     locations in which components of perl5 modules may be installed,
                   8774:     provided as variable with uppercase and prefixed with
                   8775:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8776:     and may be used by perl5 packages that don't have a packlist.
                   8777:     These variables are also substituted for in the
                   8778:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8779:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   8780: </div>
1.148     asau     8781: <div class="sect2">
1.75      rillig   8782: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8783: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8784: <p>Some packages install info files or use the
1.128     wiz      8785:     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
1.87      wiz      8786:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8787:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8788:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8789:     handle registration of the info files in the Info directory
1.128     wiz      8790:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      8791:     files registration is either provided by the system, or by a
                   8792:     special purpose package automatically added as dependency if
                   8793:     needed.</p>
1.75      rillig   8794: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8795:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8796:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      8797:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   8798: <p>The info files for the package should be listed in the
1.87      wiz      8799:     package <code class="filename">PLIST</code>; however any split info files
                   8800:     need not be listed.</p>
1.128     wiz      8801: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8802:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      8803:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      8804:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      8805:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8806:     variable in the package <code class="filename">Makefile</code>. By
                   8807:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8808:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8809:     does not match the required minimum, a build dependency on the
1.189     snj      8810:     <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      8811:     be added automatically.</p>
1.75      rillig   8812: <p>The build and installation process of the software provided
1.87      wiz      8813:     by the package should not use the
1.110     hubertf  8814:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8815:     info files is the task of the package
                   8816:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8817:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8818: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8819:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8820:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8821:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8822: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8823:     no effect except the logging of a message. The script overriding
1.110     hubertf  8824:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8825:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8826:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8827: </div>
1.148     asau     8828: <div class="sect2">
1.75      rillig   8829: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8830: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8831: <p>All packages that install manual pages should install them
1.87      wiz      8832:     into the same directory, so that there is one common place to look
                   8833:     for them. In pkgsrc, this place is
                   8834:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8835:     should be used in packages. The default for
                   8836:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      8837:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8838:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     8839: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8840: <h3 class="title">Note</h3>
1.87      wiz      8841: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8842:     is far from complete.</p>
1.75      rillig   8843: </div>
1.81      rillig   8844: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8845:     <code class="filename">man/</code> as the top level directory for the man
                   8846:     page file entries, and the pkgsrc framework will convert as
                   8847:     needed. In all other places, the correct
                   8848:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8849: <p>Packages that are
                   8850:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      8851:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      8852:     <code class="filename">./configure</code>
                   8853:     --mandir switch to set where the man pages should be installed.
                   8854:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8855:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8856: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8857:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      8858:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      8859:     Or if the <code class="filename">./configure</code> script uses
                   8860:     a non-standard use of --mandir, you can set
                   8861:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.110     hubertf  8862: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      8863:     information on installation of compressed manual pages.</p>
1.75      rillig   8864: </div>
1.148     asau     8865: <div class="sect2">
1.75      rillig   8866: <div class="titlepage"><div><div><h3 class="title">
1.107     rillig   8867: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      8868: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   8869:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      8870:     you need to take some extra steps to make sure they get registered
                   8871:     in the database:</p>
1.128     wiz      8872: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8873: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      8874:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   8875:        takes care of rebuilding the GConf database at installation and
1.87      wiz      8876:        deinstallation time, and tells the package where to install
1.107     rillig   8877:        GConf data files using some standard configure arguments.  It
1.87      wiz      8878:        also disallows any access to the database directly from the
                   8879:        package.</p></li>
1.128     wiz      8880: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      8881:        <code class="filename">.schemas</code> files under
                   8882:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8883:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8884:        need to manually patch the package.</p></li>
1.128     wiz      8885: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8886:        directory, as they will be handled automatically.  See
1.194     bsiegert 8887:        <a class="xref" href="#faq.conf" title="9.13. How do I change the location of configuration files?">Section 9.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.128     wiz      8888: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      8889:        your <code class="filename">Makefile</code> with a list of all
                   8890:        <code class="filename">.schemas</code> files installed by the package, if
                   8891:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      8892: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      8893:        your <code class="filename">Makefile</code> with a
                   8894:        list of all <code class="filename">.entries</code> files installed by the
                   8895:        package, if any. Names must not contain any directories in
                   8896:        them.</p></li>
1.75      rillig   8897: </ol></div>
                   8898: </div>
1.148     asau     8899: <div class="sect2">
1.75      rillig   8900: <div class="titlepage"><div><div><h3 class="title">
1.119     mishka   8901: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      8902: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   8903:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      8904:     get registered in the database:</p>
1.128     wiz      8905: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8906: <li class="listitem"><p>Include
1.119     mishka   8907:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   8908:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      8909:        takes care of rebuilding the scrollkeeper database at
                   8910:        installation and deinstallation time, and disallows any access
                   8911:        to it directly from the package.</p></li>
1.128     wiz      8912: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8913:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8914:        will be handled automatically.</p></li>
1.128     wiz      8915: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   8916:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   8917:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   8918: </ol></div>
                   8919: </div>
1.148     asau     8920: <div class="sect2">
1.75      rillig   8921: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8922: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8923: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8924:     the fonts database in the directory where they get installed at
                   8925:     installation and deinstallation time.  This can be automatically
                   8926:     done by using the pkginstall framework.</p>
1.75      rillig   8927: <p>You can list the directories where fonts are installed in the
1.87      wiz      8928:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8929:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      8930:     <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>.
1.87      wiz      8931:     Also make sure that the database file
                   8932:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8933: <p>Note that you should not create new directories for fonts;
1.87      wiz      8934:     instead use the standard ones to avoid that the user needs to
                   8935:     manually configure his X server to find them.</p>
1.75      rillig   8936: </div>
1.148     asau     8937: <div class="sect2">
1.75      rillig   8938: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8939: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8940: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8941:     take some extra steps to get them registered in the GTK2 database
                   8942:     properly:</p>
1.128     wiz      8943: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8944: <li class="listitem"><p>Include
1.87      wiz      8945:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8946:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8947:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      8948: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      8949:       your package installs GTK2 immodules.</p></li>
1.128     wiz      8950: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      8951:       GTK2 loaders.</p></li>
1.128     wiz      8952: <li class="listitem">
1.87      wiz      8953: <p>Patch the package to not touch any of the GTK2
                   8954:       databases directly.  These are:</p>
1.148     asau     8955: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8956: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8957: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   8958: </ul></div>
                   8959: </li>
1.128     wiz      8960: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      8961:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8962:       directory, as they will be handled automatically.</p></li>
1.75      rillig   8963: </ol></div>
                   8964: </div>
1.148     asau     8965: <div class="sect2">
1.75      rillig   8966: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8967: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   8968: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      8969:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8970:     etc.), you need to take some extra steps:</p>
1.128     wiz      8971: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8972: <li class="listitem"><p>Include
1.87      wiz      8973:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8974:        your <code class="filename">Makefile</code>, which takes care of
                   8975:        registering those files in system-wide catalogs at
                   8976:        installation and deinstallation time.</p></li>
1.128     wiz      8977: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      8978:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      8979: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      8980:        any XML catalogs installed by the package.</p></li>
1.128     wiz      8981: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      8982:        to be added to the SGML catalog.  These come in groups of
                   8983:        three strings; see xmlcatmgr(1) for more information
                   8984:        (specifically, arguments recognized by the 'add' action).
                   8985:        Note that you will normally not use this variable.</p></li>
1.128     wiz      8986: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      8987:        to be added to the XML catalog.  These come in groups of three
                   8988:        strings; see xmlcatmgr(1) for more information (specifically,
                   8989:        arguments recognized by the 'add' action).  Note that you will
                   8990:        normally not use this variable.</p></li>
1.75      rillig   8991: </ol></div>
                   8992: </div>
1.148     asau     8993: <div class="sect2">
1.75      rillig   8994: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   8995: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   8996: <p>If a package provides extensions to the MIME database by
1.87      wiz      8997:     installing <code class="filename">.xml</code> files inside
                   8998:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8999:     need to take some extra steps to ensure that the database is kept
                   9000:     consistent with respect to these new files:</p>
1.128     wiz      9001: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9002: <li class="listitem"><p>Include
1.87      wiz      9003:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9004:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9005:        this same directory, which is reserved for inclusion from
                   9006:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9007:        care of rebuilding the MIME database at installation and
                   9008:        deinstallation time, and disallows any access to it directly
                   9009:        from the package.</p></li>
1.128     wiz      9010: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9011:        <code class="filename">share/mime</code> directory,
                   9012:        <span class="emphasis"><em>except</em></span> for files saved under
                   9013:        <code class="filename">share/mime/packages</code>.  The former are
                   9014:        handled automatically by
                   9015:        the update-mime-database program, but the latter are
                   9016:        package-dependent and must be removed by the package that
                   9017:        installed them in the first place.</p></li>
1.128     wiz      9018: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9019:        from the PLIST.  They will be handled by the shared-mime-info
                   9020:        package.</p></li>
1.75      rillig   9021: </ol></div>
                   9022: </div>
1.148     asau     9023: <div class="sect2">
1.75      rillig   9024: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9025: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9026: <p>If a package uses intltool during its build, add
                   9027:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9028:     which forces it to use the intltool package provided by pkgsrc,
                   9029:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9030: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9031:     latest available version; this way, the package benefits of any
                   9032:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9033: </div>
1.148     asau     9034: <div class="sect2">
1.75      rillig   9035: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9036: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9037: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9038:     the startup directory by default, but you can enable it, by adding
                   9039:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9040:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9041:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9042:     it will automatically remove the scripts when the package is
                   9043:     deinstalled.</p>
1.75      rillig   9044: </div>
1.148     asau     9045: <div class="sect2">
1.75      rillig   9046: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9047: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9048: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9049:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9050:     updated.</p>
1.148     asau     9051: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9052: <h3 class="title">Note</h3>
1.125     wiz      9053: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9054:     packages should install files
1.125     wiz      9055:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9056:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9057: </div>
1.128     wiz      9058: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9059: <li class="listitem"><p>Include
1.125     wiz      9060:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9061:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9062:       database at installation and deinstallation time.</p></li>
1.128     wiz      9063: <li class="listitem">
1.75      rillig   9064: <p>If your package installs files into a texmf
1.87      wiz      9065:       tree other than the one
1.125     wiz      9066:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9067:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9068:       trees that need database update.</p>
1.75      rillig   9069: <p>If your package also installs font map files that need
1.110     hubertf  9070:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9071:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9072:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9073:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9074:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9075:       be run automatically at installation/deinstallation to
                   9076:       enable/disable font map files for TeX output
                   9077:       drivers.</p>
1.75      rillig   9078: </li>
1.128     wiz      9079: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9080:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9081:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9082: </ol></div>
                   9083: </div>
1.148     asau     9084: <div class="sect2">
1.85      jmmv     9085: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9086: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.87      wiz      9087:     emulation</h3></div></div></div>
                   9088: <p>There are some packages that provide libraries and
                   9089:     executables for running binaries from a one operating system
                   9090:     on a different one (if the latter supports it).  One example
                   9091:     is running Linux binaries on NetBSD.</p>
1.189     snj      9092: <p>The <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      9093:     helps in extracting and packaging Linux rpm packages.</p>
                   9094: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9095:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9096:     if all libraries for each installed executable can be found by
                   9097:     the dynamic linker.  Since the standard dynamic linker is run,
                   9098:     this fails for emulation packages, because the libraries used
                   9099:     by the emulation are not in the standard directories.</p>
                   9100: </div>
1.148     asau     9101: <div class="sect2">
1.87      wiz      9102: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9103: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     9104: <p>If a package installs images under the
1.87      wiz      9105:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9106:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9107:     database, you need to take some extra steps to make sure that the
                   9108:     shared theme directory is handled appropriately and that the cache
                   9109:     database is rebuilt:</p>
1.128     wiz      9110: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9111: <li class="listitem"><p>Include
1.87      wiz      9112:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128     wiz      9113: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87      wiz      9114:        entry that refers to the theme cache.</p></li>
1.128     wiz      9115: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85      jmmv     9116:          directories from the <code class="filename">share/icons/hicolor</code>
                   9117:          hierarchy because they will be handled automatically.</p></li>
                   9118: </ol></div>
                   9119: <p>The best way to verify that the PLIST is correct with
                   9120:       respect to the last two points is to regenerate it using
1.110     hubertf  9121:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     9122: </div>
1.148     asau     9123: <div class="sect2">
1.85      jmmv     9124: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   9125: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     9126: <p>If a package installs <code class="filename">.desktop</code> files
                   9127:       under <code class="filename">share/applications</code> and these include
1.159     rodent   9128:       MIME information (MimeType key), you need to take extra steps to
                   9129:       ensure that they are registered into the MIME database:</p>
1.128     wiz      9130: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9131: <li class="listitem"><p>Include
1.85      jmmv     9132:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128     wiz      9133: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85      jmmv     9134:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9135:          It will be handled automatically.</p></li>
                   9136: </ol></div>
                   9137: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  9138:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     9139:       print-PLIST</strong></span>.</p>
1.75      rillig   9140: </div>
                   9141: </div>
1.148     asau     9142: <div class="sect1">
1.87      wiz      9143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9144: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      9145: <p>In some cases one does not have the time to solve a problem
1.125     wiz      9146:   immediately. In this case, one can plainly mark a package as broken.  For
                   9147:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9148:   reason why the package is broken (similar to the
                   9149:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   9150:   the package will immediately be shown this message, and the build
                   9151:   will not be even tried.</p>
                   9152: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87      wiz      9153:   intervals.</p>
                   9154: </div>
1.75      rillig   9155: </div>
1.148     asau     9156: <div class="chapter">
1.75      rillig   9157: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9158: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.88      wiz      9159: <p>To check out all the gotchas when building a package, here are
                   9160:   the steps that I do in order to get a package working.  Please note
                   9161:   this is basically the same as what was explained in the previous
                   9162:   sections, only with some debugging aids.</p>
1.148     asau     9163: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9164: <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>
                   9165: <li class="listitem">
1.189     snj      9166: <p>Install <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      9167:       create a directory for a new package, change into it, then run
1.110     hubertf  9168:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   9169: <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>
                   9170: <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>
                   9171: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   9172: </li>
1.128     wiz      9173: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   9174: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   9175: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   9176: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      9177:       configure step to the package's
                   9178:       <code class="filename">Makefile</code>.</p></li>
1.128     wiz      9179: <li class="listitem">
1.75      rillig   9180: <p>Make the package compile, doing multiple rounds of</p>
                   9181: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   9182: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   9183: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   9184: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   9185: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   9186: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   9187: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      9188: <p>Doing this step as non-root user will ensure that no files
                   9189:       are modified that shouldn't be, especially during the build
1.110     hubertf  9190:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   9191:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.189     snj      9192:       from the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.88      wiz      9193:       package.</p>
1.75      rillig   9194: </li>
1.128     wiz      9195: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   9196:       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>
                   9197: <li class="listitem">
1.76      rillig   9198: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   9199: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9200: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   9201: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   9202: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   9203: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      9204: <p>You usually need to be <code class="username">root</code> to do
                   9205:       this.  Look if there are any files left:</p>
1.75      rillig   9206: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9207: <p>If this reveals any files that are missing in
1.88      wiz      9208:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   9209: </li>
1.128     wiz      9210: <li class="listitem">
1.88      wiz      9211: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   9212:       package again and make a binary package:</p>
1.75      rillig   9213: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   9214: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   9215: </li>
1.128     wiz      9216: <li class="listitem">
1.75      rillig   9217: <p>Delete the installed package:</p>
1.88      wiz      9218: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75      rillig   9219: </li>
1.128     wiz      9220: <li class="listitem">
1.110     hubertf  9221: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      9222:       command, which shouldn't find anything now:</p>
1.75      rillig   9223: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   9224: </li>
1.128     wiz      9225: <li class="listitem">
1.75      rillig   9226: <p>Reinstall the binary package:</p>
1.93      rillig   9227: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75      rillig   9228: </li>
1.128     wiz      9229: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   9230: <li class="listitem">
1.189     snj      9231: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88      wiz      9232:       reports:</p>
1.75      rillig   9233: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   9234: </li>
1.128     wiz      9235: <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>
1.75      rillig   9236: </ul></div>
                   9237: </div>
1.148     asau     9238: <div class="chapter">
1.75      rillig   9239: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9240: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.75      rillig   9241: <div class="toc">
                   9242: <p><b>Table of Contents</b></p>
1.210     leot     9243: <dl class="toc">
1.106     rillig   9244: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   9245: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9246: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.140     wiz      9247: <dt><span class="sect1"><a href="#committing-importing">21.4. Committing: Adding a package to CVS</a></span></dt>
1.106     rillig   9248: <dt><span class="sect1"><a href="#updating-package">21.5. Updating a package to a newer version</a></span></dt>
1.122     reed     9249: <dt><span class="sect1"><a href="#renaming-package">21.6. Renaming a package in pkgsrc</a></span></dt>
                   9250: <dt><span class="sect1"><a href="#moving-package">21.7. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9251: </dl>
                   9252: </div>
1.148     asau     9253: <div class="sect1">
1.75      rillig   9254: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9255: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9256: <p>Our policy is that we accept binaries only from pkgsrc
                   9257:        developers to guarantee that the packages don't contain any
                   9258:        trojan horses etc. This is not to annoy anyone but rather to
                   9259:        protect our users! You're still free to put up your home-made
                   9260:        binary packages and tell the world where to get them. NetBSD
                   9261:        developers doing bulk builds and wanting to upload them please
1.174     asau     9262:        see <a class="xref" href="#bulk" title="Chapter 7. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 7, <i>Creating binary packages for everything in pkgsrc (bulk
                   9263: builds)</i></a>.</p>
1.75      rillig   9264: </div>
1.148     asau     9265: <div class="sect1">
1.75      rillig   9266: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9267: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9268: <p>First, check that your package is complete, compiles and
1.110     hubertf  9269:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.189     snj      9270:        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>
1.82      rillig   9271:        archive that contains all files that make up the package.
1.87      wiz      9272:        Finally, send this package to the pkgsrc bug tracking system,
1.189     snj      9273:        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
1.87      wiz      9274:        that, go to the web page
1.110     hubertf  9275:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.124     snj      9276:        which contains some instructions and a link to a form where you
                   9277:        can submit packages.  The
1.189     snj      9278:        <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
1.124     snj      9279:        also available as a substitute for either of the above two tools.
                   9280:        </p>
1.87      wiz      9281: <p>In the form of the problem report, the category should be
1.128     wiz      9282:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      9283:        and version number, and the description field should contain a
                   9284:        short description of your package (contents of the COMMENT
                   9285:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      9286:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   9287: <p>If you want to submit several packages, please send a
                   9288:        separate PR for each one, it's easier for us to track things
                   9289:        that way.</p>
                   9290: <p>Alternatively, you can also import new packages into
1.128     wiz      9291:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.215     wiz      9292:        homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.75      rillig   9293:        for details.</p>
                   9294: </div>
1.148     asau     9295: <div class="sect1">
1.75      rillig   9296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9297: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9298: <p>Please note all package additions, updates, moves, and
1.93      rillig   9299:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9300:        important to keep this file up to date and conforming to the
                   9301:        existing format, because it will be used by scripts to
1.110     hubertf  9302:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9303:        sites. Additionally, check the
1.76      rillig   9304:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9305:        for the package you updated or removed, in case it was mentioned
                   9306:        there.</p>
                   9307: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9308:        bumped, the change should appear in
1.93      rillig   9309:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9310:        related or otherwise relevant. Mass bumps that result from a
                   9311:        dependency being updated should not be mentioned. In all other
                   9312:        cases it's the developer's decision.</p>
                   9313: <p>There is a make target that helps in creating proper
1.110     hubertf  9314:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9315:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9316:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9317:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9318:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9319:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9320:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9321:   For new packages, or package moves or removals, set the
                   9322:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9323:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9324:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      9325:   not the same as your NetBSD login name. The target also automatically
                   9326:   removes possibly existing entries for the package in the
                   9327:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     9328:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 9329:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      9330:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9331:   makes the cvs commands use the main repository.
                   9332:   </p>
1.75      rillig   9333: </div>
1.148     asau     9334: <div class="sect1">
1.75      rillig   9335: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.140     wiz      9336: <a name="committing-importing"></a>21.4. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      9337: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      9338:   access to the pkgsrc repository.</p>
                   9339: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9340: Start by adding the directory and then files in the directory. Don't
                   9341: forget to add the new package to the category's
                   9342: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9343: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9344: <pre class="programlisting">
                   9345: <code class="prompt">$</code> cd .../pkgsrc/category
                   9346: <code class="prompt">$</code> cvs add pkgname
                   9347: <code class="prompt">$</code> cd pkgname
                   9348: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9349: <code class="prompt">$</code> cvs add patches/p*
                   9350: <code class="prompt">$</code> cvs status | less
1.141     wiz      9351: <code class="prompt">$</code> cvs commit
1.140     wiz      9352: <code class="prompt">$</code> cd ..
                   9353: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      9354: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     9355: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  9356: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      9357: </pre>
1.87      wiz      9358: <p>The commit message of the initial import should include part of the
1.76      rillig   9359:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9360:   what the package is/does.</p>
1.140     wiz      9361: <p>Also mention the new package in
                   9362: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9363: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9364: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   9365: </div>
1.148     asau     9366: <div class="sect1">
1.75      rillig   9367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9368: <a name="updating-package"></a>21.5. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9369: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9370:   changes between old and new versions into the commit log when updating
1.87      wiz      9371:   a package. There are various reasons for this:</p>
1.148     asau     9372: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9373: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      9374:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      9375: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      9376:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      9377: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   9378:   repository is very useful for people who read the pkgsrc-changes mailing
                   9379:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9380:   the package.</p></li>
1.75      rillig   9381: </ul></div>
1.87      wiz      9382: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9383:   has been released, it should not automatically be upgraded in the CVS
                   9384:   repository.  We prefer to be conservative in the packages that are
                   9385:   included in pkgsrc - development or beta packages are not really the
                   9386:   best thing for most places in which pkgsrc is used. Please use your
                   9387:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9388:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9389: </div>
1.148     asau     9390: <div class="sect1">
1.75      rillig   9391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.122     reed     9392: <a name="renaming-package"></a>21.6. Renaming a package in pkgsrc</h2></div></div></div>
                   9393: <p>Renaming packages is not recommended.</p>
                   9394: <p>When renaming packages, be sure to fix any references to old name
                   9395:   in other Makefiles, options, buildlink files, etc.</p>
                   9396: <p>Also When renaming a package, please define
                   9397:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   9398:   pattern(s) of the previous package name.
                   9399:   This may be repeated for multiple renames.
                   9400:   The new package would be an exact replacement.
                   9401: </p>
1.128     wiz      9402: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     9403:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9404:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9405:   not be an exact replacement but is a suggestion for the replaced
                   9406:   functionality.</p>
                   9407: </div>
1.148     asau     9408: <div class="sect1">
1.122     reed     9409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9410: <a name="moving-package"></a>21.7. Moving a package in pkgsrc</h2></div></div></div>
                   9411: <p>It is preferred that packages are not renamed or moved, but if needed
                   9412:   please follow these steps.
                   9413: </p>
1.128     wiz      9414: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9415: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9416: <li class="listitem">
1.75      rillig   9417: <p>Remove all CVS dirs.</p>
1.87      wiz      9418: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9419: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87      wiz      9420: <p>and use that for further work.</p>
1.75      rillig   9421: </li>
1.128     wiz      9422: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9423: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9424: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9425: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     9426: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9427: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9428: for doing an update using pkgsrc building; for example, it can
1.189     snj      9429: 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>
1.122     reed     9430: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9431: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9432: it may have multiple matches, so the tool should also check on the
                   9433: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9434: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9435: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      9436: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9437: place.</p></li>
1.128     wiz      9438: <li class="listitem">
1.75      rillig   9439: <p>Check if any package depends on it:
                   9440: </p>
                   9441: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9442: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9443: </li>
1.128     wiz      9444: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9445: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9446: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9447: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9448: <li class="listitem">
1.75      rillig   9449: <p>Commit the changed and removed files:</p>
                   9450: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87      wiz      9451: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9452: </li>
                   9453: </ol></div>
                   9454: </div>
                   9455: </div>
1.148     asau     9456: <div class="chapter">
1.75      rillig   9457: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9458: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9459: <p>This section contains the answers to questions that may
                   9460:        arise when you are writing a package. If you don't find your
                   9461:        question answered here, first have a look in the other chapters,
                   9462:        and if you still don't have the answer, ask on the
                   9463:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     9464: <div class="qandaset">
1.219   ! rillig   9465: <a name="idm83207968"></a><dl>
1.106     rillig   9466: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9467:        MAKEFLAGS, .MAKEFLAGS and
                   9468:        MAKE_FLAGS?</a>
                   9469: </dt>
1.106     rillig   9470: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9471:        MAKE, GMAKE and
                   9472:        MAKE_PROGRAM?</a>
                   9473: </dt>
1.106     rillig   9474: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9475:        CC, PKG_CC and
                   9476:        PKGSRC_COMPILER?</a>
                   9477: </dt>
1.106     rillig   9478: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9479:        BUILDLINK_LDFLAGS,
                   9480:        BUILDLINK_LDADD and
                   9481:        BUILDLINK_LIBS?</a>
                   9482: </dt>
1.106     rillig   9483: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9484:        VARNAME=BUILDLINK_PREFIX.foo
                   9485:        say it's empty?</a>
                   9486: </dt>
1.106     rillig   9487: <dt>22.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9488:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9489:        don't understand the := inside
                   9490:        it.</a>
                   9491: </dt>
1.106     rillig   9492: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9493:        developers?</a>
                   9494: </dt>
1.106     rillig   9495: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9496:        documentation?</a>
                   9497: </dt>
1.106     rillig   9498: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.92      rillig   9499: do?</a>
                   9500: </dt>
1.75      rillig   9501: </dl>
1.148     asau     9502: <table border="0" style="width: 100%;">
                   9503: <colgroup>
1.75      rillig   9504: <col align="left" width="1%">
1.128     wiz      9505: <col>
1.148     asau     9506: </colgroup>
1.75      rillig   9507: <tbody>
1.148     asau     9508: <tr class="question">
1.75      rillig   9509: <td align="left" valign="top">
1.219   ! rillig   9510: <a name="devfaq.makeflags"></a><a name="idm83207584"></a><p><b>22.1.</b></p>
1.75      rillig   9511: </td>
                   9512: <td align="left" valign="top"><p>What is the difference between
                   9513:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9514:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9515: </tr>
                   9516: <tr class="answer">
1.91      rillig   9517: <td align="left" valign="top"></td>
1.75      rillig   9518: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.189     snj      9519:        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
1.75      rillig   9520:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9521:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9522:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9523: </tr>
1.148     asau     9524: <tr class="question">
1.75      rillig   9525: <td align="left" valign="top">
1.219   ! rillig   9526: <a name="devfaq.make"></a><a name="idm83203488"></a><p><b>22.2.</b></p>
1.75      rillig   9527: </td>
                   9528: <td align="left" valign="top"><p>What is the difference between
                   9529:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9530:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9531: </tr>
                   9532: <tr class="answer">
1.91      rillig   9533: <td align="left" valign="top"></td>
1.75      rillig   9534: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.189     snj      9535:        <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
1.75      rillig   9536:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9537:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9538:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9539:        Make program that is used for building the
                   9540:        package.</p></td>
                   9541: </tr>
1.148     asau     9542: <tr class="question">
1.75      rillig   9543: <td align="left" valign="top">
1.219   ! rillig   9544: <a name="devfaq.cc"></a><a name="idm83199136"></a><p><b>22.3.</b></p>
1.75      rillig   9545: </td>
                   9546: <td align="left" valign="top"><p>What is the difference between
                   9547:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9548:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9549: </tr>
                   9550: <tr class="answer">
1.91      rillig   9551: <td align="left" valign="top"></td>
1.75      rillig   9552: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9553:        compiler, which can be configured by the pkgsrc user.
                   9554:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9555:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9556:        path to a compiler, but the type of compiler that should be
1.76      rillig   9557:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9558:        information about the latter variable.</p></td>
                   9559: </tr>
1.148     asau     9560: <tr class="question">
1.75      rillig   9561: <td align="left" valign="top">
1.219   ! rillig   9562: <a name="devfaq.bl3flags"></a><a name="idm83194912"></a><p><b>22.4.</b></p>
1.75      rillig   9563: </td>
                   9564: <td align="left" valign="top"><p>What is the difference between
                   9565:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9566:        <code class="varname">BUILDLINK_LDADD</code> and
                   9567:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9568: </tr>
                   9569: <tr class="answer">
1.91      rillig   9570: <td align="left" valign="top"></td>
1.75      rillig   9571: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9572: </tr>
1.148     asau     9573: <tr class="question">
1.75      rillig   9574: <td align="left" valign="top">
1.219   ! rillig   9575: <a name="devfaq.bl3prefix"></a><a name="idm83192736"></a><p><b>22.5.</b></p>
1.75      rillig   9576: </td>
1.110     hubertf  9577: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9578:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9579:        say it's empty?</p></td>
                   9580: </tr>
                   9581: <tr class="answer">
1.91      rillig   9582: <td align="left" valign="top"></td>
1.75      rillig   9583: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      9584:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9585:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  9586:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9587:        command.</p></td>
                   9588: </tr>
1.148     asau     9589: <tr class="question">
1.78      rillig   9590: <td align="left" valign="top">
1.219   ! rillig   9591: <a name="devfaq.master_sites"></a><a name="idm83189664"></a><p><b>22.6.</b></p>
1.78      rillig   9592: </td>
                   9593: <td align="left" valign="top"><p>What does
                   9594:        <code class="literal">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9595:        don't understand the <code class="literal">:=</code> inside
                   9596:        it.</p></td>
                   9597: </tr>
                   9598: <tr class="answer">
1.91      rillig   9599: <td align="left" valign="top"></td>
1.78      rillig   9600: <td align="left" valign="top"><p>The <code class="literal">:=</code> is not really an
                   9601:        assignment operator, like you might expect at first sight.
                   9602:        Instead, it is a degenerate form of
                   9603:        <code class="literal">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.189     snj      9604:        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
1.78      rillig   9605:        may have seen as in <code class="literal">${SRCS:.c=.o}</code>. In the
                   9606:        case of <code class="varname">MASTER_SITE_*</code>,
                   9607:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9608:        <em class="replaceable"><code>new_string</code></em> is
                   9609:        <code class="literal">package/</code>. That's where the
                   9610:        <code class="literal">:</code> and the <code class="literal">=</code> fall
                   9611:        together.</p></td>
                   9612: </tr>
1.148     asau     9613: <tr class="question">
1.78      rillig   9614: <td align="left" valign="top">
1.219   ! rillig   9615: <a name="devfaq.mailinglists"></a><a name="idm83173408"></a><p><b>22.7.</b></p>
1.78      rillig   9616: </td>
                   9617: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9618:        developers?</p></td>
                   9619: </tr>
                   9620: <tr class="answer">
1.91      rillig   9621: <td align="left" valign="top"></td>
1.148     asau     9622: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.110     hubertf  9623: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78      rillig   9624: <dd><p>This is a list for technical discussions related
                   9625:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9626:        pkgsrc infrastructure, proposed new features, questions related
                   9627:        to porting pkgsrc to a new platform, advice for maintaining a
                   9628:        package, patches that affect many packages, help requests moved
                   9629:        from pkgsrc-users when an infrastructure bug is found,
                   9630:        etc.</p></dd>
1.110     hubertf  9631: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78      rillig   9632: <dd><p>All bug reports in category "pkg" sent with
1.189     snj      9633:        <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
1.78      rillig   9634:        directly; use one of the other mailing
                   9635:        lists.</p></dd>
                   9636: </dl></div></td>
                   9637: </tr>
1.148     asau     9638: <tr class="question">
1.80      rillig   9639: <td align="left" valign="top">
1.219   ! rillig   9640: <a name="devfaq.documentation"></a><a name="idm83169568"></a><p><b>22.8.</b></p>
1.80      rillig   9641: </td>
                   9642: <td align="left" valign="top"><p>Where is the pkgsrc
                   9643:        documentation?</p></td>
                   9644: </tr>
                   9645: <tr class="answer">
1.91      rillig   9646: <td align="left" valign="top"></td>
1.80      rillig   9647: <td align="left" valign="top">
                   9648: <p>There are many places where you can find
                   9649:        documentation about pkgsrc:</p>
1.148     asau     9650: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9651: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   9652:        of chapters that explain large parts of pkgsrc, but some
                   9653:        chapters tend to be outdated. Which ones they are is hard to
                   9654:        say.</p></li>
1.128     wiz      9655: <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
1.80      rillig   9656:        about certain features, announcements of new parts of the pkgsrc
                   9657:        infrastructure and sometimes even announcements that a certain
                   9658:        feature has been marked as obsolete. The benefit here is that
                   9659:        each message has a date appended to it.</p></li>
1.128     wiz      9660: <li class="listitem"><p>Many of the files in the
1.80      rillig   9661:        <code class="filename">mk/</code> directory start with a comment that
                   9662:        describes the purpose of the file and how it can be used by the
1.92      rillig   9663:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9664:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9665:        help</strong></span>.</p></li>
1.128     wiz      9666: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   9667:        information, but they tend to be highly abbreviated, especially
                   9668:        for actions that occur often. Some contain a detailed
                   9669:        description of what has changed, but they are geared towards the
                   9670:        other pkgsrc developers, not towards an average pkgsrc user.
                   9671:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9672:        don't know what has been before, these messages may not be worth
                   9673:        too much to you.</p></li>
1.128     wiz      9674: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9675:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   9676:        mind of the developer who wrote the code. To get this
1.110     hubertf  9677:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9678:        to see who has written it and ask on the
                   9679:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9680:        find your questions later (see above). To be sure that the
                   9681:        developer in charge reads the mail, you may CC him or
                   9682:        her.</p></li>
                   9683: </ul></div>
                   9684: </td>
                   9685: </tr>
1.148     asau     9686: <tr class="question">
1.92      rillig   9687: <td align="left" valign="top">
1.219   ! rillig   9688: <a name="devfaq.too-much-time"></a><a name="idm83163168"></a><p><b>22.9.</b></p>
1.92      rillig   9689: </td>
                   9690: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9691: do?</p></td>
                   9692: </tr>
                   9693: <tr class="answer">
                   9694: <td align="left" valign="top"></td>
                   9695: <td align="left" valign="top">
1.93      rillig   9696: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9697: anyway.</p>
1.148     asau     9698: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9699: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.189     snj      9700:     <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
1.92      rillig   9701:     will tell you about newer versions of installed packages that are
                   9702:     available, but not yet updated in pkgsrc.</p></li>
1.128     wiz      9703: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126     jakllsch 9704:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9705:     cleanups and enhancements for pkgsrc that would be nice to
                   9706:     have.</p></li>
1.128     wiz      9707: <li class="listitem"><p>Review packages for which review was requested on
1.180     wiz      9708:     the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92      rillig   9709:     mailing list.</p></li>
                   9710: </ul></div>
                   9711: </td>
                   9712: </tr>
1.75      rillig   9713: </tbody>
                   9714: </table>
                   9715: </div>
                   9716: </div>
1.148     asau     9717: <div class="chapter">
1.85      jmmv     9718: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   9719: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9720: <div class="toc">
                   9721: <p><b>Table of Contents</b></p>
1.210     leot     9722: <dl class="toc">
1.106     rillig   9723: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9724: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9725: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9726: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.85      jmmv     9727: </dl>
                   9728: </div>
1.110     hubertf  9729: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9730: site</a>:</p>
                   9731: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9732:   environment, an intuitive and attractive desktop for users, and the
                   9733:   GNOME development platform, an extensive framework for building
                   9734:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9735: <p>pkgsrc provides a seamless way to automatically build and install
                   9736: a complete GNOME environment <span class="emphasis"><em>under many different
                   9737: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9738: the most advanced build and packaging systems for GNOME due to its
                   9739: included technologies buildlink3, the wrappers and tools framework and
                   9740: automatic configuration file management.  Lots of efforts are put into
                   9741: achieving a completely clean deinstallation of installed software
                   9742: components.</p>
1.110     hubertf  9743: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9744: the above also means that great efforts are put into making GNOME work
1.110     hubertf  9745: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9746: pkgsrc as its preferred packaging system, contributing lots of
                   9747: portability fixes to make GNOME build and install under it.</p>
                   9748: <p>This chapter is aimed at pkgsrc developers and other people
                   9749: interested in helping our GNOME porting and packaging efforts.  It
                   9750: provides instructions on how to manage the existing packages and some
                   9751: important information regarding their internals.</p>
1.148     asau     9752: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85      jmmv     9753: <h3 class="title">We need your help!</h3>
                   9754: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9755:   and GNOME and are willing to learn new exciting stuff, please jump
1.110     hubertf  9756:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9757:   work</a> list!  There is still a long way to go to get a
                   9758:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9759:   achieve it!</p>
                   9760: </div>
1.148     asau     9761: <div class="sect1">
1.85      jmmv     9762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9763: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.85      jmmv     9764: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148     asau     9765: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.189     snj      9766: <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
1.85      jmmv     9767:     the core GNOME desktop environment.  It only includes the necessary
                   9768:     bits to get it to boot correctly, although it may lack important
                   9769:     functionality for daily operation.  The idea behind this package is
                   9770:     to let end users build their own configurations on top of this one,
                   9771:     first installing this meta package to achieve a functional setup and
                   9772:     then adding individual applications.</p></li>
1.189     snj      9773: <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
1.85      jmmv     9774:     complete installation of the GNOME platform and desktop as defined
                   9775:     by the GNOME project; this is based on the components distributed in
                   9776:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9777:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9778:     official FTP server.  Developer-only tools found in those
                   9779:     directories are not installed unless required by some other
                   9780:     component to work properly.  Similarly, packages from the bindings
                   9781:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9782:     in unless required as a dependency for an end-user component.  This
1.189     snj      9783:     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>
                   9784: <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>:
1.85      jmmv     9785:     Installs all the tools required to build a GNOME component when
                   9786:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9787:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9788: </ul></div>
                   9789: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9790: sorted in a way that eases updates: a package may depend on other
                   9791: packages listed before it but not on any listed after it.  It is very
                   9792: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9793: change it to alphabetical sorting!</em></span></p>
                   9794: </div>
1.148     asau     9795: <div class="sect1">
1.85      jmmv     9796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9797: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9798: <p>Almost all GNOME applications are written in C and use a common
                   9799: set of tools as their build system.  Things get different with the new
                   9800: bindings to other languages (such as Python), but the following will
                   9801: give you a general idea on the minimum required tools:</p>
1.148     asau     9802: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9803: <li class="listitem">
1.85      jmmv     9804: <p>Almost all GNOME applications use the GNU Autotools as their
                   9805:     build system.  As a general rule you will need to tell this to your
                   9806:     package:</p>
1.100     rillig   9807: <pre class="programlisting">
                   9808: GNU_CONFIGURE=yes
1.85      jmmv     9809: USE_LIBTOOL=yes
1.100     rillig   9810: USE_TOOLS+=gmake
                   9811: </pre>
1.85      jmmv     9812: </li>
1.128     wiz      9813: <li class="listitem">
1.85      jmmv     9814: <p>If the package uses pkg-config to detect dependencies, add this
                   9815:     tool to the list of required utilities:</p>
                   9816: <pre class="programlisting">USE_TOOLS+=pkg-config</pre>
1.189     snj      9817: <p>Also use <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.85      jmmv     9818:     the end of the build process to ensure that you did not miss to
                   9819:     specify any dependency in your package and that the version
                   9820:     requirements are all correct.</p>
                   9821: </li>
1.128     wiz      9822: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93      rillig   9823:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9824:     to handle dependencies and to force the package to use the latest
                   9825:     available version.</p></li>
1.128     wiz      9826: <li class="listitem">
1.85      jmmv     9827: <p>If the package uses gtk-doc (a documentation generation
                   9828:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9829:     tool is rather big and the distfile should come with pregenerated
                   9830:     documentation anyway; if it does not, it is a bug that you ought to
                   9831:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9832:     the default):</p>
                   9833: <pre class="programlisting">CONFIGURE_ARGS+=--disable-gtk-doc</pre>
                   9834: <p>The default location of installed HTML files
                   9835:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9836:     and should not be changed unless the package insists on installing
                   9837:     them somewhere else.  Otherwise programs as
1.110     hubertf  9838:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   9839:     do that with an entry similar to:</p>
                   9840: <pre class="programlisting">CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...</pre>
1.85      jmmv     9841: </li>
                   9842: </ul></div>
                   9843: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9844: files under the installation prefix to maintain databases.  In this
                   9845: context, shared means that those exact same directories and files are
                   9846: used among several different packages, leading to conflicts in the
                   9847: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9848: handle the most common cases, so you have to forget about using
                   9849: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9850: omitting shared files from them.  If you find yourself doing those,
                   9851: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9852: <p>The following table lists the common situations that result in
                   9853: using shared directories or files.  For each of them, the appropriate
                   9854: solution is given.  After applying the solution be sure to
                   9855: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  9856: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     9857: <div class="table">
1.106     rillig   9858: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.216     tnn      9859: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9860: <colgroup>
                   9861: <col>
                   9862: <col>
                   9863: </colgroup>
                   9864: <thead><tr>
                   9865: <th>If the package...</th>
                   9866: <th>Then...</th>
                   9867: </tr></thead>
                   9868: <tbody>
                   9869: <tr>
                   9870: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.119     mishka   9871: <td>See <a class="xref" href="#scrollkeeper-data-files" title="19.6.10. Packages installing scrollkeeper/rarian data files">Section 19.6.10, &#8220;Packages installing scrollkeeper/rarian data files&#8221;</a>.</td>
1.85      jmmv     9872: </tr>
                   9873: <tr>
                   9874: <td>Installs icons under the
                   9875:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9876:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.110     hubertf  9877: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.85      jmmv     9878: </tr>
                   9879: <tr>
                   9880: <td>Installs files under
                   9881:         <code class="filename">share/mime/packages</code>.</td>
1.110     hubertf  9882: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.85      jmmv     9883: </tr>
                   9884: <tr>
                   9885: <td>Installs <code class="filename">.desktop</code> files under
                   9886:         <code class="filename">share/applications</code> and these include MIME
                   9887:         information.</td>
1.110     hubertf  9888: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.85      jmmv     9889: </tr>
                   9890: </tbody>
1.91      rillig   9891: </table></div>
1.85      jmmv     9892: </div>
1.91      rillig   9893: <br class="table-break">
1.85      jmmv     9894: </div>
1.148     asau     9895: <div class="sect1">
1.85      jmmv     9896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9897: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9898: <p>When seeing GNOME as a whole, there are two kinds of
                   9899: updates:</p>
1.148     asau     9900: <div class="variablelist"><dl class="variablelist">
1.85      jmmv     9901: <dt><span class="term">Major update</span></dt>
                   9902: <dd>
                   9903: <p>Given that there is still a very long way for GNOME 3 (if it
                   9904:       ever appears), we consider a major update one that goes from a
                   9905:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9906:       where <code class="literal">Y</code> is even and greater than
                   9907:       <code class="literal">X</code>.  These are hard to achieve because they
                   9908:       introduce lots of changes in the components' code and almost all
                   9909:       GNOME distfiles are updated to newer versions.  Some of them can
                   9910:       even break API and ABI compatibility with the previous major
                   9911:       version series.  As a result, the update needs to be done all at
                   9912:       once to minimize breakage.</p>
                   9913: <p>A major update typically consists of around 80 package
                   9914:       updates and the addition of some new ones.</p>
                   9915: </dd>
                   9916: <dt><span class="term">Minor update</span></dt>
                   9917: <dd>
                   9918: <p>We consider a minor update one that goes from a
                   9919:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9920:       one where <code class="literal">Y</code> is greater than
                   9921:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9922:       not update all GNOME components, can be done in an incremental way
                   9923:       and do not break API nor ABI compatibility.</p>
                   9924: <p>A minor update typically consists of around 50 package
                   9925:       updates, although the numbers here may vary a lot.</p>
                   9926: </dd>
                   9927: </dl></div>
                   9928: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9929: release (either major or minor), the following steps should be
                   9930: followed:</p>
1.128     wiz      9931: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9932: <li class="listitem">
1.85      jmmv     9933: <p>Get a list of all the tarballs that form the new release by
                   9934:     using the following commands.  These will leave the full list of the
1.120     snj      9935:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     9936:     file:</p>
1.88      wiz      9937: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9938:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9939:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9940: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9941:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9942:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9943: </li>
1.128     wiz      9944: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85      jmmv     9945:     bump their version to the release you are updating them to.  The
                   9946:     three meta packages should be always consistent with versioning.
                   9947:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9948:     in them.</p></li>
1.128     wiz      9949: <li class="listitem">
1.85      jmmv     9950: <p>For each meta package, update all its
                   9951:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9952:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9953:     newer version (even if found in the FTP) because the meta packages
                   9954:     are supposed to list the exact versions that form a specific GNOME
                   9955:     release.  Exceptions are permitted here if a newer version solves a
                   9956:     serious issue in the overall desktop experience; these typically
                   9957:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9958:     from the developers.</p>
                   9959: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9960:     should be updated to the latest version available (if found in
                   9961:     pkgsrc).  This is the case, for example, of the dependencies on the
1.189     snj      9962:     GNU Autotools in the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.85      jmmv     9963: </li>
1.128     wiz      9964: <li class="listitem">
1.85      jmmv     9965: <p>Generate a patch from the modified meta packages and extract the
                   9966:     list of "new" lines.  This will provide you an outline on what
                   9967:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9968: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs diff -u gnome-devel gnome-base gnome | grep '^+D' &gt;todo.txt</code></strong></pre>
1.85      jmmv     9969: </li>
1.128     wiz      9970: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85      jmmv     9971:     installed packages and start over from scratch at this point.</p></li>
1.128     wiz      9972: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85      jmmv     9973:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9974:     it in order.  For major desktop updates none of these should be
1.93      rillig   9975:     committed until the entire set is completed because there are chances
1.85      jmmv     9976:     of breaking not-yet-updated packages.</p></li>
1.128     wiz      9977: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85      jmmv     9978:     the tree one by one with appropriate log messages.  At the end,
                   9979:     commit the three meta package updates and all the corresponding
                   9980:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9981:     <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>
                   9982: </ol></div>
                   9983: </div>
1.148     asau     9984: <div class="sect1">
1.85      jmmv     9985: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   9986: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9987: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9988: packages.  Please, it is very important that you always, always,
                   9989: <span class="strong"><strong>always</strong></span> feed back any portability
1.110     hubertf  9990: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.85      jmmv     9991: their attention on portability issues and to ensure that future versions
                   9992: can be built out-of-the box on NetBSD.  The less custom patches in
                   9993: pkgsrc, the easier further updates are.  Those developers in charge of
                   9994: issuing major GNOME updates will be grateful if you do that.</p>
1.110     hubertf  9995: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85      jmmv     9996: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9997: of them do.  Do not be short on your reports: always provide detailed
                   9998: explanations of the current failure, how it can be improved to achieve
                   9999: maximum portability and, if at all possible, provide a patch against CVS
                   10000: head.  The more verbose you are, the higher chances of your patch being
                   10001: accepted.</p>
                   10002: <p>Also, please avoid using preprocessor magic to fix portability
                   10003: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   10004: GNOME to their operating system, the official GNOME sources are now
                   10005: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   10006: and similar macros.  This hurts portability.  Please see our patching
1.110     hubertf  10007: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.85      jmmv     10008: details.</p>
                   10009: </div>
                   10010: </div>
1.75      rillig   10011: </div>
1.148     asau     10012: <div class="part">
1.75      rillig   10013: <div class="titlepage"><div><div><h1 class="title">
                   10014: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10015: <div class="partintro">
1.75      rillig   10016: <div></div>
                   10017: <p>This part of the guide deals with everything
                   10018:        from the infrastructure that is behind the interfaces described
                   10019:        in the developer's guide. A casual package maintainer should not
                   10020:        need anything from this part.</p>
                   10021: <div class="toc">
                   10022: <p><b>Table of Contents</b></p>
1.210     leot     10023: <dl class="toc">
1.106     rillig   10024: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10025: <dd><dl>
1.106     rillig   10026: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10027: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10028: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.75      rillig   10029: <dd><dl>
1.106     rillig   10030: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10031: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.75      rillig   10032: </dl></dd>
1.106     rillig   10033: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10034: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10035: <dd><dl>
1.106     rillig   10036: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10037: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10038: </dl></dd>
1.106     rillig   10039: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10040: <dd><dl>
1.128     wiz      10041: <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>
                   10042: <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>
1.75      rillig   10043: </dl></dd>
                   10044: </dl></dd>
1.106     rillig   10045: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.75      rillig   10046: <dd><dl>
1.219   ! rillig   10047: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
        !          10048: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig   10049: <dd><dl>
1.219   ! rillig   10050: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
        !          10051: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig   10052: </dl></dd>
                   10053: </dl></dd>
1.106     rillig   10054: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.219   ! rillig   10055: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig   10056: </dl>
                   10057: </div>
                   10058: </div>
1.148     asau     10059: <div class="chapter">
1.75      rillig   10060: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10061: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10062: <div class="toc">
                   10063: <p><b>Table of Contents</b></p>
1.210     leot     10064: <dl class="toc">
1.106     rillig   10065: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   10066: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   10067: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.81      rillig   10068: <dd><dl>
1.106     rillig   10069: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   10070: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.81      rillig   10071: </dl></dd>
1.106     rillig   10072: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   10073: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10074: <dd><dl>
1.106     rillig   10075: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   10076: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10077: </dl></dd>
1.106     rillig   10078: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10079: <dd><dl>
1.128     wiz      10080: <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>
                   10081: <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>
1.75      rillig   10082: </dl></dd>
                   10083: </dl>
                   10084: </div>
                   10085: <p>The pkgsrc infrastructure consists of many small Makefile
                   10086:        fragments. Each such fragment needs a properly specified
                   10087:        interface. This chapter explains how such an interface looks
                   10088:        like.</p>
1.148     asau     10089: <div class="sect1">
1.75      rillig   10090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10091: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10092: <p>Whenever a variable is defined in the pkgsrc
                   10093:        infrastructure, the location and the way of definition provide
                   10094:        much information about the intended use of that variable.
                   10095:        Additionally, more documentation may be found in a header
                   10096:        comment or in this pkgsrc guide.</p>
                   10097: <p>A special file is
                   10098:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10099:        variables that are intended to be user-defined. They are either
                   10100:        defined using the <code class="literal">?=</code> operator or they are
                   10101:        left undefined because defining them to anything would
1.128     wiz      10102:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   10103:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10104:        file.</p>
                   10105: <p>Outside this file, the following conventions apply:
                   10106:        Variables that are defined using the <code class="literal">?=</code>
                   10107:        operator may be overridden by a package.</p>
                   10108: <p>Variables that are defined using the <code class="literal">=</code>
                   10109:        operator may be used read-only at run-time.</p>
                   10110: <p>Variables whose name starts with an underscore must not be
                   10111:        accessed outside the pkgsrc infrastructure at all. They may
                   10112:        change without further notice.</p>
1.148     asau     10113: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10114: <h3 class="title">Note</h3>
                   10115: <p>These conventions are currently not applied
                   10116:        consistently to the complete pkgsrc
                   10117:        infrastructure.</p>
                   10118: </div>
                   10119: </div>
1.148     asau     10120: <div class="sect1">
1.81      rillig   10121: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10122: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10123: <p>All variables that contain lists of things should default
                   10124:        to being empty. Two examples that do not follow this rule are
                   10125:        <code class="varname">USE_LANGUAGES</code> and
                   10126:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10127:        modified using the <code class="literal">+=</code> operator in package
                   10128:        <code class="filename">Makefile</code>s (or other files included by
                   10129:        them), since there is no guarantee whether the variable is
                   10130:        already set or not, and what its value is. In the case of
1.128     wiz      10131:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   10132:        the default value and just define it as in the following
                   10133:        example.</p>
                   10134: <pre class="programlisting">
1.100     rillig   10135: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10136: </pre>
                   10137: <p>Because of the selection of this default value, the same
                   10138:        value appears in many package Makefiles. Similarly for
                   10139:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      10140:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   10141:        doesn't stand out. Nevertheless it is mentioned in many
                   10142:        files.</p>
                   10143: </div>
1.148     asau     10144: <div class="sect1">
1.81      rillig   10145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10146: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.148     asau     10147: <div class="sect2">
1.75      rillig   10148: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10149: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.75      rillig   10150: <p>Variable evaluation takes place either at load time or at
                   10151:        runtime, depending on the context in which they occur. The
                   10152:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10153: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10154: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10155:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10156: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10157:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10158: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10159: </ul></div>
                   10160: <p>A special exception are references to the iteration
                   10161:        variables of <code class="literal">.for</code> loops, which are expanded
                   10162:        inline, no matter in which context they appear.</p>
                   10163: <p>As the values of variables may change during load time,
                   10164:        care must be taken not to evaluate them by accident. Typical
                   10165:        examples for variables that should not be evaluated at load time
                   10166:        are <code class="varname">DEPENDS</code> and
                   10167:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10168:        clear, here is an example:</p>
                   10169: <pre class="programlisting">
1.100     rillig   10170: CONFIGURE_ARGS=         # none
                   10171: CFLAGS=                 -O
                   10172: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10173: 
1.100     rillig   10174: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10175: 
1.100     rillig   10176: CFLAGS+=                -Wall
1.75      rillig   10177:        </pre>
                   10178: <p>This code shows how the use of the <code class="literal">:=</code>
                   10179:        operator can quickly lead to unexpected results. The first
                   10180:        paragraph is fairly common code. The second paragraph evaluates
                   10181:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10182:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10183:        <code class="literal">-Wall</code> is appended to the
                   10184:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10185:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10186:        paragraphs from above typically occur in completely unrelated
                   10187:        files.</p>
                   10188: </div>
1.148     asau     10189: <div class="sect2">
1.75      rillig   10190: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10191: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.75      rillig   10192: <p>After all the files have been loaded, the values of the
                   10193:        variables cannot be changed anymore. Variables that are used in
                   10194:        the shell commands are expanded at this point.</p>
                   10195: </div>
                   10196: </div>
1.148     asau     10197: <div class="sect1">
1.75      rillig   10198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10199: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10200: <p>There are many ways in which the definition and use of a
1.218     rillig   10201:        variable can be restricted in order to detect bugs and violations
                   10202:        of the (mostly unwritten) policies. A package can be checked with
                   10203:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10204:        rules.</p>
1.78      rillig   10205: </div>
1.148     asau     10206: <div class="sect1">
1.78      rillig   10207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10208: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10209: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10210:        of the following classes. Cases where a file falls into more
                   10211:        than one class should be avoided as it often leads to subtle
                   10212:        bugs.</p>
1.148     asau     10213: <div class="sect2">
1.75      rillig   10214: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10215: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10216: <p>In a traditional imperative programming language some of
1.76      rillig   10217:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10218:        procedures. They take some input parameters and&mdash;after
                   10219:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10220:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10221:        care must be taken not to use parameter names that have already
                   10222:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10223:        bad choice for a parameter name.</p>
                   10224: <p>Procedures are completely evaluated at preprocessing time.
                   10225:        That is, when calling a procedure all input parameters must be
                   10226:        completely resolvable. For example,
                   10227:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10228:        parameter since it is very likely that further text will be
                   10229:        added after calling the procedure, which would effectively apply
                   10230:        the procedure to only a part of the variable. Also, references
1.218     rillig   10231:        to other variables will be modified after calling the
1.75      rillig   10232:        procedure.</p>
                   10233: <p>A procedure can declare its output parameters either as
                   10234:        suitable for use in preprocessing directives or as only
                   10235:        available at runtime. The latter alternative is for variables
                   10236:        that contain references to other runtime variables.</p>
                   10237: <p>Procedures shall be written such that it is possible to
                   10238:        call the procedure more than once. That is, the file must not
                   10239:        contain multiple-inclusion guards.</p>
                   10240: <p>Examples for procedures are
1.76      rillig   10241:        <code class="filename">mk/bsd.options.mk</code> and
                   10242:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10243:        that the parameters are evaluated at load time, they should be
                   10244:        assigned using the <code class="literal">:=</code> operator, which should
                   10245:        be used only for this purpose.</p>
                   10246: </div>
1.148     asau     10247: <div class="sect2">
1.75      rillig   10248: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10249: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10250: <p>Action files take some input parameters and may define
                   10251:        runtime variables. They shall not define loadtime variables.
                   10252:        There are action files that are included implicitly by the
                   10253:        pkgsrc infrastructure, while other must be included
                   10254:        explicitly.</p>
                   10255: <p>An example for action files is
1.76      rillig   10256:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10257: </div>
                   10258: </div>
1.148     asau     10259: <div class="sect1">
1.81      rillig   10260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10261: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10262: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10263:        a set of variable definitions, and include the file
                   10264:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10265:        Before that, they may also include various other
                   10266:        <code class="filename">*.mk</code> files if they need to query the
                   10267:        availability of certain features like the type of compiler or
                   10268:        the X11 implementation. Due to the heavy use of preprocessor
                   10269:        directives like <code class="literal">.if</code> and
                   10270:        <code class="literal">.for</code>, the order in which the files are loaded
                   10271:        matters.</p>
                   10272: <p>This section describes at which point the various files
                   10273:        are loaded and gives reasons for that order.</p>
1.148     asau     10274: <div class="sect2">
1.81      rillig   10275: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10276: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10277: </h3></div></div></div>
                   10278: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10279:        is to define some essential variables like
                   10280:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10281:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10282: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10283:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104     rillig   10284:        After that, those variables
1.81      rillig   10285:        that have not been overridden by the user are loaded from
                   10286:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10287: <p>After the user settings, the system settings and platform
                   10288:        settings are loaded, which may override the user
                   10289:        settings.</p>
                   10290: <p>Then, the tool definitions are loaded. The tool wrappers
                   10291:        are not yet in effect. This only happens when building a
                   10292:        package, so the proper variables must be used instead of the
                   10293:        direct tool names.</p>
                   10294: <p>As the last steps, some essential variables from the
                   10295:        wrapper and the package system flavor are loaded, as well as the
                   10296:        variables that have been cached in earlier phases of a package
                   10297:        build.</p>
                   10298: </div>
1.148     asau     10299: <div class="sect2">
1.81      rillig   10300: <div class="titlepage"><div><div><h3 class="title">
1.106     rillig   10301: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10302: </h3></div></div></div>
1.81      rillig   10303: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10304: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10305:        loaded, which fill default values for those variables that have
1.93      rillig   10306:        not been defined by the package. These variables may later
1.81      rillig   10307:        be used even in unrelated files.</p>
                   10308: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10309:        provides the target <code class="literal">error-check</code> that is added
                   10310:        as a special dependency to all other targets that use
                   10311:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10312:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10313: <p>Then, the package-specific hacks from
                   10314:        <code class="filename">hacks.mk</code> are included.</p>
                   10315: <p>Then, various other files follow. Most of them don't have
                   10316:        any dependencies on what they need to have included before or
                   10317:        after them, though some do.</p>
                   10318: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10319:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10320:        restricts the use of these variables to all the files that have
                   10321:        been included before. Appearances in later files will be
                   10322:        silently ignored.</p>
                   10323: <p>Then, the files for the main targets are included, in the
                   10324:        order of later execution, though the actual order should not
                   10325:        matter.</p>
                   10326: <p>At last, some more files are included that don't set any
                   10327:        interesting variables but rather just define make targets to be
                   10328:        executed.</p>
                   10329: </div>
                   10330: </div>
1.75      rillig   10331: </div>
1.148     asau     10332: <div class="chapter">
1.75      rillig   10333: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10334: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.75      rillig   10335: <div class="toc">
                   10336: <p><b>Table of Contents</b></p>
1.210     leot     10337: <dl class="toc">
1.219   ! rillig   10338: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
        !          10339: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.75      rillig   10340: <dd><dl>
1.219   ! rillig   10341: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
        !          10342: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.75      rillig   10343: </dl></dd>
                   10344: </dl>
                   10345: </div>
                   10346: <p>The pkgsrc infrastructure consists of a large codebase,
                   10347:        and there are many corners where every little bit of a file is
                   10348:        well thought out, making pkgsrc likely to fail as soon as
                   10349:        anything is changed near those parts. To prevent most changes
                   10350:        from breaking anything, a suite of regression tests should go
                   10351:        along with every important part of the pkgsrc infrastructure.
                   10352:        This chapter describes how regression tests work in pkgsrc and
                   10353:        how you can add new tests.</p>
1.148     asau     10354: <div class="sect1">
1.75      rillig   10355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219   ! rillig   10356: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.189     snj      10357: <p>You first need to install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  10358:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10359:        can simply run that command, which will run all tests in the
1.76      rillig   10360:        <code class="filename">regress</code> category.</p>
1.75      rillig   10361: </div>
1.148     asau     10362: <div class="sect1">
1.75      rillig   10363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.219   ! rillig   10364: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.76      rillig   10365: <p>Every directory in the <code class="filename">regress</code>
                   10366:        category that contains a file called <code class="filename">spec</code>
1.75      rillig   10367:        is considered a regression test. This file is a shell program
1.110     hubertf  10368:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10369:        The following functions can be overridden to suit your
                   10370:        needs.</p>
1.148     asau     10371: <div class="sect2">
1.75      rillig   10372: <div class="titlepage"><div><div><h3 class="title">
1.219   ! rillig   10373: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   10374: <p>These functions do not take any parameters. Although they
                   10375:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
                   10376:        first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
                   10377:        question</a> for details.</p>
1.148     asau     10378: <div class="variablelist"><dl class="variablelist">
1.218     rillig   10379: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   10380: <dd><p>This function prepares the environment for the
                   10381:        test. By default it does nothing.</p></dd>
1.218     rillig   10382: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10383: <dd>
                   10384: <p>This function runs the actual test. By default,
1.75      rillig   10385:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10386:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10387:        error messages into the file
1.218     rillig   10388:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10389: <p>When defining this function, make sure that all output that
                   10390:        needs to be checked is written to the correct output file.
                   10391:        Example:</p>
                   10392: <pre class="programlisting">
                   10393: do_test() {
                   10394:        echo "Example output"
                   10395: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10396: </pre>
                   10397: </dd>
                   10398: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10399: <dd>
                   10400: <p>This function is run after the test and is
1.75      rillig   10401:        typically used to compare the actual output from the one that is
                   10402:        expected. It can make use of the various helper functions from
1.218     rillig   10403:        the next section. Example:</p>
                   10404: <pre class="programlisting">
                   10405: check_result() {
                   10406:        exit_status 0
                   10407:        output_require "Example"
                   10408:        output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10409:        output_prohibit "no such file or directory"
                   10410: }
                   10411: </pre>
                   10412: </dd>
                   10413: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   10414: <dd><p>This function cleans everything up after the
                   10415:        test has been run. By default it does nothing.</p></dd>
                   10416: </dl></div>
                   10417: </div>
1.148     asau     10418: <div class="sect2">
1.75      rillig   10419: <div class="titlepage"><div><div><h3 class="title">
1.219   ! rillig   10420: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.148     asau     10421: <div class="variablelist"><dl class="variablelist">
1.218     rillig   10422: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   10423: <dd><p>This function compares the exitcode of the
1.218     rillig   10424:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   10425:        If they differ, the test will fail.</p></dd>
1.218     rillig   10426: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10427: <dd>
                   10428: <p>This function checks for each of its parameters
                   10429:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   10430:        extended regular expression. If it does not, the test will
1.218     rillig   10431:        fail. Example:</p>
                   10432: <pre class="programlisting">
1.219   ! rillig   10433: output_require "looks fine"
        !          10434: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   10435: </pre>
                   10436: </dd>
1.75      rillig   10437: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10438: <dd><p>This function checks for each of its parameters
1.110     hubertf  10439:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10440:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10441:        If any of the regular expressions matches, the test will
                   10442:        fail.</p></dd>
                   10443: </dl></div>
                   10444: </div>
                   10445: </div>
                   10446: </div>
1.148     asau     10447: <div class="chapter">
1.75      rillig   10448: <div class="titlepage"><div><div><h2 class="title">
1.106     rillig   10449: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10450: <div class="toc">
                   10451: <p><b>Table of Contents</b></p>
1.219   ! rillig   10452: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">26.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75      rillig   10453: </div>
                   10454: <p>The pkgsrc system has already been ported to many
                   10455:        operating systems, hardware architectures and compilers. This
                   10456:        chapter explains the necessary steps to make pkgsrc even more
                   10457:        portable.</p>
1.148     asau     10458: <div class="sect1">
1.75      rillig   10459: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.106     rillig   10460: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10461: <p>To port pkgsrc to a new operating system (called
                   10462:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10463:        following files:</p>
1.148     asau     10464: <div class="variablelist"><dl class="variablelist">
1.93      rillig   10465: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75      rillig   10466: <dd><p>This file contains some basic definitions, for
                   10467:        example the name of the C
                   10468:        compiler.</p></dd>
1.76      rillig   10469: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10470: <dd><p>Insert code that defines the variables
                   10471:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10472:        <code class="varname">LOWER_OS_VERSION</code>,
                   10473:        <code class="varname">LOWER_VENDOR</code>,
                   10474:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10475:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10476:        appear in this file.</p></dd>
1.93      rillig   10477: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10478: <dd><p>This file contains the platform-specific
                   10479:        definitions that are used by pkgsrc. Start by copying one of the
                   10480:        other files and edit it to your
                   10481:        needs.</p></dd>
1.93      rillig   10482: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10483: <dd><p>This file defines the paths to all the tools
                   10484:        that are needed by one or the other package in pkgsrc, as well
                   10485:        as by pkgsrc itself. Find out where these tools are on your
                   10486:        platform and add them.</p></dd>
                   10487: </dl></div>
                   10488: <p>Now, you should be able to build some basic packages, like
1.189     snj      10489:        <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10490: </div>
                   10491: </div>
                   10492: </div>
1.148     asau     10493: <div class="appendix">
                   10494: <div class="titlepage"><div><div><h1 class="title">
                   10495: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10496: <div class="toc">
                   10497: <p><b>Table of Contents</b></p>
1.210     leot     10498: <dl class="toc">
1.75      rillig   10499: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10500: <dd><dl>
                   10501: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10502: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10503: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.128     wiz      10504: <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>
1.75      rillig   10505: </dl></dd>
                   10506: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10507: </dl>
                   10508: </div>
                   10509: <p>We checked to find a piece of software that wasn't in the packages
                   10510:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10511:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10512:     present in the tree is beyond us, but it's useful for the purposes of
                   10513:     this exercise.</p>
1.148     asau     10514: <div class="sect1">
1.75      rillig   10515: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10516: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10517: <div class="sect2">
1.75      rillig   10518: <div class="titlepage"><div><div><h3 class="title">
                   10519: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10520: <pre class="programlisting">
1.100     rillig   10521: # $NetBSD$
                   10522: #
1.1       grant    10523: 
1.100     rillig   10524: DISTNAME=       bison-1.25
                   10525: CATEGORIES=     devel
                   10526: MASTER_SITES=   ${MASTER_SITE_GNU}
1.1       grant    10527: 
1.136     dholland 10528: MAINTAINER=     pkgsrc-users@NetBSD.org
1.100     rillig   10529: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10530: COMMENT=        GNU yacc clone
1.1       grant    10531: 
1.100     rillig   10532: GNU_CONFIGURE=  yes
1.152     wiz      10533: INFO_FILES=     yes
1.1       grant    10534: 
1.100     rillig   10535: .include "../../mk/bsd.pkg.mk"
1.1       grant    10536: </pre>
1.75      rillig   10537: </div>
1.148     asau     10538: <div class="sect2">
1.75      rillig   10539: <div class="titlepage"><div><div><h3 class="title">
                   10540: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10541: <pre class="programlisting">
1.100     rillig   10542: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.189     snj      10543: 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
1.100     rillig   10544: of the NetBSD source tree is beyond me.
1.1       grant    10545: </pre>
1.75      rillig   10546: </div>
1.148     asau     10547: <div class="sect2">
1.75      rillig   10548: <div class="titlepage"><div><div><h3 class="title">
                   10549: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10550: <pre class="programlisting">
1.100     rillig   10551: @comment $NetBSD$
                   10552: bin/bison
                   10553: man/man1/bison.1.gz
                   10554: share/bison.simple
                   10555: share/bison.hairy
1.1       grant    10556: </pre>
1.75      rillig   10557: </div>
1.148     asau     10558: <div class="sect2">
1.75      rillig   10559: <div class="titlepage"><div><div><h3 class="title">
1.110     hubertf  10560: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.93      rillig   10561: </h3></div></div></div>
1.75      rillig   10562: <p>The NetBSD package system comes with
1.189     snj      10563:         <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10564:        which helps to check the contents of these
                   10565:        files. After installation it is quite easy to use, just change to the
                   10566:        directory of the package you wish to examine and execute
1.110     hubertf  10567:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10568: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10569: looks fine.</pre>
                   10570: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.110     hubertf  10571:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.75      rillig   10572:        -Wall</strong></span> for a very thorough check.</p>
                   10573: </div>
                   10574: </div>
1.148     asau     10575: <div class="sect1">
1.75      rillig   10576: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10577: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10578: <p>Create the directory where the package lives,
                   10579:       plus any auxiliary directories:</p>
                   10580: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10581: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10582: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10583: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10584: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.110     hubertf  10585:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10586:       then continue with fetching the distfile:</p>
                   10587: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10588: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10589: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10590: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10591: ftp: Error retrieving file: 500 Internal error
                   10592: 
                   10593: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10594: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10595: ftp: Error retrieving file: 500 Internal error
                   10596: 
                   10597: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10598: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10599: Successfully retrieved file.</pre>
                   10600: <p>Generate the checksum of the distfile into
1.76      rillig   10601:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10602: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10603: <p>Now compile:</p>
                   10604: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10605: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10606: ===&gt;  Extracting for bison-1.25
                   10607: ===&gt;  Patching for bison-1.25
                   10608: ===&gt;   Ignoring empty patch directory
                   10609: ===&gt;  Configuring for bison-1.25
                   10610: creating cache ./config.cache
                   10611: checking for gcc... cc
                   10612: checking whether we are using GNU C... yes
                   10613: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10614: checking how to run the C preprocessor... cc -E
                   10615: checking for minix/config.h... no
                   10616: checking for POSIXized ISC... no
                   10617: checking whether cross-compiling... no
                   10618: checking for ANSI C header files... yes
                   10619: checking for string.h... yes
                   10620: checking for stdlib.h... yes
                   10621: checking for memory.h... yes
                   10622: checking for working const... yes
                   10623: checking for working alloca.h... no
                   10624: checking for alloca... yes
                   10625: checking for strerror... yes
                   10626: updating cache ./config.cache
                   10627: creating ./config.status
                   10628: creating Makefile
                   10629: ===&gt;  Building for bison-1.25
                   10630: 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
                   10631: 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
                   10632: 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
                   10633: 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
                   10634: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10635: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\"  -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1  -g  ./files.c
1.1       grant    10636: 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
                   10637: 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
                   10638: 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
                   10639: 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
                   10640: 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
                   10641: 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
                   10642: 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
                   10643: 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
                   10644: 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
                   10645: 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
                   10646: 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
                   10647: 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
                   10648: 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
                   10649: 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
                   10650: 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
                   10651: 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
                   10652: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10653: rm -f bison.s1
1.75      rillig   10654: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10655: <p>Everything seems OK, so install the files:</p>
                   10656: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10657: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10658: ===&gt;  Installing for bison-1.25
                   10659: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10660: rm -f /usr/pkg/bin/bison
                   10661: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10662: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10663: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10664: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10665: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10666: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10667: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10668: ===&gt;  Registering installation for bison-1.25</pre>
                   10669: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10670:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10671:       binary package, do this now:</p>
                   10672: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10673: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10674: ===&gt;  Building package for bison-1.25
                   10675: Creating package bison-1.25.tgz
                   10676: Registering depends:.
1.75      rillig   10677: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10678: <p>Now that you don't need the source and object files
                   10679:       any more, clean up:</p>
                   10680: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10681: ===&gt;  Cleaning for bison-1.25</pre>
                   10682: </div>
                   10683: </div>
1.148     asau     10684: <div class="appendix">
                   10685: <div class="titlepage"><div><div><h1 class="title">
                   10686: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10687: <div class="toc">
                   10688: <p><b>Table of Contents</b></p>
1.210     leot     10689: <dl class="toc">
1.75      rillig   10690: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10691: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10692: </dl>
                   10693: </div>
1.148     asau     10694: <div class="sect1">
1.75      rillig   10695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10696: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10697: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10698: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10699: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10700: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10701: =&gt; [172219 bytes]
                   10702: Connected to ftp.plig.net.
                   10703: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10704: 331 Guest login ok, send your complete e-mail address as password.
                   10705: 230-You are user #5 of 500 simultaneous users allowed.
                   10706: 230-
1.68      rillig   10707: 230-  ___ _             _ _
                   10708: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10709: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10710: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10711: 230-         |_|   |_|     |___|         |___|
                   10712: 230-
                   10713: 230-** Welcome to ftp.plig.org **
                   10714: 230-
                   10715: 230-Please note that all transfers from this FTP site are logged. If you
                   10716: 230-do not like this, please disconnect now.
                   10717: 230-
1.120     snj      10718: 230-This archive is available via
1.1       grant    10719: 230-
                   10720: 230-HTTP:  http://ftp.plig.org/
                   10721: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10722: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10723: 230-
                   10724: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10725: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10726: 230-
                   10727: 230-
                   10728: 230 Logged in anonymously.
                   10729: Remote system type is UNIX.
                   10730: Using binary mode to transfer files.
                   10731: 200 Type okay.
                   10732: 250 "/pub" is new cwd.
                   10733: 250-"/pub/figlet" is new cwd.
                   10734: 250-
                   10735: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10736: 250-
1.75      rillig   10737: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10738: 250-
                   10739: 250-The official FIGlet web page is:
1.75      rillig   10740: 250-   http://www.figlet.org/
1.1       grant    10741: 250-
                   10742: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10743: 250-contribute a font or something else, you can email us.
1.68      rillig   10744: 250
1.1       grant    10745: 250 "/pub/figlet/program" is new cwd.
                   10746: 250 "/pub/figlet/program/unix" is new cwd.
                   10747: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10748: 502 Unimplemented command.
                   10749: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10750: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10751: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10752: 226 Transfer completed.
                   10753: 172219 bytes received in 00:02 (75.99 KB/s)
                   10754: 221 Goodbye.
                   10755: =&gt; Checksum OK for figlet221.tar.gz.
                   10756: ===&gt; Extracting for figlet-2.2.1nb2
                   10757: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10758: ===&gt; Patching for figlet-2.2.1nb2
                   10759: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10760: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10761: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10762: ===&gt; Configuring for figlet-2.2.1nb2
                   10763: ===&gt; Building for figlet-2.2.1nb2
                   10764: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10765: chmod a+x figlet
                   10766: gcc -O2 -o chkfont chkfont.c
                   10767: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10768: <code class="prompt">#</code>
1.75      rillig   10769: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10770: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10771: ===&gt; Installing for figlet-2.2.1nb2
                   10772: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10773: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10774: mkdir -p /usr/pkg/share/figlet
                   10775: cp figlet /usr/pkg/bin
                   10776: cp chkfont /usr/pkg/bin
                   10777: chmod 555 figlist showfigfonts
                   10778: cp figlist /usr/pkg/bin
                   10779: cp showfigfonts /usr/pkg/bin
                   10780: cp fonts/*.flf /usr/pkg/share/figlet
                   10781: cp fonts/*.flc /usr/pkg/share/figlet
                   10782: cp figlet.6 /usr/pkg/man/man6
                   10783: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10784: <code class="prompt">#</code></pre>
                   10785: </div>
1.148     asau     10786: <div class="sect1">
1.75      rillig   10787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10788: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10789: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10790: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10791: ===&gt; Packaging figlet-2.2.1nb2
                   10792: ===&gt; Building binary package for figlet-2.2.1nb2
                   10793: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10794: Using SrcDir value of /usr/pkg
1.68      rillig   10795: Registering depends:.
1.75      rillig   10796: <code class="prompt">#</code></pre>
                   10797: </div>
                   10798: </div>
1.148     asau     10799: <div class="appendix">
                   10800: <div class="titlepage"><div><div><h1 class="title">
                   10801: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   10802: <div class="toc">
                   10803: <p><b>Table of Contents</b></p>
1.210     leot     10804: <dl class="toc">
1.128     wiz      10805: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10806: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10807: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10808: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10809: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   10810: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10811: source packages</a></span></dt>
                   10812: </dl>
                   10813: </div>
                   10814: <p>As in other big projects, the directory layout of pkgsrc
                   10815:        is quite complex for newbies. This chapter explains where you
                   10816:        find things on the FTP server. The base directory on
1.110     hubertf  10817:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89      rillig   10818:        On other servers it may be different, but inside this directory,
                   10819:        everything should look the same, no matter on which server you
                   10820:        are. This directory contains some subdirectories, which are
                   10821:        explained below.</p>
1.148     asau     10822: <div class="sect1">
1.76      rillig   10823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10824: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   10825: <p>The directory <code class="filename">distfiles</code> contains lots
                   10826:        of archive files from all pkgsrc packages, which are mirrored
                   10827:        here. The subdirectories are called after their package names
                   10828:        and are used when the distributed files have names that don't
                   10829:        explicitly contain a version number or are otherwise too generic
                   10830:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10831: </div>
1.148     asau     10832: <div class="sect1">
1.76      rillig   10833: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10834: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   10835: <p>This directory contains things that individual pkgsrc
                   10836:        developers find worth publishing.</p>
                   10837: </div>
1.148     asau     10838: <div class="sect1">
1.76      rillig   10839: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10840: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   10841: <p>This directory contains binary packages for the various
                   10842:        platforms that are supported by pkgsrc.
                   10843:        Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.148     asau     10844: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10845: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10846:        operating system for which the packages have been built. The
1.110     hubertf  10847:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10848:        command, so it may differ from the one you are used to
                   10849:        hear.</p></li>
1.128     wiz      10850: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   10851:        architecture of the platform for which the packages have been
1.110     hubertf  10852:        built. It also includes the <code class="varname">ABI</code> (Application
                   10853:        Binary Interface) for platforms that have several of
                   10854:        them.</p></li>
1.128     wiz      10855: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   10856:        the operating system. For version numbers that change often (for
                   10857:        example NetBSD-current), the often-changing part should be
                   10858:        replaced with an <code class="literal">x</code>, for example
                   10859:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      10860: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 10861:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   10862:        for a stable branch, or <code class="literal">head</code> for packages
                   10863:        built from the HEAD branch. The latter should only be used when
                   10864:        the packages are updated on a regular basis. Otherwise the date
                   10865:        from checking out pkgsrc should be appended, for example
                   10866:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   10867: </ul></div>
                   10868: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10869:        can quickly click through the directories on the
                   10870:        server and find the best binary packages for their machines. Since they
                   10871:        usually know the operating system and the hardware architecture, OPSYS
                   10872:        and ARCH are placed first. After these choices, they can select the
                   10873:        best combination of OSVERSION and TAG together, since it is usually the
                   10874:        case that packages stay compatible between different version of the
                   10875:        operating system.</p>
                   10876: <p>In each of these directories, there is a
                   10877:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10878:        <code class="filename">All</code> which contains all binary packages.
                   10879:        Besides that, there are various category directories that
                   10880:        contain symbolic links to the real binary packages.</p>
                   10881: </div>
1.148     asau     10882: <div class="sect1">
1.76      rillig   10883: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10884: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   10885: <p>Here are the reports from bulk builds, for those who want
                   10886:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      10887:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   10888: </div>
1.148     asau     10889: <div class="sect1">
1.108     rillig   10890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10891: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   10892: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10893: source packages</h2></div></div></div>
1.128     wiz      10894: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   10895:        that is the files that define how to create binary packages from
                   10896:        source archives.</p>
                   10897: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10898:        snapshot of the CVS repository, which is updated regularly. The
                   10899:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10900:        directory, ready to be downloaded as a whole.</p>
1.76      rillig   10901: <p>In the directories for the quarterly branches, there is an
                   10902:        additional file called
1.126     jakllsch 10903:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.76      rillig   10904:        which contains the state of pkgsrc when it was branched.</p>
                   10905: </div>
1.75      rillig   10906: </div>
1.148     asau     10907: <div class="appendix">
                   10908: <div class="titlepage"><div><div><h1 class="title">
                   10909: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   10910: <div class="toc">
                   10911: <p><b>Table of Contents</b></p>
1.210     leot     10912: <dl class="toc">
1.79      rillig   10913: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
1.75      rillig   10914: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10915: </dl>
                   10916: </div>
1.79      rillig   10917: <p>This section contains information on editing the pkgsrc
                   10918:        guide itself.</p>
1.148     asau     10919: <div class="sect1">
1.75      rillig   10920: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.79      rillig   10921: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10922: <p>The pkgsrc guide's source code is stored in
                   10923:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10924:        are created from it:</p>
1.148     asau     10925: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10926: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10927: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   10928: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   10929: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   10930:        The PDF version of the pkgsrc guide.</p></li>
1.128     wiz      10931: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   10932:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   10933: </ul></div>
                   10934: </div>
1.148     asau     10935: <div class="sect1">
1.75      rillig   10936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10937: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
1.79      rillig   10938: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      10939: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     10940: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      10941:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   10942:        documentation) installed. These are automatically installed when
1.189     snj      10943:        you install the <a href="ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148     asau     10944: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   10945:        right directory. All further steps will take place
                   10946:        here.</p></li>
1.148     asau     10947: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   10948:        <code class="filename">files/</code>.</p></li>
1.148     asau     10949: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   10950:        guide for valid XML and to build the final output files. If you
                   10951:        get any errors at this stage, you can just edit the files, as
                   10952:        there are only symbolic links in the working directory, pointing
                   10953:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     10954: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   10955:        commit)</strong></span></p></li>
1.148     asau     10956: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   10957:        regenerate the output files with the proper RCS
                   10958:        Ids.</p></li>
1.148     asau     10959: <li class="step">
1.110     hubertf  10960: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   10961:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10962:        <code class="filename">htdocs</code>.</p>
1.148     asau     10963: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   10964: <h3 class="title">Note</h3>
                   10965: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  10966:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   10967:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   10968:        directory.</p>
                   10969: </div>
                   10970: </li>
1.79      rillig   10971: </ol></div>
1.75      rillig   10972: </div>
                   10973: </div>
                   10974: </div></body>
1.1       grant    10975: </html>

CVSweb <webmaster@jp.NetBSD.org>