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

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.25      spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
                      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
                      9: </head>
1.41      asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1       dsieger    11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.10      hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.10      hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.128     jnemeth    33: <div><p class="copyright">Copyright © 1994-2017 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.31 2017/07/30 22:07:39 jnemeth Exp $</p></div>
1.41      asau       35: <div><div class="abstract">
1.1       dsieger    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.100     leot       48: <dl class="toc">
1.1       dsieger    49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
                     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                     58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
                     63: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                     64: <dd><dl>
                     65: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                     66: <dd><dl>
1.51      asau       67: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23      wiz        68: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger    69: </dl></dd>
                     70: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                     71: <dd><dl>
                     72: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                     73: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                     74: </dl></dd>
                     75: </dl></dd>
                     76: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                     77: <dd><dl>
                     78: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                     79: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                     80: </dl></dd>
                     81: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                     82: <dd><dl>
                     83: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                     84: <dd><dl>
                     85: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                     86: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                     87: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                     88: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                     89: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                     90: <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>
                     91: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                     92: </dl></dd>
                     93: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                     94: <dd><dl>
                     95: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                     96: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                     97: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                     98: </dl></dd>
                     99: </dl></dd>
                    100: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    101: <dd><dl>
                    102: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    103: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    104: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    105: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   106: <dd><dl>
1.4       rillig    107: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz       108: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    109: <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.1       dsieger   110: </dl></dd>
1.4       rillig    111: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    112: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   113: </dl></dd>
                    114: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    115: <dd><dl>
                    116: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    117: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    118: </dl></dd>
                    119: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    120: builds)</a></span></dt>
1.1       dsieger   121: <dd><dl>
1.71      wiz       122: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    123: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    124: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    125: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66      asau      126: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    127: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6       rillig    128: </dl></dd>
                    129: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    130: <dd><dl>
1.23      wiz       131: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    132: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6       rillig    133: </dl></dd>
                    134: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    135: <dd><dl>
                    136: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84      wiz       137: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    138: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    139: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    140: <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>
                    141: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    142: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    143: <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>
                    144: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    145: <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.23      wiz       146: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.84      wiz       147: <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>
                    148: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    149: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    150: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    151: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    152: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    153: <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.1       dsieger   154: </dl></dd>
                    155: </dl></dd>
                    156: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    157: <dd><dl>
1.6       rillig    158: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger   159: <dd><dl>
1.6       rillig    160: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger   161: <dd><dl>
1.6       rillig    162: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.121     sevan     163: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 &amp; KDE4 applications</a></span></dt>
1.17      imil      164: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger   165: </dl></dd>
1.6       rillig    166: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                    167: <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>
                    168: </dl></dd>
                    169: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                    170: <dd><dl>
1.23      wiz       171: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                    172: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108     rillig    173: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6       rillig    174: <dd><dl>
                    175: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                    176: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                    177: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                    178: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                    179: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                    180: </dl></dd>
                    181: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                    182: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                    183: <dd><dl>
                    184: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                    185: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                    186: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                    187: </dl></dd>
1.23      wiz       188: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                    189: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig    190: </dl></dd>
1.23      wiz       191: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig    192: <dd><dl>
                    193: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz       194: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig    195: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                    196: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                    197: <dd><dl>
                    198: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.117     sevan     199: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.108     rillig    200: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                    201: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6       rillig    202: </dl></dd>
                    203: </dl></dd>
                    204: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                    205: <dd><dl>
                    206: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz       207: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    208: <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.6       rillig    209: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                    210: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz       211: <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.6       rillig    212: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86      wiz       213: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                    214: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6       rillig    215: </dl></dd>
                    216: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                    217: <dd><dl>
                    218: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz       219: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig    220: <dd><dl>
                    221: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz       222: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                    223:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    224:       and
                    225:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    226:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig    227: </dl></dd>
1.23      wiz       228: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6       rillig    229: <dd><dl>
1.23      wiz       230: <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.6       rillig    231: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    232: </dl></dd>
                    233: </dl></dd>
                    234: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                    235: <dd><dl>
                    236: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                    237: <dd><dl>
                    238: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                    239: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                    240: </dl></dd>
                    241: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                    242: <dd><dl>
1.23      wiz       243: <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.6       rillig    244: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                    245: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                    246: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                    247: </dl></dd>
                    248: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                    249: <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>
                    250: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                    251: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                    252: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    253: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                    254: <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>
                    255: </dl></dd>
                    256: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                    257: <dd><dl>
                    258: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz       259: <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.6       rillig    260: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig    261: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig    262: </dl></dd>
                    263: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                    264: <dd><dl>
                    265: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                    266: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                    267: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                    268: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz       269: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig    270: <dd><dl>
                    271: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                    272: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                    273: </dl></dd>
1.23      wiz       274: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    275: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    276: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    277: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    278: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    279: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    280: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    281: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    282: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    283: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6       rillig    284: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                    286: </dl></dd>
                    287: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                    288: <dd><dl>
                    289: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                    290: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                    291: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                    292: </dl></dd>
                    293: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                    294: <dd><dl>
                    295: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                    296: <dd><dl>
1.108     rillig    297: <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>
                    298: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                    299: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                    300: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                    301: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                    302: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                    303: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                    304: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    305: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                    306: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    307: <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.6       rillig    308: </dl></dd>
1.108     rillig    309: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig    310: <dd><dl>
                    311: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    312: <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.88      tnn       313: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6       rillig    314: </dl></dd>
1.108     rillig    315: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6       rillig    316: <dd><dl>
                    317: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                    318: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    319: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                    320: </dl></dd>
                    321: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                    322: <dd><dl>
                    323: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                    324: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                    325: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40      wiz       326: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                    327: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6       rillig    328: </dl></dd>
1.108     rillig    329: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6       rillig    330: <dd><dl>
                    331: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    332: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz       333: <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.6       rillig    334: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                    335: </dl></dd>
1.108     rillig    336: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6       rillig    337: <dd><dl>
                    338: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                    339: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                    340: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                    341: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                    342: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    343: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                    344: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                    345: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig    346: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj       347: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig    348: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                    349: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                    350: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                    351: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    352: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                    353: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                    354: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                    355: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger   356:     emulation</a></span></dt>
1.6       rillig    357: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                    358: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger   359: </dl></dd>
1.6       rillig    360: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   361: </dl></dd>
1.6       rillig    362: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                    363: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger   364: <dd><dl>
1.6       rillig    365: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                    366: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    367: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.130     wiz       368: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
                    369: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
                    370: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
                    371: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
                    372: <dt><span class="sect1"><a href="#moving-package">21.8. Moving a package in pkgsrc</a></span></dt>
1.6       rillig    373: </dl></dd>
                    374: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                    375: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                    376: <dd><dl>
                    377: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                    378: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                    379: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                    380: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger   381: </dl></dd>
                    382: </dl></dd>
                    383: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    384: <dd><dl>
1.6       rillig    385: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   386: <dd><dl>
1.6       rillig    387: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                    388: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                    389: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger   390: <dd><dl>
1.6       rillig    391: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                    392: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger   393: </dl></dd>
1.6       rillig    394: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                    395: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   396: <dd><dl>
1.6       rillig    397: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                    398: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger   399: </dl></dd>
1.6       rillig    400: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   401: <dd><dl>
1.23      wiz       402: <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>
                    403: <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.1       dsieger   404: </dl></dd>
                    405: </dl></dd>
1.6       rillig    406: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger   407: <dd><dl>
1.108     rillig    408: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                    409: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1       dsieger   410: <dd><dl>
1.108     rillig    411: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                    412: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1       dsieger   413: </dl></dd>
                    414: </dl></dd>
1.6       rillig    415: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108     rillig    416: <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.1       dsieger   417: </dl></dd>
                    418: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    419: <dd><dl>
                    420: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    421: <dd><dl>
                    422: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    423: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    424: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz       425: <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.1       dsieger   426: </dl></dd>
                    427: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    428: </dl></dd>
                    429: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    430: <dd><dl>
                    431: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    432: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    433: </dl></dd>
                    434: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    435: <dd><dl>
1.23      wiz       436: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    437: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    438: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    439: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    440: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                    441: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger   442: source packages</a></span></dt>
                    443: </dl></dd>
                    444: <dt><span class="appendix"><a href="#editing">D. Editing guidelines for the pkgsrc guide</a></span></dt>
                    445: <dd><dl>
                    446: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                    447: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                    448: </dl></dd>
                    449: </dl>
                    450: </div>
                    451: <div class="list-of-tables">
                    452: <p><b>List of Tables</b></p>
                    453: <dl>
                    454: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    455: </dt>
1.6       rillig    456: <dt>11.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   457: </dt>
1.6       rillig    458: <dt>23.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   459: </dt>
                    460: </dl>
                    461: </div>
1.41      asau      462: <div class="chapter">
                    463: <div class="titlepage"><div><div><h1 class="title">
                    464: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1       dsieger   465: <div class="toc">
                    466: <p><b>Table of Contents</b></p>
1.100     leot      467: <dl class="toc">
1.1       dsieger   468: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    469: <dd><dl>
                    470: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    471: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    472: </dl></dd>
                    473: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    474: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    475: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    476: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    477: </dl>
                    478: </div>
1.41      asau      479: <div class="sect1">
1.1       dsieger   480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    481: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    482: <p>There is a lot of software freely available for Unix-based
                    483: systems, which is usually available in form of the source code. Before
                    484: such software can be used, it needs to be configured to the local
                    485: system, compiled and installed, and this is exactly what The NetBSD
                    486: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    487: to handle binary packages, so that not every user has to build the
                    488: packages for himself, which is a time-costly task.</p>
                    489: <p>pkgsrc currently contains several thousand packages,
                    490:       including:</p>
1.41      asau      491: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120     sevan     492: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1       dsieger   493:          web server</p></li>
1.120     sevan     494: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1       dsieger   495:          web browser</p></li>
1.120     sevan     496: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1       dsieger   497:          Desktop Environment</p></li>
1.120     sevan     498: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1       dsieger   499:          Desktop Environment</p></li>
                    500: </ul></div>
1.108     rillig    501: <p>&#8230; just to name a few.</p>
1.1       dsieger   502: <p>pkgsrc has built-in support for handling varying dependencies,
                    503:       such as pthreads and X11, and extended features such as IPv6 support on
                    504:       a range of platforms.</p>
1.41      asau      505: <div class="sect2">
1.1       dsieger   506: <div class="titlepage"><div><div><h3 class="title">
                    507: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    508: <p>
                    509: pkgsrc provides the following key features:
                    510: </p>
1.41      asau      511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       512: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1       dsieger   513:   and installation of binary packages. The source and latest
                    514:   patches are retrieved from a master or mirror download site, checksum
                    515:   verified, then built on your system. Support for binary-only
                    516:   distributions is available for both native platforms and NetBSD
                    517:   emulated platforms.</p></li>
1.23      wiz       518: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1       dsieger   519:   including binaries, libraries, man pages and other
                    520:   documentation.</p></li>
1.104     sevan     521: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    522:   performing updates, to ensure required packages are installed. The
                    523:   configuration files of various packages are handled automatically during
                    524:   updates, so local changes are preserved.</p></li>
1.23      wiz       525: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1       dsieger   526:   consists of highly portable code. This allows the greatest speed of
1.25      spz       527:   development when porting to a new platform. This portability also
1.1       dsieger   528:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    529:   platforms</em></span>.</p></li>
1.23      wiz       530: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1       dsieger   531:   international encryption requirements and build-time options for a
                    532:   large number of packages are all set in a simple, central
                    533:   configuration file.</p></li>
1.23      wiz       534: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1       dsieger   535:   freely available under a BSD license, so you may extend and adapt
                    536:   pkgsrc to your needs. Support for local packages and patches is
                    537:   available right out of the box, so you can configure it specifically
                    538:   for your environment.</p></li>
                    539: </ul></div>
                    540: <p>The following principles are basic to pkgsrc:</p>
1.41      asau      541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       542: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.14      jmcneill  543: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   544: them and to complain about them rather than to just install the package
                    545: and hope that it works. There are numerous checks in pkgsrc that try to
1.120     sevan     546: find such bugs: Static analysis tools (<a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1       dsieger   547: of shell scripts), and post-installation checks (installed files,
                    548: references to shared libraries, script interpreters).</p></li>
1.23      wiz       549: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.14      jmcneill  550: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   551: pkgsrc has been ported to many operating systems. Care is taken that
                    552: packages behave the same on all platforms.</p></li>
                    553: </ul></div>
                    554: </div>
1.41      asau      555: <div class="sect2">
1.1       dsieger   556: <div class="titlepage"><div><div><h3 class="title">
                    557: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    558: <p>pkgsrc consists of both a source distribution and a binary
                    559: distribution for these operating systems. After retrieving the required
                    560: source or binaries, you can be up and running with pkgsrc in just
                    561: minutes!</p>
                    562: <p>pkgsrc was derived from FreeBSD's ports system, and
                    563:       initially developed for NetBSD only. Since then, pkgsrc has
                    564:       grown a lot, and now supports the following platforms:</p>
                    565: <div class="table">
                    566: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106     tnn       567: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1       dsieger   568: <colgroup>
                    569: <col>
                    570: <col>
1.92      sevan     571: <col>
1.1       dsieger   572: </colgroup>
                    573: <thead><tr>
                    574: <th>Platform</th>
                    575: <th>Date Support Added</th>
1.92      sevan     576: <th>Notes</th>
1.1       dsieger   577: </tr></thead>
                    578: <tbody>
                    579: <tr>
1.10      hubertf   580: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1       dsieger   581: <td align="center">Aug 1997</td>
1.92      sevan     582: <td class="auto-generated"> </td>
1.1       dsieger   583: </tr>
                    584: <tr>
1.10      hubertf   585: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1       dsieger   586: <td align="center">Mar 1999</td>
1.93      sevan     587: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1       dsieger   588: </tr>
                    589: <tr>
1.10      hubertf   590: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1       dsieger   591: <td align="center">Jun 1999</td>
1.93      sevan     592: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1       dsieger   593: </tr>
                    594: <tr>
                    595: <td>
1.118     sevan     596:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1       dsieger   597:         </td>
                    598: <td align="center">Oct 2001</td>
1.93      sevan     599: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.1       dsieger   600: </tr>
                    601: <tr>
1.10      hubertf   602: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1       dsieger   603: <td align="center">Nov 2002</td>
1.93      sevan     604: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1       dsieger   605: </tr>
                    606: <tr>
1.10      hubertf   607: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1       dsieger   608: <td align="center">Nov 2002</td>
1.93      sevan     609: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1       dsieger   610: </tr>
                    611: <tr>
1.10      hubertf   612: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1       dsieger   613: <td align="center">Dec 2002</td>
1.92      sevan     614: <td>
1.93      sevan     615:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    616:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92      sevan     617:        </td>
1.1       dsieger   618: </tr>
                    619: <tr>
                    620: <td>BSD/OS</td>
                    621: <td align="center">Dec 2003</td>
1.92      sevan     622: <td class="auto-generated"> </td>
1.1       dsieger   623: </tr>
                    624: <tr>
1.10      hubertf   625: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1       dsieger   626: <td align="center">Dec 2003</td>
1.93      sevan     627: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1       dsieger   628: </tr>
                    629: <tr>
                    630: <td>
1.10      hubertf   631:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1       dsieger   632:           (Microsoft Windows Services for Unix)
                    633:         </td>
                    634: <td align="center">Mar 2004</td>
1.93      sevan     635: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1       dsieger   636: </tr>
                    637: <tr>
1.10      hubertf   638: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1       dsieger   639: <td align="center">Oct 2004</td>
1.92      sevan     640: <td class="auto-generated"> </td>
1.1       dsieger   641: </tr>
                    642: <tr>
1.10      hubertf   643: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1       dsieger   644: <td align="center">Nov 2004</td>
1.93      sevan     645: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1       dsieger   646: </tr>
                    647: <tr>
1.10      hubertf   648: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1       dsieger   649: <td align="center">Apr 2007</td>
1.93      sevan     650: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1       dsieger   651: </tr>
1.23      wiz       652: <tr>
                    653: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    654: <td align="center">Sep 2010</td>
1.93      sevan     655: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23      wiz       656: </tr>
1.45      obache    657: <tr>
                    658: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57      bsiegert  659: <td align="center">Jan 2011</td>
1.92      sevan     660: <td class="auto-generated"> </td>
1.45      obache    661: </tr>
                    662: <tr>
                    663: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
                    664: <td align="center">Nov 2011</td>
1.93      sevan     665: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45      obache    666: </tr>
                    667: <tr>
                    668: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
                    669: <td align="center">Mar 2013</td>
1.93      sevan     670: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45      obache    671: </tr>
1.58      ryoon     672: <tr>
                    673: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
                    674: <td align="center">Jul 2013</td>
1.93      sevan     675: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58      ryoon     676: </tr>
1.104     sevan     677: <tr>
                    678: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
                    679: <td align="center">Jun 2014</td>
                    680: <td><a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
                    681: </tr>
1.1       dsieger   682: </tbody>
                    683: </table></div>
                    684: </div>
                    685: <br class="table-break">
                    686: </div>
                    687: </div>
1.41      asau      688: <div class="sect1">
1.1       dsieger   689: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    690: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    691: <p>This document is divided into three parts. The first,
1.10      hubertf   692:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1       dsieger   693:        describes how one can use one of the packages in the Package
                    694:        Collection, either by installing a precompiled binary package,
                    695:        or by building one's own copy using the NetBSD package system.
1.10      hubertf   696:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1       dsieger   697:        package so it can be easily built by other NetBSD users without
                    698:        knowing about the package's building details. The third part,
1.10      hubertf   699:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1       dsieger   700:        is intended for those who want to understand how pkgsrc is
                    701:        implemented.</p>
                    702: <p>This document is available in various formats:
1.10      hubertf   703:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1       dsieger   704: </div>
1.41      asau      705: <div class="sect1">
1.1       dsieger   706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    707: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23      wiz       708: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    709:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.1       dsieger   710:       terminology used within this document.</p>
1.41      asau      711: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   712: <dt><span class="term">Package</span></dt>
                    713: <dd><p>A set of files and building instructions
                    714:            that describe what's necessary
                    715:            to build a certain piece of software using
                    716:             pkgsrc. Packages are traditionally stored under
1.123     wiz       717:            <code class="filename">/usr/pkgsrc</code>,
                    718:            but may be stored in any location,
                    719:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1       dsieger   720: <dt><span class="term">The NetBSD package system</span></dt>
1.23      wiz       721: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.1       dsieger   722:          is part of the NetBSD operating system and can be bootstrapped
                    723:          to run on non-NetBSD operating systems as well.  It handles
                    724:          building (compiling), installing, and removing of
                    725:          packages.</p></dd>
                    726: <dt><span class="term">Distfile</span></dt>
                    727: <dd><p>This term describes the file or files that are
                    728:            provided by the author of the piece of software to
                    729:            distribute his work. All the changes necessary to build on
                    730:            NetBSD are reflected in the corresponding package. Usually
                    731:            the distfile is in the form of a compressed tar-archive,
                    732:            but other types are possible, too. Distfiles are usually
                    733:            stored below
                    734:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    735: <dt><span class="term">Port</span></dt>
                    736: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    737:            for what we call a package.
1.23      wiz       738:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.1       dsieger   739:            architecture.</p></dd>
                    740: <dt><span class="term">Precompiled/binary package</span></dt>
                    741: <dd>
                    742: <p>A set of binaries built with pkgsrc from a distfile
                    743:            and stuffed together in a single <code class="filename">.tgz</code>
                    744:            file so it can be installed on machines of the same
                    745:            machine architecture without the need to
                    746:            recompile. Packages are usually generated in
                    747:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25      spz       748:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23      wiz       749: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.1       dsieger   750:            especially in the context of precompiled packages.</p>
                    751: </dd>
                    752: <dt><span class="term">Program</span></dt>
                    753: <dd><p>The piece of software to be installed which will be
                    754:          constructed from all the files in the distfile by the
                    755:          actions defined in the corresponding package.</p></dd>
                    756: </dl></div>
1.41      asau      757: <div class="sect2">
1.1       dsieger   758: <div class="titlepage"><div><div><h3 class="title">
                    759: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41      asau      760: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   761: <dt><span class="term">pkgsrc users</span></dt>
                    762: <dd>
                    763: <p>The
                    764:        pkgsrc users are people who use the packages provided by pkgsrc.
                    765:        Typically they are system administrators. The people using the
1.23      wiz       766:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    767:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.1       dsieger   768: <p>There are two kinds of pkgsrc users: Some only want to
                    769:        install pre-built binary packages. Others build the pkgsrc
                    770:        packages from source, either for installing them directly or for
1.10      hubertf   771:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.1       dsieger   772:        documentation.</p>
                    773: </dd>
                    774: <dt><span class="term">package maintainers</span></dt>
                    775: <dd><p>A
1.10      hubertf   776:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.1       dsieger   777: <dt><span class="term">infrastructure developers</span></dt>
                    778: <dd><p>These people are involved in all those files
                    779:        that live in the <code class="filename">mk/</code> directory and below.
1.10      hubertf   780:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.1       dsieger   781:        too.</p></dd>
                    782: </dl></div>
                    783: </div>
                    784: </div>
1.41      asau      785: <div class="sect1">
1.1       dsieger   786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    787: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    788: <p>When giving examples for commands, shell prompts are used to
                    789:       show if the command should/can be issued as root, or if
1.23      wiz       790:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.115     sevan     791:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    792:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    793:       bourne shell and derivatives.</p>
1.1       dsieger   794: </div>
                    795: </div>
1.41      asau      796: <div class="part">
1.1       dsieger   797: <div class="titlepage"><div><div><h1 class="title">
                    798: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    799: <div class="toc">
                    800: <p><b>Table of Contents</b></p>
1.100     leot      801: <dl class="toc">
1.1       dsieger   802: <dt><span class="chapter"><a href="#getting">2. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
                    803: <dd><dl>
                    804: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    805: <dd><dl>
1.51      asau      806: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23      wiz       807: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   808: </dl></dd>
                    809: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    810: <dd><dl>
                    811: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    812: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    813: </dl></dd>
                    814: </dl></dd>
                    815: <dt><span class="chapter"><a href="#platforms">3. Using pkgsrc on systems other than NetBSD</a></span></dt>
                    816: <dd><dl>
                    817: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                    818: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                    819: </dl></dd>
                    820: <dt><span class="chapter"><a href="#using">4. Using pkgsrc</a></span></dt>
                    821: <dd><dl>
                    822: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                    823: <dd><dl>
                    824: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                    825: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                    826: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                    827: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                    828: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    829: <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>
                    830: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                    831: </dl></dd>
                    832: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                    833: <dd><dl>
                    834: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                    835: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                    836: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                    837: </dl></dd>
                    838: </dl></dd>
                    839: <dt><span class="chapter"><a href="#configuring">5. Configuring pkgsrc</a></span></dt>
                    840: <dd><dl>
                    841: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                    842: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig    843: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig    844: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   845: <dd><dl>
1.4       rillig    846: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz       847: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    848: <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.1       dsieger   849: </dl></dd>
1.4       rillig    850: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                    851: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger   852: </dl></dd>
                    853: <dt><span class="chapter"><a href="#binary">6. Creating binary packages</a></span></dt>
                    854: <dd><dl>
                    855: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                    856: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    857: </dl></dd>
                    858: <dt><span class="chapter"><a href="#bulk">7. Creating binary packages for everything in pkgsrc (bulk
                    859: builds)</a></span></dt>
1.1       dsieger   860: <dd><dl>
1.71      wiz       861: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                    862: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                    863: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                    864: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66      asau      865: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    866: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6       rillig    867: </dl></dd>
                    868: <dt><span class="chapter"><a href="#files">8. Directory layout of the installed files</a></span></dt>
                    869: <dd><dl>
1.23      wiz       870: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    871: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.6       rillig    872: </dl></dd>
                    873: <dt><span class="chapter"><a href="#faq">9. Frequently Asked Questions</a></span></dt>
                    874: <dd><dl>
                    875: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84      wiz       876: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                    877: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                    878: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    879: <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>
                    880: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                    881: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                    882: <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>
                    883: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                    884: <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.23      wiz       885: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.84      wiz       886: <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>
                    887: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                    888: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                    889: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                    890: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    891: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                    892: <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.1       dsieger   893: </dl></dd>
                    894: </dl>
                    895: </div>
1.41      asau      896: <div class="chapter">
1.1       dsieger   897: <div class="titlepage"><div><div><h2 class="title">
                    898: <a name="getting"></a>Chapter 2. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
                    899: <div class="toc">
                    900: <p><b>Table of Contents</b></p>
1.100     leot      901: <dl class="toc">
1.1       dsieger   902: <dt><span class="sect1"><a href="#getting-first">2.1. Getting pkgsrc for the first time</a></span></dt>
                    903: <dd><dl>
1.51      asau      904: <dt><span class="sect2"><a href="#getting-via-tar">2.1.1. As tar archive</a></span></dt>
1.23      wiz       905: <dt><span class="sect2"><a href="#getting-via-cvs">2.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   906: </dl></dd>
                    907: <dt><span class="sect1"><a href="#uptodate">2.2. Keeping pkgsrc up-to-date</a></span></dt>
                    908: <dd><dl>
                    909: <dt><span class="sect2"><a href="#uptodate-tar">2.2.1. Via tar files</a></span></dt>
                    910: <dt><span class="sect2"><a href="#uptodate-cvs">2.2.2. Via CVS</a></span></dt>
                    911: </dl></dd>
                    912: </dl>
                    913: </div>
                    914: <p>Before you download and extract the files, you need to decide
                    915: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    916: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    917: free to install the sources and binary packages wherever you want in
                    918: your filesystem, provided that the pathname does not contain white-space
                    919: or other characters that are interpreted specially by the shell and some
                    920: other programs. A safe bet is to use only letters, digits, underscores
                    921: and dashes.</p>
1.41      asau      922: <div class="sect1">
1.1       dsieger   923: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    924: <a name="getting-first"></a>2.1. Getting pkgsrc for the first time</h2></div></div></div>
                    925: <p>Before you download any pkgsrc files, you should decide
                    926:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    927:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    928:        quarterly basis from the current branch and only gets modified
                    929:        for security updates. The names of the stable branches are built
                    930:        from the year and the quarter, for example
1.118     sevan     931:        <code class="literal">2016Q4</code>.</p>
1.1       dsieger   932: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23      wiz       933:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    934:        Both ways are described here.</p>
1.51      asau      935: <p>Note that tar archive contains CVS working copy.
                    936:        Thus you can switch to using CVS at any later time.</p>
1.41      asau      937: <div class="sect2">
1.1       dsieger   938: <div class="titlepage"><div><div><h3 class="title">
1.51      asau      939: <a name="getting-via-tar"></a>2.1.1. As tar archive</h3></div></div></div>
1.1       dsieger   940: <p>The primary download location for all pkgsrc files is
1.51      asau      941:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/</a> or
                    942:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    943:        (it points to the same location).
                    944:        There are a number of subdirectories for different purposes,
                    945:        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>
                    946: <p>The tar archive for the current branch is in the directory
                    947:        <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.118     sevan     948:        It is autogenerated weekly.</p>
1.51      asau      949: <p>To save download time we provide bzip2- and
                    950:        xz-compressed archives which are published at
                    951:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
                    952:        and
                    953:        <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
                    954:        respectively.
                    955:        </p>
                    956: <p>You can fetch the same files using FTP.</p>
1.118     sevan     957: <p>The tar file for the stable branch 2016Q4 is in the
                    958:        directory <code class="filename">pkgsrc-2016Q4</code> and is also called <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2016Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.12      weinem    959: <p>To download a pkgsrc stable tarball, run:</p>
                    960: <pre class="screen">
1.59      jnemeth   961: <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.22      jakllsch  962: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the
1.12      weinem    963:        stable branch to be downloaded, for example, 
1.118     sevan     964:        <span class="quote">&#8220;<span class="quote">pkgsrc-2016Q4</span>&#8221;</span>.</p>
1.78      snj       965: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51      asau      966:        or your web browser.</p>
1.12      weinem    967: <p>Then, extract it with:</p>
1.78      snj       968: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12      weinem    969: <p>This will create the directory <code class="filename">pkgsrc/</code>
                    970:        in <code class="filename">/usr/</code> and all the package source will be 
                    971:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    972: <p>To download pkgsrc-current, run:</p>
                    973: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1       dsieger   974: </div>
1.41      asau      975: <div class="sect2">
1.1       dsieger   976: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz       977: <a name="getting-via-cvs"></a>2.1.2. Via anonymous CVS</h3></div></div></div>
                    978: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.39      wiz       979: <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.23      wiz       980: </pre>
                    981: <p>Where <em class="replaceable"><code>pkgsrc-20xxQy</code></em> is the stable 
1.118     sevan     982:        branch to be checked out, for example, <span class="quote">&#8220;<span class="quote">pkgsrc-2016Q4</span>&#8221;</span></p>
1.23      wiz       983: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                    984:        in your <code class="filename">/usr/</code> directory and all the package source 
                    985:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                    986: <p>To fetch the pkgsrc current branch, run:</p>
1.39      wiz       987: <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       dsieger   988: </pre>
1.78      snj       989: <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.23      wiz       990: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39      wiz       991: <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.23      wiz       992: </pre>
                    993: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                    994:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                    995:        or better globally in <code class="filename">/etc/profile</code>:</p>
                    996: <pre class="programlisting">
                    997: # set CVS remote shell command
                    998: CVS_RSH=ssh
                    999: export CVS_RSH
                   1000: </pre>
                   1001: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1002:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1003:        in your home directory and saving the following lines to it.
                   1004:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1005:        You can find an explanation of this file in the CVS documentation.</p>
1.2       rillig   1006: <pre class="programlisting">
                   1007: # recommended CVS configuration file from the pkgsrc guide
1.39      wiz      1008: cvs -q -z2
1.2       rillig   1009: checkout -P
1.4       rillig   1010: update -dP
                   1011: diff -upN
1.2       rillig   1012: rdiff -u
1.23      wiz      1013: release -d
1.2       rillig   1014: </pre>
1.1       dsieger  1015: </div>
                   1016: </div>
1.41      asau     1017: <div class="sect1">
1.1       dsieger  1018: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1019: <a name="uptodate"></a>2.2. Keeping pkgsrc up-to-date</h2></div></div></div>
                   1020: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1021:        (which also works if you have first installed it via a tar
                   1022:        file). It saves bandwidth and hard disk activity, compared to
                   1023:        downloading the tar file again.</p>
1.41      asau     1024: <div class="sect2">
1.1       dsieger  1025: <div class="titlepage"><div><div><h3 class="title">
                   1026: <a name="uptodate-tar"></a>2.2.1. Via tar files</h3></div></div></div>
1.41      asau     1027: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1028: <h3 class="title">Warning</h3>
                   1029: <p>When updating from a tar file, you first need to
                   1030:        completely remove the old pkgsrc directory. Otherwise those
                   1031:        files that have been removed from pkgsrc in the mean time will
                   1032:        not be removed on your local disk, resulting in inconsistencies.
                   1033:        When removing the old files, any changes that you have done to
                   1034:        the pkgsrc files will be lost after updating. Therefore updating
                   1035:        via CVS is strongly recommended.</p>
                   1036: </div>
                   1037: <p>Note that by default the distfiles and the binary packages
                   1038:        are saved in the pkgsrc tree, so don't forget to rescue them
1.78      snj      1039:        before updating. You can also configure pkgsrc to store distfiles
                   1040:         and packages in directories outside the pkgsrc tree by setting the
1.1       dsieger  1041:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.10      hubertf  1042:        variables. See <a class="xref" href="#configuring" title="Chapter 5. Configuring pkgsrc">Chapter 5, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1       dsieger  1043: <p>To update pkgsrc from a tar file, download the tar file as
                   1044:        explained above. Then, make sure that you have not made any
                   1045:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1046:        directory and extract the new tar file. Done.</p>
                   1047: </div>
1.41      asau     1048: <div class="sect2">
1.1       dsieger  1049: <div class="titlepage"><div><div><h3 class="title">
                   1050: <a name="uptodate-cvs"></a>2.2.2. Via CVS</h3></div></div></div>
1.25      spz      1051: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1052: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1053: </pre>
                   1054: <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>
                   1055: <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>
                   1056: </pre>
1.41      asau     1057: <div class="sect3">
1.1       dsieger  1058: <div class="titlepage"><div><div><h4 class="title">
                   1059: <a name="uptodate-cvs-switch"></a>2.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
                   1060: <p>When updating pkgsrc, the CVS program keeps track of the
                   1061:        branch you selected. But if you, for whatever reason, want to
                   1062:        switch from the stable branch to the current one, you can do it
1.23      wiz      1063:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1064:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.1       dsieger  1065:        back to the stable branch, add the
1.118     sevan    1066:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2016Q4</span>&#8221;</span> option.</p>
1.1       dsieger  1067: </div>
1.41      asau     1068: <div class="sect3">
1.1       dsieger  1069: <div class="titlepage"><div><div><h4 class="title">
                   1070: <a name="uptodate-cvs-changes"></a>2.2.2.2. What happens to my changes when updating?</h4></div></div></div>
                   1071: <p>When you update pkgsrc, the CVS program will only touch
                   1072:        those files that are registered in the CVS repository. That
                   1073:        means that any packages that you created on your own will stay
                   1074:        unmodified. If you change files that are managed by CVS, later
                   1075:        updates will try to merge your changes with those that have been
                   1076:        done by others. See the CVS manual, chapter
1.23      wiz      1077:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.1       dsieger  1078: </div>
                   1079: </div>
                   1080: </div>
                   1081: </div>
1.41      asau     1082: <div class="chapter">
1.1       dsieger  1083: <div class="titlepage"><div><div><h2 class="title">
                   1084: <a name="platforms"></a>Chapter 3. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
                   1085: <div class="toc">
                   1086: <p><b>Table of Contents</b></p>
1.100     leot     1087: <dl class="toc">
1.1       dsieger  1088: <dt><span class="sect1"><a href="#binarydist">3.1. Binary distribution</a></span></dt>
                   1089: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">3.2. Bootstrapping pkgsrc</a></span></dt>
                   1090: </dl>
                   1091: </div>
1.41      asau     1092: <div class="sect1">
1.1       dsieger  1093: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1094: <a name="binarydist"></a>3.1. Binary distribution</h2></div></div></div>
1.10      hubertf  1095: <p>See <a class="xref" href="#using-pkg" title="4.1. Using binary packages">Section 4.1, &#8220;Using binary packages&#8221;</a>.</p>
1.1       dsieger  1096: </div>
1.41      asau     1097: <div class="sect1">
1.1       dsieger  1098: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1099: <a name="bootstrapping-pkgsrc"></a>3.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43      asau     1100: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1101:     privileged and unprivileged one. In unprivileged mode in contrast
1.44      asau     1102:     to privileged one all programs are installed under one particular user
1.43      asau     1103:     and cannot utilise privileged operations (packages don't create
                   1104:     special users and all special file permissions like setuid are ignored).
                   1105:     </p>
1.1       dsieger  1106: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1107: <pre class="screen">
1.60      asau     1108: <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.1       dsieger  1109: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1110: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1111:     </pre>
1.43      asau     1112: <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>
                   1113: <p>By default, in privileged mode pkgsrc uses
                   1114:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1115:     where programs will be installed in,
1.118     sevan    1116:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43      asau     1117:     directory where pkgsrc will do its internal bookkeeping,
                   1118:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1119:     where packages install their persistent data.
                   1120:     In unprivileged mode pkgsrc uses
                   1121:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118     sevan    1122:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43      asau     1123:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1124:     </p>
                   1125: <p>You can change default layout using command-line arguments.
                   1126:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1127:     </p>
1.41      asau     1128: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1129: <h3 class="title">Note</h3>
1.10      hubertf  1130: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1131:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1132:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23      wiz      1133:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.1       dsieger  1134: </div>
1.43      asau     1135: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1136: <h3 class="title">Note</h3>
                   1137: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1138:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1139:       corresponding to the installation you're working with to build
                   1140:       and install packages.
                   1141:       </p>
                   1142: </div>
1.1       dsieger  1143: </div>
                   1144: </div>
1.41      asau     1145: <div class="chapter">
1.1       dsieger  1146: <div class="titlepage"><div><div><h2 class="title">
                   1147: <a name="using"></a>Chapter 4. Using pkgsrc</h2></div></div></div>
                   1148: <div class="toc">
                   1149: <p><b>Table of Contents</b></p>
1.100     leot     1150: <dl class="toc">
1.1       dsieger  1151: <dt><span class="sect1"><a href="#using-pkg">4.1. Using binary packages</a></span></dt>
                   1152: <dd><dl>
                   1153: <dt><span class="sect2"><a href="#finding-binary-packages">4.1.1. Finding binary packages</a></span></dt>
                   1154: <dt><span class="sect2"><a href="#installing-binary-packages">4.1.2. Installing binary packages</a></span></dt>
                   1155: <dt><span class="sect2"><a href="#using.pkg_delete">4.1.3. Deinstalling packages</a></span></dt>
                   1156: <dt><span class="sect2"><a href="#using.pkg_info">4.1.4. Getting information about installed packages</a></span></dt>
                   1157: <dt><span class="sect2"><a href="#vulnerabilities">4.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1158: <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>
                   1159: <dt><span class="sect2"><a href="#using.pkg_admin">4.1.7. Other administrative functions</a></span></dt>
                   1160: </dl></dd>
                   1161: <dt><span class="sect1"><a href="#building-packages-from-source">4.2. Building packages from source</a></span></dt>
                   1162: <dd><dl>
                   1163: <dt><span class="sect2"><a href="#requirements">4.2.1. Requirements</a></span></dt>
                   1164: <dt><span class="sect2"><a href="#fetching-distfiles">4.2.2. Fetching distfiles</a></span></dt>
                   1165: <dt><span class="sect2"><a href="#how-to-build-and-install">4.2.3. How to build and install</a></span></dt>
                   1166: </dl></dd>
                   1167: </dl>
                   1168: </div>
                   1169: <p>Basically, there are two ways of using pkgsrc. The first
                   1170: is to only install the package tools and to use binary packages
1.23      wiz      1171: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1172: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.1       dsieger  1173: of pkgsrc, too. Then you are able to build your own packages,
                   1174: and you can still use binary packages from someone else.</p>
1.41      asau     1175: <div class="sect1">
1.1       dsieger  1176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1177: <a name="using-pkg"></a>4.1. Using binary packages</h2></div></div></div>
1.10      hubertf  1178: <p>On the <a class="ulink" href="ftp://ftp.NetBSD.org/" target="_top">ftp.NetBSD.org</a>
1.9       rillig   1179:   server and its mirrors, there are collections of binary packages,
                   1180:   ready to be installed. These binary packages have been built using the
                   1181:   default settings for the directories, that is:</p>
1.41      asau     1182: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1183: <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>
                   1184: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1185: <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.9       rillig   1186: </ul></div>
                   1187: <p>If you cannot use these directories for whatever reasons (maybe
                   1188:   because you're not root), you cannot use these binary packages, but
1.10      hubertf  1189:   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.41      asau     1190: <div class="sect2">
1.1       dsieger  1191: <div class="titlepage"><div><div><h3 class="title">
                   1192: <a name="finding-binary-packages"></a>4.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1193: <p>To install binary packages, you first need to know from where
                   1194:     to get them. The first place where you should look is on the main
1.10      hubertf  1195:     pkgsrc FTP server in the directory <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5       weinem   1196: <p>This directory contains binary packages for multiple
                   1197:     platforms. First, select your operating system. (Ignore the
                   1198:     directories with version numbers attached to it, they just exist for
                   1199:     legacy reasons.) Then, select your hardware architecture, and in the
1.23      wiz      1200:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.9       rillig   1201: <p>In this directory, you often find a file called
                   1202:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1203:     management tools. If the file is missing, it is likely that your
                   1204:     operating system already provides those tools. Download the file and
                   1205:     extract it in the <code class="filename">/</code> directory. It will create
                   1206:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118     sevan    1207:     for managing binary packages and the database of installed packages).</p>
1.1       dsieger  1208: </div>
1.41      asau     1209: <div class="sect2">
1.1       dsieger  1210: <div class="titlepage"><div><div><h3 class="title">
                   1211: <a name="installing-binary-packages"></a>4.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1212: <p>In the directory from the last section, there is a
1.85      wiz      1213:     subdirectory called <code class="filename">All/</code>, which contains all the
1.9       rillig   1214:     binary packages that are available for the platform, excluding those
                   1215:     that may not be distributed via FTP or CDROM (depending on which
1.23      wiz      1216:     medium you are using).</p>
1.9       rillig   1217: <p>To install packages directly from an FTP or HTTP server, run
                   1218:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1219:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1220: <pre class="screen">
                   1221: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.85      wiz      1222: <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.9       rillig   1223: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1224: </pre>
                   1225: <p>Instead of URLs, you can also use local paths, for example if
                   1226:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1227:     repository. If you want to install packages from multiple sources,
                   1228:     you can separate them by a semicolon in
                   1229:     <code class="varname">PKG_PATH</code>.</p>
                   1230: <p>After these preparations, installing a package is very
                   1231:     easy:</p>
                   1232: <pre class="screen">
1.118     sevan    1233: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
1.9       rillig   1234: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add kde-3.5.7</code></strong>
1.118     sevan    1235: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9       rillig   1236: </pre>
1.1       dsieger  1237: <p>Note that any prerequisite packages needed to run the
                   1238:     package in question will be installed, too, assuming they are
                   1239:     present where you install from.</p>
1.23      wiz      1240: <p>Adding packages might install vulnerable packages.
                   1241:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14      jmcneill 1242:     regularly, especially after installing new packages, and verify
                   1243:     that the vulnerabilities are acceptable for your configuration.</p>
1.1       dsieger  1244: <p>After you've installed packages, be sure to have
                   1245:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1246:     <code class="varname">PATH</code> so you can actually start the just
                   1247:     installed program.</p>
                   1248: </div>
1.41      asau     1249: <div class="sect2">
1.1       dsieger  1250: <div class="titlepage"><div><div><h3 class="title">
                   1251: <a name="using.pkg_delete"></a>4.1.3. Deinstalling packages</h3></div></div></div>
                   1252: <p>To deinstall a package, it does not matter whether it was
                   1253:     installed from source code or from a binary package. The
1.10      hubertf  1254:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1255:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1       dsieger  1256:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1257:     name can be given with or without version number. Wildcards can
                   1258:     also be used to deinstall a set of packages, for example
                   1259:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1260:     so that the shell does not expand them before
                   1261:     <code class="literal">pkg_delete</code> sees them.</p>
                   1262: <p>The <code class="option">-r</code> option is very powerful: it
                   1263:     removes all the packages that require the package in question
                   1264:     and then removes the package itself. For example:
                   1265: 
                   1266:     </p>
                   1267: <pre class="screen">
                   1268: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1269:     </pre>
                   1270: <p>
                   1271: 
                   1272:     will remove jpeg and all the packages that used it; this allows
                   1273:     upgrading the jpeg package.</p>
                   1274: </div>
1.41      asau     1275: <div class="sect2">
1.1       dsieger  1276: <div class="titlepage"><div><div><h3 class="title">
                   1277: <a name="using.pkg_info"></a>4.1.4. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1278: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1       dsieger  1279:     installed packages or binary package files.</p>
                   1280: </div>
1.41      asau     1281: <div class="sect2">
1.1       dsieger  1282: <div class="titlepage"><div><div><h3 class="title">
                   1283: <a name="vulnerabilities"></a>4.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
                   1284: <p>
                   1285:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1286:       known security vulnerabilities to packages which are (or have been)
                   1287:       included in pkgsrc.  The list is available from the NetBSD
1.10      hubertf  1288:       FTP site at <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1       dsieger  1289:     </p>
                   1290: <p>
1.22      jakllsch 1291:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1       dsieger  1292:       this list can be downloaded
                   1293:       automatically, and a security audit of all packages installed on a system
                   1294:       can take place.
                   1295:     </p>
                   1296: <p>
1.22      jakllsch 1297:       There are two components to auditing.  The first
                   1298:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1299:       is for downloading
1.1       dsieger  1300:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.22      jakllsch 1301:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1       dsieger  1302:       installed packages are vulnerable.  If a package is vulnerable, you
                   1303:       will see output similar to the following:
                   1304:     </p>
                   1305: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1306:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
                   1307: <p>
1.22      jakllsch 1308:       You may wish to have the
1.10      hubertf  1309:       <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22      jakllsch 1310:       file downloaded daily so that
                   1311:       it remains current.  This may be done by adding an appropriate entry
1.125     leot     1312:       to the root users <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.22      jakllsch 1313:       </p>
                   1314: <pre class="screen">
1.121     sevan    1315: # Download vulnerabilities file
1.118     sevan    1316: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.121     sevan    1317: # Audit the installed packages and email results to root
                   1318: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1319:            root &gt;/dev/null 2&gt;&amp;1
1.22      jakllsch 1320:       </pre>
                   1321: <p>
1.118     sevan    1322:       will update the vulnerability list every day at 3AM, followed by an audit
                   1323:       at 3:09AM. The result of the audit are then emailed to root.
1.22      jakllsch 1324: 
1.118     sevan    1325:       On NetBSD this may be accomplished instead by adding the following
                   1326:       line to <code class="filename">/etc/daily.conf</code>:
                   1327:       </p>
                   1328: <pre class="screen">
                   1329: fetch_pkg_vulnerabilities=YES
                   1330:       </pre>
                   1331: <p>
                   1332:       to fetch the vulnerability list from the daily security script. The system
                   1333:       is set to audit the packages by default but can be set explicitly, if
1.123     wiz      1334:       desired (not required), by adding the following line to
1.118     sevan    1335: <code class="filename">/etc/security.conf</code>:
1.22      jakllsch 1336:       </p>
                   1337: <pre class="screen">
1.118     sevan    1338: check_pkg_vulnerabilities=YES
1.22      jakllsch 1339:       </pre>
                   1340: <p>
1.125     leot     1341:       see <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1       dsieger  1342:     </p>
                   1343: </div>
1.41      asau     1344: <div class="sect2">
1.1       dsieger  1345: <div class="titlepage"><div><div><h3 class="title">
                   1346: <a name="pkg_versions"></a>4.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
                   1347: <p>
1.120     sevan    1348:       Install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23      wiz      1349:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.1       dsieger  1350:       argument to check if your packages are up-to-date, e.g.
                   1351:     </p>
                   1352: <pre class="screen">
                   1353: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1354: ...
                   1355: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1356:     </pre>
1.10      hubertf  1357: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1       dsieger  1358:     package on your system and rebuild any dependencies.
                   1359:     </p>
                   1360: </div>
1.41      asau     1361: <div class="sect2">
1.1       dsieger  1362: <div class="titlepage"><div><div><h3 class="title">
                   1363: <a name="using.pkg_admin"></a>4.1.7. Other administrative functions</h3></div></div></div>
1.10      hubertf  1364: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1365:     administrative functions on the package system.</p>
                   1366: </div>
                   1367: </div>
1.41      asau     1368: <div class="sect1">
1.1       dsieger  1369: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1370: <a name="building-packages-from-source"></a>4.2. Building packages from source</h2></div></div></div>
                   1371: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1372:   directory now contains a set of packages, organized into
                   1373:   categories. You can browse the online index of packages, or run
1.10      hubertf  1374:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1375:   directory to build local <code class="filename">README.html</code> files for
1.120     sevan    1376:   all packages, viewable with any web browser such as <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1       dsieger  1377: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1378:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1379:   should do so by setting <code class="varname">LOCALBASE</code> in
1.10      hubertf  1380:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1381:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1382:   system (inside a chroot is an exception). </p>
                   1383: <p>The rest of this chapter assumes that the package is already
1.10      hubertf  1384:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.1       dsieger  1385:   instructions how to create your own packages.</p>
1.41      asau     1386: <div class="sect2">
1.1       dsieger  1387: <div class="titlepage"><div><div><h3 class="title">
                   1388: <a name="requirements"></a>4.2.1. Requirements</h3></div></div></div>
                   1389: <p>To build packages from source, you need a working C
                   1390:     compiler. On NetBSD, you need to install the
1.23      wiz      1391:     <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.1       dsieger  1392:     sets. If you want to build X11-related packages, the
1.23      wiz      1393:     <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.1       dsieger  1394:     sets are required, too.</p>
                   1395: </div>
1.41      asau     1396: <div class="sect2">
1.1       dsieger  1397: <div class="titlepage"><div><div><h3 class="title">
                   1398: <a name="fetching-distfiles"></a>4.2.2. Fetching distfiles</h3></div></div></div>
                   1399: <p>The first step for building a package is downloading the
                   1400:     distfiles (i.e. the unmodified source). If they have not yet been
                   1401:     downloaded, pkgsrc will fetch them automatically.</p>
                   1402: <p>If you have all files that you need in the
                   1403:     <code class="filename">distfiles</code> directory,
                   1404:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1405:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1406:     </p>
                   1407: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1408: <p>
1.10      hubertf  1409:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1410: <p>By default a list of distribution sites will be randomly
                   1411:     intermixed to prevent huge load on servers which holding popular
                   1412:     packages (for example, SourceForge.net mirrors). Thus, every
                   1413:     time when you need to fetch yet another distfile all the mirrors
                   1414:     will be tried in new (random) order. You can turn this feature
                   1415:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1416:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1417: <p>You can overwrite some of the major distribution sites to
                   1418:     fit to sites that are close to your own.  By setting one or two
                   1419:     variables you can modify the order in which the master sites are
                   1420:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1421:     delimited list of domain suffixes.
                   1422:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1423:     contains a whitespace delimited list of regular expressions.  It
                   1424:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1425:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1426:     some examples.  This may save some of your bandwidth and
                   1427:     time.</p>
                   1428: <p>You can change these settings either in your shell's environment, or,
                   1429:     if you want to keep the settings, by editing the
1.10      hubertf  1430:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1431:     and adding the definitions there.</p>
                   1432: <p>
                   1433:       If a package depends on many other packages (such as
1.120     sevan    1434:       <a href="http://cdn.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.1       dsieger  1435:       alternate between periods of
                   1436:       downloading source, and compiling. To ensure you have all the source
                   1437:       downloaded initially you can run the command:
                   1438:       </p>
                   1439: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1440: <p>
                   1441:       which will output and run a set of shell commands to fetch the
                   1442:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1443:       also choose to download the files manually.
                   1444:     </p>
                   1445: </div>
1.41      asau     1446: <div class="sect2">
1.1       dsieger  1447: <div class="titlepage"><div><div><h3 class="title">
                   1448: <a name="how-to-build-and-install"></a>4.2.3. How to build and install</h3></div></div></div>
                   1449: <p>
                   1450:       Once the software has downloaded, any patches will be applied, then it
                   1451:       will be compiled for you. This may take some time depending on your
                   1452:       computer, and how many other packages the software depends on and their
                   1453:       compile time.
                   1454:     </p>
1.41      asau     1455: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1456: <h3 class="title">Note</h3>
                   1457: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1458:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23      wiz      1459:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.1       dsieger  1460: </div>
                   1461: <p>For example, type</p>
                   1462: <pre class="screen">
                   1463: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1464: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1465:     </pre>
                   1466: <p>at the shell prompt to build the various components of the
                   1467:     package.</p>
                   1468: <p>The next stage is to actually install the newly compiled
                   1469:     program onto your system. Do this by entering:
                   1470: 
                   1471:     </p>
                   1472: <pre class="screen">
                   1473: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1474:     </pre>
                   1475: <p>
                   1476: 
                   1477:     while you are still in the directory for whatever package you
                   1478:     are installing.</p>
                   1479: <p>Installing the package on your system may require you to
                   1480:     be root.  However, pkgsrc has a
                   1481:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1482:     to only become root for the actual installation step.</p>
                   1483: <p>That's it, the software should now be installed and setup for use.
                   1484:     You can now enter:
                   1485: 
                   1486:     </p>
                   1487: <pre class="screen">
                   1488: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1489:     </pre>
                   1490: <p>
                   1491: 
                   1492:     to remove the compiled files in the work directory, as you shouldn't need
                   1493:     them any more. If other packages were also added to your system
                   1494:     (dependencies) to allow your program to compile, you can tidy these up
                   1495:     also with the command:</p>
                   1496: <pre class="screen">
                   1497: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1498:     </pre>
                   1499: <p>Taking the figlet utility as an example, we can install it on our
1.10      hubertf  1500:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1       dsieger  1501: <p>The program is installed under the default root of the
                   1502:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1503:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1504:     variable in your environment, and it will use that value as the
                   1505:     root of your packages tree. So, to use
                   1506:     <code class="filename">/usr/local</code>, set
                   1507:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1508:     Please note that you should use a directory which is dedicated to
                   1509:     packages and not shared with other programs (i.e., do not try and
                   1510:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1511:     to add any of your own files or directories (such as
                   1512:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1513:     <code class="filename">pkgsrc/</code>) below the
                   1514:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1515:     conflicts between programs and other files installed by the
                   1516:     package system and whatever else may have been installed
                   1517:     there.</p>
1.10      hubertf  1518: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  1519:     alter some configuration options at build time.  Have a look at
                   1520:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1521:     of what will be set there by default.  Environment variables such
                   1522:     as <code class="varname">LOCALBASE</code> can be set in
1.10      hubertf  1523:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  1524:     set them each time you want to use pkgsrc.</p>
1.23      wiz      1525: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1526:     covers</span>&#8221;</span> to see what is going on when a package is building
1.1       dsieger  1527:     or being installed. This may be for debugging purposes, or out of
                   1528:     simple curiosity. A number of utility values have been added to
                   1529:     help with this.</p>
1.23      wiz      1530: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1531: <li class="listitem">
1.125     leot     1532: <p>If you invoke the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1       dsieger  1533:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1534:        information will be displayed. For example,</p>
                   1535: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   1536: <p>will show all the commands that are invoked, up to and
1.23      wiz      1537:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.1       dsieger  1538: </li>
1.23      wiz      1539: <li class="listitem">
1.125     leot     1540: <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.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1       dsieger  1541:        definition, then the <code class="varname">VARNAME</code> definition
                   1542:        should be used, in conjunction with the show-var
1.125     leot     1543:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1       dsieger  1544:        variable <code class="varname">LOCALBASE</code>:</p>
                   1545: <pre class="screen">
                   1546: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   1547: /usr/pkg
                   1548: <code class="prompt">%</code>
                   1549:        </pre>
                   1550: </li>
                   1551: </ol></div>
                   1552: <p>If you want to install a binary package that you've either
                   1553:     created yourself (see next section), that you put into
                   1554:     pkgsrc/packages manually or that is located on a remote FTP
                   1555:     server, you can use the "bin-install" target. This target will
1.125     leot     1556:     install a binary package - if available - via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10      hubertf  1557:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  1558:     sites searched is kept in the variable
                   1559:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.125     leot     1560:     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.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1       dsieger  1561:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1562:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1563:     details.</p>
                   1564: <p>A final word of warning: If you set up a system that has a
                   1565:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1566:     set that before any packages are installed, as you cannot use
                   1567:     several directories for the same purpose. Doing so will result in
                   1568:     pkgsrc not being able to properly detect your installed packages,
                   1569:     and fail miserably. Note also that precompiled binary packages are
                   1570:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1571:     <code class="filename">/usr/pkg</code>, and that you should
                   1572:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1573:     <code class="varname">LOCALBASE</code>.</p>
                   1574: </div>
                   1575: </div>
                   1576: </div>
1.41      asau     1577: <div class="chapter">
1.1       dsieger  1578: <div class="titlepage"><div><div><h2 class="title">
                   1579: <a name="configuring"></a>Chapter 5. Configuring pkgsrc</h2></div></div></div>
                   1580: <div class="toc">
                   1581: <p><b>Table of Contents</b></p>
1.100     leot     1582: <dl class="toc">
1.1       dsieger  1583: <dt><span class="sect1"><a href="#general-configuration">5.1. General configuration</a></span></dt>
                   1584: <dt><span class="sect1"><a href="#variables-affecting-build">5.2. Variables affecting the build process</a></span></dt>
1.9       rillig   1585: <dt><span class="sect1"><a href="#variables-affecting-installation">5.3. Variables affecting the installation process</a></span></dt>
1.4       rillig   1586: <dt><span class="sect1"><a href="#conf.compiler">5.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger  1587: <dd><dl>
1.4       rillig   1588: <dt><span class="sect2"><a href="#selecting-the-compiler">5.4.1. Selecting the compiler</a></span></dt>
1.23      wiz      1589: <dt><span class="sect2"><a href="#conf.cflags">5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1590: <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.1       dsieger  1591: </dl></dd>
1.4       rillig   1592: <dt><span class="sect1"><a href="#developer-advanced-settings">5.5. Developer/advanced settings</a></span></dt>
                   1593: <dt><span class="sect1"><a href="#selecting-build-options">5.6. Selecting Build Options</a></span></dt>
1.1       dsieger  1594: </dl>
                   1595: </div>
1.4       rillig   1596: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  1597: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1598: that file depends on the installation. On NetBSD, when you use
1.125     leot     1599: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1       dsieger  1600: <code class="filename">/etc/</code>. In all other cases the default location is
                   1601: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1602: bootstrap program to install the binary packages.</p>
                   1603: <p>The format of the configuration file is that of the usual
                   1604: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1605: is done by setting variables in this file. Note that you can define all
                   1606: kinds of variables, and no special error checking (for example for
1.112     rillig   1607: spelling mistakes) takes place.</p>
1.41      asau     1608: <div class="sect1">
1.1       dsieger  1609: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1610: <a name="general-configuration"></a>5.1. General configuration</h2></div></div></div>
1.112     rillig   1611: <p>The following variables apply to all
1.1       dsieger  1612:     pkgsrc packages. A complete list of the variables that can be
                   1613:     configured by the user is available in
                   1614:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1615:     comments that describe each variable's intent.</p>
1.41      asau     1616: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1617: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger  1618:            packages will be installed. The default is
                   1619:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   1620:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23      wiz      1621: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1622:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.1       dsieger  1623:            installed. The default is
                   1624:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23      wiz      1625: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger  1626:            X11 is installed on the system. The default is
1.84      wiz      1627:            <code class="filename">/usr/X11R7</code>.</p></li>
1.23      wiz      1628: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger  1629:            downloaded copies of the original source distributions used
                   1630:            for building pkgsrc packages. The default is
                   1631:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23      wiz      1632: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger  1633:            database about installed packages is stored.  The default is
1.118     sevan    1634:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23      wiz      1635: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger  1636:            If set, override the packages'
                   1637:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23      wiz      1638: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger  1639:            Backup location(s) for distribution files and patch files
                   1640:            if not found locally or in
                   1641:            <code class="filename">${MASTER_SITES}</code> or
                   1642:            <code class="filename">${PATCH_SITES}</code> respectively.
1.118     sevan    1643:            The defaults is
                   1644:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23      wiz      1645: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger  1646:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1647:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23      wiz      1648:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1649:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1650: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22      jakllsch 1651:            List of acceptable licenses. License names are case-sensitive.
                   1652:            Whenever you try to build a package whose license is not in this
                   1653:            list, you will get an error message. If the license condition is
                   1654:            simple enough, the error message will include specific
                   1655:            instructions on how to change this variable.</p></li>
1.1       dsieger  1656: </ul></div>
                   1657: </div>
1.41      asau     1658: <div class="sect1">
1.1       dsieger  1659: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1660: <a name="variables-affecting-build"></a>5.2. Variables affecting the build process</h2></div></div></div>
1.108     rillig   1661: <p>
1.1       dsieger  1662:       </p>
1.41      asau     1663: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1664: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger  1665:            directory for the binary packages. The default is
                   1666:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23      wiz      1667: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger  1668:            The top level directory where, if defined, the separate
                   1669:            working directories will get created, and symbolically
                   1670:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   1671:            This is useful for building packages on several
                   1672:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1673:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   1674:            is local to every architecture. (It should be noted that
                   1675:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14      jmcneill 1676:            &mdash; it is an internal definition which refers to the
1.1       dsieger  1677:            root of the pkgsrc tree. It is possible to have many
                   1678:            pkgsrc tree instances.)</p></li>
1.23      wiz      1679: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger  1680:            Directory for local patches that aren't part of pkgsrc.
1.108     rillig   1681:            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.1       dsieger  1682:            information.</p></li>
1.23      wiz      1683: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  1684:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  1685:            BSD-style Makefile. If this is not set,
                   1686:            <code class="varname">MAKECONF</code> is set to
                   1687:            <code class="filename">/dev/null</code> to avoid picking up
                   1688:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.23      wiz      1689: <li class="listitem"><p><code class="varname">DEPENDS_TARGET</code>:
1.1       dsieger  1690:            By default, dependencies are only installed, and no binary
                   1691:            package is created for them. You can set this variable to
1.66      asau     1692:            <code class="literal">package-install</code> to automatically create binary
1.80      wiz      1693:            packages after installing dependencies. Please note that the
1.84      wiz      1694:            <code class="varname">PKGSRC_KEEP_BIN_PKGS</code> can be set to
1.80      wiz      1695:            <code class="literal">yes</code> to preserve binary packages when
                   1696:            using the <code class="literal">install</code> as well.</p></li>
1.1       dsieger  1697: </ul></div>
                   1698: </div>
1.41      asau     1699: <div class="sect1">
1.1       dsieger  1700: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.9       rillig   1701: <a name="variables-affecting-installation"></a>5.3. Variables affecting the installation process</h2></div></div></div>
1.107     jnemeth  1702: <p>Packages have to support installation into a
1.4       rillig   1703:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1704:     to be built, before the actual filesystem is touched. DESTDIR
                   1705:     support exists in two variations:</p>
1.41      asau     1706: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1707: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24      wiz      1708:       installation and packaging is still run as root.</p></li>
                   1709: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1710:       build, installation and packaging as normal user. Root
                   1711:       privileges are only needed to add packages.</p></li>
                   1712: </ul></div>
1.4       rillig   1713: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1714:     clean</code></strong> needs to be run as root.</p>
1.17      imil     1715: <p>Considering the <code class="filename">foo/bar</code> package,
                   1716:     DESTDIR full support can be tested using the following commands
                   1717: 
                   1718: </p>
                   1719: <pre class="programlisting">
                   1720: <code class="prompt">$</code> id
                   1721: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1722: <code class="prompt">$</code> mkdir $HOME/packages
                   1723: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1724: </pre>
                   1725: <p>
                   1726: 
                   1727:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1728:     should be needed
                   1729: 
                   1730: </p>
                   1731: <pre class="programlisting">
1.66      asau     1732: <code class="prompt">$</code> make stage-install
1.17      imil     1733: </pre>
                   1734: <p>
                   1735: 
                   1736:     Create a package without root privileges
                   1737: 
                   1738: </p>
                   1739: <pre class="programlisting">
1.66      asau     1740: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17      imil     1741: </pre>
                   1742: <p>
                   1743: 
                   1744:     For the following command, you must be able to gain root
1.125     leot     1745:     privileges using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17      imil     1746: 
                   1747: </p>
                   1748: <pre class="programlisting">
1.66      asau     1749: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17      imil     1750: </pre>
                   1751: <p>
                   1752: 
                   1753:     Then, as a simple user
                   1754: 
                   1755: </p>
                   1756: <pre class="programlisting">
                   1757: <code class="prompt">$</code> make clean
                   1758: </pre>
                   1759: <p>
                   1760: 
                   1761:     </p>
1.4       rillig   1762: </div>
1.41      asau     1763: <div class="sect1">
1.4       rillig   1764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1765: <a name="conf.compiler"></a>5.4. Selecting and configuring the compiler</h2></div></div></div>
1.41      asau     1766: <div class="sect2">
1.1       dsieger  1767: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   1768: <a name="selecting-the-compiler"></a>5.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  1769: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1770:     overridden by setting the following variables in /etc/mk.conf:</p>
1.41      asau     1771: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  1772: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1773: <dd>
                   1774: <p>This is a list of values specifying the chain of
                   1775:          compilers to invoke when building packages.  Valid values
                   1776:          are:</p>
1.41      asau     1777: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66      asau     1778: <li class="listitem"><p><code class="varname">ccc</code>:
                   1779:            Compaq C Compilers (Tru64)</p></li>
                   1780: <li class="listitem"><p><code class="varname">ccache</code>:
                   1781:            compiler cache (chainable)</p></li>
                   1782: <li class="listitem"><p><code class="varname">clang</code>:
                   1783:            Clang C and Objective-C compiler</p></li>
1.23      wiz      1784: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger  1785:            distributed C/C++ (chainable)</p></li>
1.66      asau     1786: <li class="listitem"><p><code class="varname">f2c</code>:
                   1787:            Fortran 77 to C compiler (chainable)</p></li>
                   1788: <li class="listitem"><p><code class="varname">icc</code>:
                   1789:            Intel C++ Compiler (Linux)</p></li>
                   1790: <li class="listitem"><p><code class="varname">ido</code>:
                   1791:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23      wiz      1792: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger  1793:            GNU C/C++ Compiler</p></li>
1.66      asau     1794: <li class="listitem"><p><code class="varname">hp</code>:
                   1795:            HP-UX C/aC++ compilers</p></li>
1.23      wiz      1796: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  1797:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66      asau     1798: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1       dsieger  1799:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23      wiz      1800: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger  1801:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66      asau     1802: <li class="listitem"><p><code class="varname">xlc</code>:
1.118     sevan    1803:            IBM's XL C/C++ compiler suite</p></li>
1.1       dsieger  1804: </ul></div>
                   1805: <p>The default is
1.23      wiz      1806:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger  1807:          <code class="varname">ccache</code> and/or
                   1808:          <code class="varname">distcc</code> with an appropriate
                   1809:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.23      wiz      1810:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger  1811:          variable should always be terminated with a value for
                   1812:          a real compiler.  Note that only one real compiler
1.23      wiz      1813:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger  1814:          is not allowed).</p>
                   1815: </dd>
                   1816: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1817: <dd><p>This specifies the minimum version of GCC to use
                   1818:          when building packages.  If the system GCC doesn't
                   1819:          satisfy this requirement, then pkgsrc will build and
                   1820:          install one of the GCC packages to use instead.</p></dd>
1.114     maya     1821: <dt><span class="term"><code class="varname">PYTHON_DEFAULT_VERSION</code>:</span></dt>
                   1822: <dd><p>Specifies which version of python to use when several
                   1823:          options are available.</p></dd>
                   1824: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
                   1825: <dd><p>Specifies the fortran compiler to use.
                   1826:          The default is <code class="varname">g95</code>, and
                   1827:          <code class="varname">gfortran</code> is an alternative.</p></dd>
                   1828: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1829: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1830:          <code class="varname">gfortran</code> is used, this option specifies which
                   1831:          version to use.</p></dd>
1.1       dsieger  1832: </dl></div>
                   1833: </div>
1.41      asau     1834: <div class="sect2">
1.1       dsieger  1835: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   1836: <a name="conf.cflags"></a>5.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1       dsieger  1837: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1838:        please make sure to use the <code class="literal">+=</code> operator
                   1839:        instead of the <code class="literal">=</code> operator:</p>
                   1840: <pre class="programlisting">
                   1841: CFLAGS+=        -your -flags
                   1842: </pre>
                   1843: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23      wiz      1844:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.16      jnemeth  1845:        need to add their own flags.  You may want to take a look
1.120     sevan    1846:        at the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23      wiz      1847:        package if you're interested in optimization specifically
                   1848:        for the current CPU. </p>
1.1       dsieger  1849: </div>
1.41      asau     1850: <div class="sect2">
1.1       dsieger  1851: <div class="titlepage"><div><div><h3 class="title">
1.4       rillig   1852: <a name="conf.ldflags"></a>5.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1       dsieger  1853: <p>If you want to pass flags to the linker, both in the configure
                   1854: step and the build step, you can do this in two ways.  Either set
                   1855: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1856: between the two is that <code class="varname">LIBS</code> will be appended to
                   1857: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1858: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1859: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1860: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1861: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1862: settings, use the <code class="literal">+=</code> operator:</p>
                   1863: <pre class="programlisting">
                   1864: LDFLAGS+=        -your -linkerflags
                   1865: </pre>
                   1866: </div>
                   1867: </div>
1.41      asau     1868: <div class="sect1">
1.1       dsieger  1869: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   1870: <a name="developer-advanced-settings"></a>5.5. Developer/advanced settings</h2></div></div></div>
1.84      wiz      1871: <p>
1.1       dsieger  1872:       </p>
1.41      asau     1873: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1874: <li class="listitem">
1.1       dsieger  1875: <p><code class="varname">PKG_DEVELOPER</code>:
                   1876:            Run some sanity checks that package developers want:
                   1877:            </p>
1.41      asau     1878: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23      wiz      1879: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger  1880:              fuzz</p></li>
1.23      wiz      1881: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger  1882:              binaries will find their shared libs.</p></li>
                   1883: </ul></div>
                   1884: <p>
                   1885:        </p>
                   1886: </li>
1.23      wiz      1887: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger  1888:        of debugging output which is displayed whilst making and
                   1889:        installing the package.  The default value for this is 0,
                   1890:        which will not display the commands as they are executed
                   1891:        (normal, default, quiet operation); the value 1 will display
                   1892:        all shell commands before their invocation, and the value 2
                   1893:        will display both the shell commands before their invocation,
1.112     rillig   1894:        as well as their actual execution progress with <span class="command"><strong>set
                   1895:        -x</strong></span>.</p></li>
1.1       dsieger  1896: </ul></div>
                   1897: <p>
                   1898:     </p>
                   1899: </div>
1.41      asau     1900: <div class="sect1">
1.1       dsieger  1901: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.4       rillig   1902: <a name="selecting-build-options"></a>5.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  1903: <p>Some packages have build time options, usually to select
                   1904:     between different dependencies, enable optional support for big
                   1905:     dependencies or enable experimental features.</p>
                   1906: <p>To see which options, if any, a package supports, and which
1.10      hubertf  1907:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  1908:     show-options</strong></span>, for example:</p>
                   1909: <pre class="programlisting">
                   1910:     The following options are supported by this package:
                   1911:         ssl      Enable SSL support.
                   1912:     Exactly one of the following gecko options is required:
                   1913:         firefox  Use firefox as gecko rendering engine.
                   1914:         mozilla  Use mozilla as gecko rendering engine.
                   1915:     At most one of the following database options may be selected:
                   1916:         mysql    Enable support for MySQL database.
                   1917:         pgsql    Enable support for PostgreSQL database.
                   1918: 
                   1919:     These options are enabled by default: firefox
                   1920:     These options are currently enabled: mozilla ssl
                   1921: </pre>
                   1922: <p>The following variables can be defined in
1.10      hubertf  1923:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  1924:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1925:     which can be used to select or disable options for all packages
                   1926:     that support them, and
                   1927:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   1928:     which can be used to select or disable options specifically for
                   1929:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.23      wiz      1930:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger  1931:     are disabled. A few examples:</p>
                   1932: <pre class="screen">
1.10      hubertf  1933: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1       dsieger  1934: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   1935: PKG_OPTIONS.kdebase=    debug -sasl
                   1936: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   1937: <p>It is important to note that options that were specifically
1.18      snj      1938:     suggested by the package maintainer must be explicitly removed if
1.11      rillig   1939:     you do not wish to include the option.  If you are unsure you can view
                   1940:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger  1941: <p>The following settings are consulted in the order given, and
                   1942:     the last setting that selects or disables an option is
                   1943:     used:</p>
1.23      wiz      1944: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1945: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger  1946:       maintainer</p></li>
1.23      wiz      1947: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger  1948:       variables (see below)</p></li>
1.23      wiz      1949: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   1950: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1       dsieger  1951: </ol></div>
                   1952: <p>For groups of mutually exclusive options, the last option
                   1953:     selected is used, all others are automatically disabled.  If an
                   1954:     option of the group is explicitly disabled, the previously
                   1955:     selected option, if any, is used.  It is an error if no option
                   1956:     from a required group of options is selected, and building the
                   1957:     package will fail.</p>
                   1958: <p>Before the options framework was introduced, build options
                   1959:     were selected by setting a variable (often named
                   1960:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10      hubertf  1961:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  1962:     transition to the options framework for the user, these legacy
                   1963:     variables are converted to the appropriate options setting
                   1964:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   1965:     automatically.  A warning is issued to prompt the user to update
1.10      hubertf  1966:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  1967:     directly.  Support for the legacy variables will be removed
                   1968:     eventually.</p>
                   1969: </div>
                   1970: </div>
1.41      asau     1971: <div class="chapter">
1.1       dsieger  1972: <div class="titlepage"><div><div><h2 class="title">
                   1973: <a name="binary"></a>Chapter 6. Creating binary packages</h2></div></div></div>
                   1974: <div class="toc">
                   1975: <p><b>Table of Contents</b></p>
1.100     leot     1976: <dl class="toc">
1.1       dsieger  1977: <dt><span class="sect1"><a href="#building-a-single-binary-package">6.1. Building a single binary package</a></span></dt>
                   1978: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">6.2. Settings for creation of binary packages</a></span></dt>
                   1979: </dl>
                   1980: </div>
1.41      asau     1981: <div class="sect1">
1.1       dsieger  1982: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   1983: <a name="building-a-single-binary-package"></a>6.1. Building a single binary package</h2></div></div></div>
                   1984: <p>Once you have built and installed a package, you can create
                   1985:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.125     leot     1986:     another system with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1       dsieger  1987:     the same package on a group of hosts and wasting CPU time. It also
                   1988:     provides a simple means for others to install your package, should
                   1989:     you distribute it.</p>
                   1990: <p>To create a binary package, change into the appropriate
1.10      hubertf  1991:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  1992:     package</strong></span>:</p>
                   1993: <pre class="screen">
1.112     rillig   1994: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1995: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   1996: </pre>
1.1       dsieger  1997: <p>This will build and install your package (if not already done),
                   1998:     and then build a binary package from what was installed. You can
1.10      hubertf  1999:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2000:     it. Binary packages are created by default in
                   2001:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10      hubertf  2002:     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.120     sevan    2003:     continuation of the above <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.10      hubertf  2004: <p>See <a class="xref" href="#submit" title="Chapter 21. Submitting and Committing">Chapter 21, <i>Submitting and Committing</i></a> for information on how to submit
1.1       dsieger  2005:     such a binary package.</p>
                   2006: </div>
1.41      asau     2007: <div class="sect1">
1.1       dsieger  2008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2009: <a name="settings-for-creationg-of-binary-packages"></a>6.2. Settings for creation of binary packages</h2></div></div></div>
1.10      hubertf  2010: <p>See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.6       rillig   2011: </div>
                   2012: </div>
1.41      asau     2013: <div class="chapter">
1.6       rillig   2014: <div class="titlepage"><div><div><h2 class="title">
                   2015: <a name="bulk"></a>Chapter 7. Creating binary packages for everything in pkgsrc (bulk
                   2016: builds)</h2></div></div></div>
                   2017: <div class="toc">
                   2018: <p><b>Table of Contents</b></p>
1.100     leot     2019: <dl class="toc">
1.71      wiz      2020: <dt><span class="sect1"><a href="#bulk.pre">7.1. Preparations</a></span></dt>
                   2021: <dt><span class="sect1"><a href="#bulk.pbulk">7.2. Running a pbulk-style bulk build</a></span></dt>
                   2022: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">7.2.1. Configuration</a></span></dt></dl></dd>
                   2023: <dt><span class="sect1"><a href="#bulk.req">7.3. Requirements of a full bulk build</a></span></dt>
1.66      asau     2024: <dt><span class="sect1"><a href="#creating-cdroms">7.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2025: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">7.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6       rillig   2026: </dl>
                   2027: </div>
1.71      wiz      2028: <p>For a number of reasons you may want to build binary packages
                   2029: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
                   2030: For instance, when you have multiple machines that should run the same software,
                   2031: it is wasted time if they all build their packages themselves from source.
                   2032: Or you may want to build a list of packages you want and check them before
                   2033: deploying onto production system.
                   2034: There is a way of getting a set of binary packages:
1.112     rillig   2035: The bulk build system, or pbulk ("p" stands for "parallel").
                   2036: This chapter describes how to set it up.</p>
1.41      asau     2037: <div class="sect1">
1.6       rillig   2038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71      wiz      2039: <a name="bulk.pre"></a>7.1. Preparations</h2></div></div></div>
                   2040: <p>First of all, you have to decide whether you build all packages
                   2041: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2042: both space and time, than builds for some practical sets of packages.
                   2043: There exists a number of particularly heavy packages that are not actually
                   2044: interesting to a wide audience.
                   2045: 
                   2046: For a limited bulk builds you need to make a list of packages you want to build.
1.112     rillig   2047: Note that all their dependencies will be built, so you don't need to track them manually.
1.71      wiz      2048: </p>
                   2049: <p>During bulk builds various packages are installed and deinstalled
                   2050: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2051: so make sure that you don't need any package during the builds.
1.112     rillig   2052: Essentially, you should provide a fresh system, either a chroot environment
1.71      wiz      2053: or something even more restrictive, depending on what the operating system provides,
                   2054: or dedicate the whole physical machine.
                   2055: As a useful side effect this makes sure that bulk builds cannot
                   2056: break anything in your system. There have been numerous cases where
1.6       rillig   2057: certain packages tried to install files outside the
                   2058: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71      wiz      2059: <code class="filename">/etc</code>.
                   2060: </p>
1.6       rillig   2061: </div>
1.41      asau     2062: <div class="sect1">
1.6       rillig   2063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71      wiz      2064: <a name="bulk.pbulk"></a>7.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15      rillig   2065: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41      asau     2066: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2067: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2068: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15      rillig   2069: </ul></div>
1.41      asau     2070: <div class="sect2">
1.15      rillig   2071: <div class="titlepage"><div><div><h3 class="title">
1.71      wiz      2072: <a name="bulk.pbulk.conf"></a>7.2.1. Configuration</h3></div></div></div>
1.112     rillig   2073: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68      asau     2074: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2075: Configure network access to fetch distribution files.
1.112     rillig   2076: Create a user with name "pbulk".</p>
1.68      asau     2077: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2078: <pre class="screen">
1.72      wiz      2079: <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>
                   2080: <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>
                   2081: <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.68      asau     2082: </pre>
                   2083: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2084: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2085: <pre class="screen">
1.118     sevan    2086: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.68      asau     2087: <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>
                   2088: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2089: </pre>
                   2090: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2091: <h3 class="title">Note</h3>
                   2092: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2093: <code class="filename">mk.conf</code> that contains settings you want to
                   2094: apply to packages you build. For instance,</p>
                   2095: <pre class="programlisting">
1.112     rillig   2096: PKG_DEVELOPER=          yes     # perform more checks
                   2097: X11_TYPE=               modular # use pkgsrc X11
                   2098: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2099:                                 # when building all packages)
1.68      asau     2100: </pre>
                   2101: </div>
                   2102: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112     rillig   2103: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68      asau     2104: <pre class="programlisting">
                   2105: www/firefox
                   2106: mail/thunderbird
                   2107: misc/libreoffice4
                   2108: </pre>
1.69      asau     2109: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2110: and make final amendments, if wanted.</p>
1.68      asau     2111: <p>Start it:</p>
                   2112: <pre class="screen">
                   2113: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2114: </pre>
                   2115: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2116: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2117: </p>
                   2118: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2119: <h3 class="title">Note</h3>
                   2120: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2121: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2122: The script is kept small enough for better understanding.</p>
                   2123: </div>
                   2124: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2125: <h3 class="title">Note</h3>
                   2126: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2127: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2128: </div>
1.6       rillig   2129: </div>
                   2130: </div>
1.41      asau     2131: <div class="sect1">
1.6       rillig   2132: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.71      wiz      2133: <a name="bulk.req"></a>7.3. Requirements of a full bulk build</h2></div></div></div>
                   2134: <p>A complete bulk build requires lots of disk space. Some of the
                   2135: disk space can be read-only, some other must be writable. Some can be on
                   2136: remote filesystems (such as NFS) and some should be local. Some can be
                   2137: temporary filesystems, others must survive a sudden reboot.</p>
                   2138: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2139: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2140: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2141: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2142: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2143: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2144: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2145: </ul></div>
                   2146: </div>
                   2147: <div class="sect1">
                   2148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.66      asau     2149: <a name="creating-cdroms"></a>7.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  2150: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2151:     create a CD-ROM set of the resulting binary packages to assist
                   2152:     in installing packages on other machines.  The
1.120     sevan    2153:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1       dsieger  2154:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  2155:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  2156:     way that keeps all the dependencies for a given package on the same
                   2157:     CD as that package.</p>
1.41      asau     2158: <div class="sect2">
1.1       dsieger  2159: <div class="titlepage"><div><div><h3 class="title">
1.66      asau     2160: <a name="cdpack-example"></a>7.4.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  2161: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2162:       man page. The following short example assumes that the binary
                   2163:       packages are left in
                   2164:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2165:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2166:       hold the ISO 9660 images.</p>
                   2167: <pre class="screen">
                   2168: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   2169: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   2170: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2171:       </pre>
                   2172: <p>If you wish to include a common set of files
                   2173:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2174:       etc.) on each CD in the collection, then you need to create a
                   2175:       directory which contains these files. e.g.</p>
                   2176: <pre class="screen">
                   2177: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   2178: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2179: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2180: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2181: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2182: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   2183: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2184:       </pre>
                   2185: <p>Now create the images:</p>
                   2186: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   2187: <p>Each image will contain <code class="filename">README</code>,
                   2188:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2189:       in their root directories.</p>
                   2190: </div>
                   2191: </div>
                   2192: </div>
1.41      asau     2193: <div class="chapter">
1.1       dsieger  2194: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   2195: <a name="files"></a>Chapter 8. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  2196: <div class="toc">
                   2197: <p><b>Table of Contents</b></p>
1.100     leot     2198: <dl class="toc">
1.23      wiz      2199: <dt><span class="sect1"><a href="#files.localbase">8.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2200: <dt><span class="sect1"><a href="#files.varbase">8.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1       dsieger  2201: </dl>
                   2202: </div>
                   2203: <p>The files that are installed by pkgsrc are organized in a way that
                   2204: is similar to what you find in the <code class="filename">/usr</code> directory
                   2205: of the base system. But some details are different. This is because
                   2206: pkgsrc initially came from FreeBSD and had adopted its file system
                   2207: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2208: which operating system you are using pkgsrc with, you can expect the
                   2209: same layout for pkgsrc.</p>
                   2210: <p>There are mainly four root directories for pkgsrc, which are all
                   2211: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2212: When pkgsrc has been installed as root, the default locations
                   2213: are:</p>
                   2214: <pre class="programlisting">
                   2215: LOCALBASE=              /usr/pkg
                   2216: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2217: VARBASE=                /var
1.119     sevan    2218: PKG_DBDIR=              /usr/pkg/pkgdb
1.1       dsieger  2219: </pre>
                   2220: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2221: user), the default locations are:</p>
                   2222: <pre class="programlisting">
                   2223: LOCALBASE=              ${HOME}/pkg
                   2224: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2225: VARBASE=                ${HOME}/pkg/var
1.119     sevan    2226: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.1       dsieger  2227: </pre>
                   2228: <p>What these four directories are for, and what they look like is
                   2229: explained below.</p>
1.41      asau     2230: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2231: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1       dsieger  2232: <code class="filename">/usr</code> directory in the base system. It is the
1.23      wiz      2233: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.1       dsieger  2234: the well-known subdirectories like <code class="filename">bin</code>,
                   2235: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2236: <code class="filename">share</code> and
                   2237: <code class="filename">sbin</code>.</p></li>
1.23      wiz      2238: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1       dsieger  2239: <code class="filename">/var</code> in the base system. Some programs (especially
                   2240: games, network daemons) need write access to it during normal
                   2241: operation.</p></li>
1.23      wiz      2242: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1       dsieger  2243: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      hubertf  2244: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  2245: itself.</p></li>
                   2246: </ul></div>
1.41      asau     2247: <div class="sect1">
1.1       dsieger  2248: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2249: <a name="files.localbase"></a>8.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  2250: </h2></div></div></div>
                   2251: <p>The following directories exist in a typical pkgsrc installation
                   2252: in <code class="filename">${LOCALBASE}</code>.</p>
1.41      asau     2253: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2254: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2255: <dd><p>Contains executable programs that are intended to be
                   2256: directly used by the end user.</p></dd>
                   2257: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2258: <dd><p>Contains files for the emulation layers of various other
                   2259: operating systems, especially for
                   2260: NetBSD.</p></dd>
                   2261: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2262: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2263: <dd><p>Contains
                   2264: the configuration files.</p></dd>
                   2265: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2266: <dd><p>Contains headers for the C and C++ programming
                   2267: languages.</p></dd>
                   2268: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2269: <dd><p>Contains GNU info files of various
                   2270: packages.</p></dd>
                   2271: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2272: <dd><p>Contains shared and static
                   2273: libraries.</p></dd>
                   2274: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2275: <dd><p>Contains data files that don't change after
                   2276: installation. Other data files belong into
                   2277: <code class="filename">${VARBASE}</code>.</p></dd>
                   2278: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2279: <dd><p>Contains programs that are not intended to be used by
                   2280: end users, such as helper programs or network
                   2281: daemons.</p></dd>
                   2282: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2283: <dd><p>Contains programs that are intended to be executed as
                   2284: CGI scripts by a web server.</p></dd>
                   2285: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2286: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2287: <dd><p>Contains brief
                   2288: documentation in form of manual pages.</p></dd>
                   2289: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2290: <dd><p>Contains programs that are intended to be used only by
                   2291: the super-user.</p></dd>
                   2292: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2293: <dd><p>Contains platform-independent data files that don't
                   2294: change after installation.</p></dd>
                   2295: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2296: <dd><p>Contains documentation files provided by the
                   2297: packages.</p></dd>
                   2298: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2299: <dd><p>Contains example files provided by the packages. Among
                   2300: others, the original configuration files are saved here and copied to
                   2301: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2302: installation.</p></dd>
                   2303: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2304: <dd><p>Contains the original files for rc.d
                   2305: scripts.</p></dd>
                   2306: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2307: <code class="filename">${VARBASE}</code>)</span></dt>
                   2308: <dd><p>Contains files
                   2309: that may be modified after
                   2310: installation.</p></dd>
                   2311: </dl></div>
                   2312: </div>
1.41      asau     2313: <div class="sect1">
1.1       dsieger  2314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2315: <a name="files.varbase"></a>8.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  2316: </h2></div></div></div>
1.41      asau     2317: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2318: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2319: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2320: <dd><p>Contains
                   2321: information about the currently installed
                   2322: packages.</p></dd>
                   2323: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2324: <dd><p>Contains highscore
                   2325: files.</p></dd>
                   2326: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2327: <dd><p>Contains log files.</p></dd>
                   2328: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2329: <dd><p>Contains informational files about daemons that are
                   2330: currently running.</p></dd>
                   2331: </dl></div>
                   2332: </div>
                   2333: </div>
1.41      asau     2334: <div class="chapter">
1.1       dsieger  2335: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   2336: <a name="faq"></a>Chapter 9. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  2337: <div class="toc">
                   2338: <p><b>Table of Contents</b></p>
1.100     leot     2339: <dl class="toc">
1.6       rillig   2340: <dt><span class="sect1"><a href="#mailing-list-pointers">9.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
1.84      wiz      2341: <dt><span class="sect1"><a href="#faq-pkgtools">9.2. Utilities for package management (pkgtools)</a></span></dt>
                   2342: <dt><span class="sect1"><a href="#non-root-pkgsrc">9.3. How to use pkgsrc as non-root</a></span></dt>
                   2343: <dt><span class="sect1"><a href="#resume-transfers">9.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2344: <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>
                   2345: <dt><span class="sect1"><a href="#fetch-behind-firewall">9.6. How to fetch files from behind a firewall</a></span></dt>
                   2346: <dt><span class="sect1"><a href="#fetch-https">9.7. How to fetch files from HTTPS sites</a></span></dt>
                   2347: <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>
                   2348: <dt><span class="sect1"><a href="#fetching-all-distfiles">9.9. How to fetch all distfiles at once</a></span></dt>
                   2349: <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.23      wiz      2350: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.84      wiz      2351: <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>
                   2352: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">9.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2353: <dt><span class="sect1"><a href="#faq.conf">9.13. How do I change the location of configuration files?</a></span></dt>
                   2354: <dt><span class="sect1"><a href="#audit-packages">9.14. Automated security checks</a></span></dt>
                   2355: <dt><span class="sect1"><a href="#ufaq-cflags">9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2356: <dt><span class="sect1"><a href="#ufaq-fail">9.16. A package does not build.  What shall I do?</a></span></dt>
                   2357: <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.1       dsieger  2358: </dl>
                   2359: </div>
                   2360: <p>This section contains hints, tips &amp; tricks on special things in
                   2361: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2362: it contains items for both pkgsrc users and developers.</p>
1.41      asau     2363: <div class="sect1">
1.1       dsieger  2364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   2365: <a name="mailing-list-pointers"></a>9.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  2366: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41      asau     2367: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2368: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1       dsieger  2369:          This is a general purpose list for most issues regarding
                   2370:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2371:          for pkgsrc configuration, unexpected build failures, using
                   2372:          particular packages, upgrading pkgsrc installations,
                   2373:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2374:          proposals for changes that impact the pkgsrc user community,
                   2375:          e.g. major infrastructure changes, new features, package
                   2376:          removals, etc., may also be posted.</p></li>
1.23      wiz      2377: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1       dsieger  2378:          A list where the results of pkgsrc bulk builds are sent and
                   2379:          discussed.</p></li>
1.23      wiz      2380: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1       dsieger  2381:          This list is for those who are interested in getting a
                   2382:          commit message for every change committed to pkgsrc. It is
                   2383:          also available in digest form, meaning one daily message
                   2384:          containing all commit messages for changes to the package
                   2385:          source tree in that 24 hour period.</p></li>
                   2386: </ul></div>
                   2387: <p>To subscribe, do:</p>
                   2388: <pre class="programlisting">
                   2389: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   2390: </pre>
                   2391: <p>Archives for all these mailing lists are available from
1.10      hubertf  2392: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  2393: </div>
1.41      asau     2394: <div class="sect1">
1.1       dsieger  2395: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2396: <a name="faq-pkgtools"></a>9.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  2397: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   2398: a number of useful utilities for both users and developers of pkgsrc.  This
1.121     sevan    2399: section attempts only to make the reader aware of some of the utilities and when
1.1       dsieger  2400: they might be useful, and not to duplicate the documentation that comes
                   2401: with each package.</p>
                   2402: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.120     sevan    2403: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1       dsieger  2404:       Symlinks for use by buildlink.</p></li></ul></div>
                   2405: <p>OS tool augmentation (automatically installed when needed):</p>
1.41      asau     2406: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120     sevan    2407: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.121     sevan    2408:       Calculates various kinds of checksums (including SHA3).</p></li>
1.120     sevan    2409: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1       dsieger  2410:       Compatibility library for pkgsrc tools.</p></li>
1.120     sevan    2411: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1       dsieger  2412:       non-BSD systems due to lack of native mtree.</p></li>
1.120     sevan    2413: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1       dsieger  2414:       Up-to-date replacement for
                   2415:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   2416:       systems where pkg_install is not present.</p></li>
                   2417: </ul></div>
                   2418: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41      asau     2419: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120     sevan    2420: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1       dsieger  2421:       Create a binary package from an
1.10      hubertf  2422:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  2423:       save the old package.</p></li>
1.120     sevan    2424: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1       dsieger  2425:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2426:       from multiple locations. It currently supports the following
                   2427:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.120     sevan    2428: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16      jnemeth  2429:       the best compiler flags to optimise code for your current
1.23      wiz      2430:       CPU and compiler. </p></li>
1.1       dsieger  2431: </ul></div>
                   2432: <p>Utilities for keeping track of installed packages, being up to date,
                   2433: etc:</p>
1.41      asau     2434: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120     sevan    2435: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65      wiz      2436:     update tool similar to apt(1). Download, install, and upgrade
                   2437:     binary packages easily.</p></li>
1.120     sevan    2438: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1       dsieger  2439:       packages whose installed versions do not match the latest pkgsrc
                   2440:       entries.</p></li>
1.120     sevan    2441: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1       dsieger  2442:       dependency graphs of packages, to aid in choosing a strategy for
                   2443:       updating.</p></li>
1.120     sevan    2444: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   2445:       graphs from the output of <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   2446: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12      weinem   2447:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.120     sevan    2448: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1       dsieger  2449:       does various checks on the complete pkgsrc system.</p></li>
1.120     sevan    2450: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1       dsieger  2451:       packages you have installed.</p></li>
                   2452: </ul></div>
                   2453: <p>Utilities for people maintaining or creating individual packages:</p>
1.41      asau     2454: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120     sevan    2455: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1       dsieger  2456:       making and maintaining patches for a package (includes pkgdiff,
                   2457:       pkgvi, mkpatches, etc.).</p></li>
1.120     sevan    2458: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1       dsieger  2459:       converting to pkgsrc.</p></li>
                   2460: </ul></div>
                   2461: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2462: utilities)</p>
1.41      asau     2463: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120     sevan    2464: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1       dsieger  2465:       packages in a chrooted area.</p></li>
1.120     sevan    2466: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1       dsieger  2467:       kernel version for chrooted cross builds.</p></li>
                   2468: </ul></div>
                   2469: </div>
1.41      asau     2470: <div class="sect1">
1.1       dsieger  2471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2472: <a name="non-root-pkgsrc"></a>9.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108     rillig   2473: <p>To install packages from source as a non-root user, download
                   2474: 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
                   2475: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2476: --unprivileged</strong></span>.</p>
                   2477: <p>This will install the binary part of pkgsrc to
                   2478: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2479: into <code class="filename">~/pkg/etc</code>.</p>
                   2480: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1       dsieger  2481: </div>
1.41      asau     2482: <div class="sect1">
1.1       dsieger  2483: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2484: <a name="resume-transfers"></a>9.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  2485: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2486: enable this feature by adding the option
                   2487: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10      hubertf  2488: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  2489: distfile is found, pkgsrc will try to resume it.</p>
                   2490: <p>You can also
1.61      wiz      2491: use a different program than the platform default program by changing the
1.16      jnemeth  2492: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2493: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2494: by using the value manual.  A value of custom disables the system defaults
                   2495: and dependency tracking for the fetch program.  In that case you have to
                   2496: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2497: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2498: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1       dsieger  2499: <p>For example, if you want to use
1.16      jnemeth  2500: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  2501: like:</p>
                   2502: <pre class="programlisting">
1.112     rillig   2503: FETCH_USING=    wget
1.1       dsieger  2504: </pre>
                   2505: </div>
1.41      asau     2506: <div class="sect1">
1.1       dsieger  2507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2508: <a name="x.org-from-pkgsrc"></a>9.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4       rillig   2509: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  2510: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   2511: you will have to add the following line into
1.10      hubertf  2512: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  2513: <pre class="programlisting">
1.4       rillig   2514: X11_TYPE=modular
1.1       dsieger  2515: </pre>
                   2516: </div>
1.41      asau     2517: <div class="sect1">
1.1       dsieger  2518: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2519: <a name="fetch-behind-firewall"></a>9.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  2520: <p>If you are sitting behind a firewall which does not allow direct
                   2521: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2522: relevant proxy hosts.  This is done using an environment variable in the
                   2523: form of a URL, e.g. in Amdahl, the machine
1.23      wiz      2524: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.1       dsieger  2525: port 80 as the proxy port number.  So the proxy environment variables
                   2526: are:</p>
                   2527: <pre class="programlisting">
                   2528: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2529: http_proxy=http://orpheus.amdahl.com:80/
                   2530: </pre>
                   2531: </div>
1.41      asau     2532: <div class="sect1">
1.1       dsieger  2533: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2534: <a name="fetch-https"></a>9.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65      wiz      2535: <p>Some fetch tools are not prepared to support HTTPS by default
                   2536: (for example, the one in NetBSD 6.0), or the one installed by the
                   2537: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2538: dependency graph).</p>
                   2539: <p>Usually you won't notice, because distribution files are
                   2540: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2541: be often enough if you are following pkgsrc-current. In that case, set
                   2542: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2543: <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
                   2544: with HTTPS support by default. Of course, these tools need to be
                   2545: installed before you can use them this way.</p>
                   2546: </div>
                   2547: <div class="sect1">
                   2548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2549: <a name="passive-ftp"></a>9.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1       dsieger  2550: <p>This depends on which utility is used to retrieve distfiles.  From
                   2551: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   2552: the first available command from the following list:</p>
1.41      asau     2553: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2554: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2555: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1       dsieger  2556: </ul></div>
                   2557: <p>On a default NetBSD installation, this will be
                   2558: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   2559: connections first, and falls back to active connections if the server
                   2560: refuses to do passive.  For the other tools, add the following to your
1.10      hubertf  2561: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  2562: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2563: <p>Having that option present will prevent
                   2564: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   2565: transfers.</p>
                   2566: </div>
1.41      asau     2567: <div class="sect1">
1.1       dsieger  2568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2569: <a name="fetching-all-distfiles"></a>9.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  2570: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  2571: from work or university, where you can't run a <span class="command"><strong>make
1.25      spz      2572: 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.1       dsieger  2573: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  2574: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  2575: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   2576: resulting list to your machine at work/school and use it there.  If you
1.125     leot     2577: don't have a NetBSD-compatible <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1       dsieger  2578: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2579: URL:</p>
                   2580: <p>At home:</p>
                   2581: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2582: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2583: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2584: <p>At work:</p>
                   2585: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   2586: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   2587: home.</p>
                   2588: <p>If you have a machine running NetBSD, and you want to get
                   2589: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2590: machine architecture), you can do so by using the above-mentioned
1.10      hubertf  2591: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  2592: directly by running:</p>
                   2593: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2594: <p>If you even decide to ignore
                   2595: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2596: by running:</p>
                   2597: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2598: </div>
1.41      asau     2599: <div class="sect1">
1.1       dsieger  2600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2601: <a name="tmac.andoc-missing"></a>9.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.23      wiz      2602: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.120     sevan    2603: <p>When compiling the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1       dsieger  2604: package, you get the error from make that it doesn't know how to make
                   2605: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23      wiz      2606: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.1       dsieger  2607: the NetBSD base distribution on your machine.  It is recommended to do
                   2608: that to format man pages.</p>
1.120     sevan    2609: <p>In the case of the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.1       dsieger  2610: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  2611: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  2612: </div>
1.41      asau     2613: <div class="sect1">
1.1       dsieger  2614: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2615: <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.1       dsieger  2616: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   2617: when you installed your NetBSD machine.  Please get and install it, by
                   2618: extracting it in <code class="filename">/</code>:</p>
                   2619: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2620: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   2621: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  2622: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  2623: -r</strong></span>).</p>
                   2624: </div>
1.41      asau     2625: <div class="sect1">
1.1       dsieger  2626: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2627: <a name="using-sudo-with-pkgsrc"></a>9.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  2628: <p>When installing packages as non-root user and using the just-in-time
1.125     leot     2629: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.1       dsieger  2630: password for each required package installed.  To avoid this, the sudo
                   2631: package can be used, which does password caching over a limited time.  To
                   2632: use it, install sudo (either as binary package or from
1.120     sevan    2633: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10      hubertf  2634: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  2635: <span class="emphasis"><em>after</em></span> the definition of the
                   2636: <code class="varname">LOCALBASE</code> variable:</p>
                   2637: <pre class="programlisting">
                   2638: .if exists(${LOCALBASE}/bin/sudo)
                   2639: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2640: .endif
                   2641: </pre>
                   2642: </div>
1.41      asau     2643: <div class="sect1">
1.1       dsieger  2644: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2645: <a name="faq.conf"></a>9.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  2646: <p>As the system administrator, you can choose where configuration files
                   2647: are installed.  The default settings make all these files go into
                   2648: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   2649: be suboptimal depending on your expectations (e.g., a read-only,
                   2650: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2651: configuration of the provided packages).</p>
                   2652: <p>In order to change the defaults, you can modify the
                   2653: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10      hubertf  2654: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  2655: directory; some common examples include <code class="filename">/etc</code> or
                   2656: <code class="filename">/etc/pkg</code>.</p>
                   2657: <p>Furthermore, you can change this value on a per-package basis by
                   2658: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2659: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2660: package you would like to modify, that is, the contents of
                   2661: <code class="varname">PKGBASE</code>.</p>
                   2662: <p>Note that after changing these settings, you must rebuild and
                   2663: reinstall any affected packages.</p>
                   2664: </div>
1.41      asau     2665: <div class="sect1">
1.1       dsieger  2666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2667: <a name="audit-packages"></a>9.14. Automated security checks</h2></div></div></div>
1.1       dsieger  2668: <p>Please be aware that there can often be bugs in third-party software,
                   2669: and some of these bugs can leave a machine vulnerable to exploitation by
                   2670: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   2671: maintains a database of known-exploits to packages which have at one time
                   2672: been included in pkgsrc.  The database can be downloaded automatically, and
                   2673: a security audit of all packages installed on a system can take place.  To
1.14      jmcneill 2674: do this, refer to the following two tools (installed as part of the
1.120     sevan    2675: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23      wiz      2676: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2677: <li class="listitem">
1.20      snj      2678: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1       dsieger  2679:     download a list of the security vulnerabilities information.  This list
1.25      spz      2680:     is kept up to date by the pkgsrc security team, and is distributed
                   2681:     from the NetBSD ftp server:</p>
                   2682: <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.1       dsieger  2683: </li>
1.23      wiz      2684: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   2685:     current machine, checking each known vulnerability.  If a
1.1       dsieger  2686:     vulnerable package is installed, it will be shown by output to stdout,
                   2687:     including a description of the type of vulnerability, and a URL
                   2688:     containing more information.</p></li>
                   2689: </ol></div>
1.121     sevan    2690: <p>Use of these tools is strongly recommended!
                   2691: See <a class="xref" href="#vulnerabilities" title="4.1.5. Checking for security vulnerabilities in installed packages">Section 4.1.5, &#8220;Checking for security vulnerabilities in installed packages&#8221;</a> for instructions on how to automate checking and
                   2692: reporting.</p>
                   2693: <p>If this database is installed, pkgsrc builds will use it to
                   2694: perform a security check before building any package.</p>
1.1       dsieger  2695: </div>
1.41      asau     2696: <div class="sect1">
1.1       dsieger  2697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2698: <a name="ufaq-cflags"></a>9.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1       dsieger  2699: <p>When you add your own preferences to the
                   2700:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  2701:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  2702:        environment variables to the <code class="filename">./configure</code>
1.125     leot     2703:        scripts and to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1       dsieger  2704:        <code class="varname">CFLAGS</code> from the environment variable by
                   2705:        overriding them in the <code class="filename">Makefile</code>s of their
                   2706:        package.</p>
                   2707: <p>Currently there is no solution to this problem. If you
                   2708:        really need the package to use your <code class="varname">CFLAGS</code>
1.10      hubertf  2709:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  2710:        directory and then inspect any <code class="filename">Makefile</code> and
                   2711:        <code class="filename">Makefile.in</code> for whether they define
                   2712:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23      wiz      2713:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.1       dsieger  2714:        programmers write so bad code that it only works for the
                   2715:        specific combination of <code class="varname">CFLAGS</code> they have
                   2716:        chosen.</p>
                   2717: </div>
1.41      asau     2718: <div class="sect1">
1.1       dsieger  2719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2720: <a name="ufaq-fail"></a>9.16. A package does not build.  What shall I do?</h2></div></div></div>
1.23      wiz      2721: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     2722: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1       dsieger  2723:        case that occurs often is that people only update pkgsrc in
                   2724:        parts, because of performance reasons. Since pkgsrc is one large
                   2725:        system, not a collection of many small systems, there are
                   2726:        sometimes changes that only work when the whole pkgsrc tree is
                   2727:        updated.</p></li>
1.41      asau     2728: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23      wiz      2729:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   2730:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.1       dsieger  2731:        files.</p></li>
1.41      asau     2732: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10      hubertf  2733:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  2734:        verify this.</p></li>
1.108     rillig   2735: <li class="step"><p>If you are a package developer who wants to invest
                   2736:        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.41      asau     2737: <li class="step"><p>If the problem still exists, write a mail to the
1.1       dsieger  2738:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   2739: </ol></div>
                   2740: </div>
1.41      asau     2741: <div class="sect1">
1.1       dsieger  2742: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.84      wiz      2743: <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.1       dsieger  2744: <p>You have modified a file from pkgsrc, and someone else has
                   2745: modified that same file afterwards in the CVS repository. Both changes
                   2746: are in the same region of the file, so when you updated pkgsrc, the
                   2747: <code class="literal">cvs</code> command marked the conflicting changes in the
                   2748: file. Because of these markers, the file is no longer a valid
                   2749: <code class="filename">Makefile</code>.</p>
                   2750: <p>Have a look at that file, and if you don't need your local changes
1.10      hubertf  2751: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  2752: -dP</strong></span> in that directory to download the current version.</p>
                   2753: </div>
                   2754: </div>
                   2755: </div>
1.41      asau     2756: <div class="part">
1.1       dsieger  2757: <div class="titlepage"><div><div><h1 class="title">
                   2758: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41      asau     2759: <div class="partintro">
1.1       dsieger  2760: <div></div>
                   2761: <p>This part of the book deals with creating and
1.23      wiz      2762:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.1       dsieger  2763:        guide on creating a new package. The remaining chapters are more
                   2764:        like a reference manual for pkgsrc.</p>
                   2765: <div class="toc">
                   2766: <p><b>Table of Contents</b></p>
1.100     leot     2767: <dl class="toc">
1.6       rillig   2768: <dt><span class="chapter"><a href="#creating">10. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger  2769: <dd><dl>
1.6       rillig   2770: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  2771: <dd><dl>
1.6       rillig   2772: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.121     sevan    2773: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 &amp; KDE4 applications</a></span></dt>
1.17      imil     2774: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  2775: </dl></dd>
1.6       rillig   2776: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   2777: <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>
                   2778: </dl></dd>
                   2779: <dt><span class="chapter"><a href="#components">11. Package components - files, directories and contents</a></span></dt>
                   2780: <dd><dl>
1.23      wiz      2781: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   2782: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108     rillig   2783: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6       rillig   2784: <dd><dl>
                   2785: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   2786: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   2787: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   2788: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   2789: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   2790: </dl></dd>
                   2791: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   2792: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   2793: <dd><dl>
                   2794: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   2795: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   2796: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
                   2797: </dl></dd>
1.23      wiz      2798: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   2799: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig   2800: </dl></dd>
1.23      wiz      2801: <dt><span class="chapter"><a href="#makefile">12. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig   2802: <dd><dl>
                   2803: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      2804: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   2805: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   2806: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   2807: <dd><dl>
                   2808: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.117     sevan    2809: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.108     rillig   2810: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   2811: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.6       rillig   2812: </dl></dd>
                   2813: </dl></dd>
                   2814: <dt><span class="chapter"><a href="#plist">13. PLIST issues</a></span></dt>
                   2815: <dd><dl>
                   2816: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      2817: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   2818: <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.6       rillig   2819: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   2820: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      2821: <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.6       rillig   2822: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86      wiz      2823: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   2824: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.6       rillig   2825: </dl></dd>
                   2826: <dt><span class="chapter"><a href="#buildlink">14. Buildlink methodology</a></span></dt>
                   2827: <dd><dl>
                   2828: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      2829: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   2830: <dd><dl>
                   2831: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      2832: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   2833:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2834:       and
                   2835:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2836:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   2837: </dl></dd>
1.23      wiz      2838: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6       rillig   2839: <dd><dl>
1.23      wiz      2840: <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.6       rillig   2841: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   2842: </dl></dd>
                   2843: </dl></dd>
                   2844: <dt><span class="chapter"><a href="#pkginstall">15. The pkginstall framework</a></span></dt>
                   2845: <dd><dl>
                   2846: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
                   2847: <dd><dl>
                   2848: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   2849: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
                   2850: </dl></dd>
                   2851: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
                   2852: <dd><dl>
1.23      wiz      2853: <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.6       rillig   2854: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   2855: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   2856: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   2857: </dl></dd>
                   2858: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   2859: <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>
                   2860: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   2861: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   2862: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   2863: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   2864: <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>
                   2865: </dl></dd>
                   2866: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
                   2867: <dd><dl>
                   2868: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      2869: <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.6       rillig   2870: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   2871: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig   2872: </dl></dd>
                   2873: <dt><span class="chapter"><a href="#build">17. The build process</a></span></dt>
                   2874: <dd><dl>
                   2875: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   2876: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   2877: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   2878: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      2879: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig   2880: <dd><dl>
                   2881: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   2882: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   2883: </dl></dd>
1.23      wiz      2884: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   2885: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   2886: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   2887: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   2888: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   2889: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2890: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2891: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   2892: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2893: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6       rillig   2894: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   2895: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
                   2896: </dl></dd>
                   2897: <dt><span class="chapter"><a href="#tools">18. Tools needed for building or running</a></span></dt>
                   2898: <dd><dl>
                   2899: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   2900: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   2901: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
                   2902: </dl></dd>
                   2903: <dt><span class="chapter"><a href="#fixes">19. Making your package work</a></span></dt>
                   2904: <dd><dl>
                   2905: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
                   2906: <dd><dl>
1.108     rillig   2907: <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>
                   2908: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   2909: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   2910: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   2911: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   2912: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   2913: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   2914: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   2915: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   2916: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   2917: <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.6       rillig   2918: </dl></dd>
1.108     rillig   2919: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig   2920: <dd><dl>
                   2921: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   2922: <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.88      tnn      2923: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6       rillig   2924: </dl></dd>
1.108     rillig   2925: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6       rillig   2926: <dd><dl>
                   2927: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   2928: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   2929: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   2930: </dl></dd>
                   2931: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   2932: <dd><dl>
                   2933: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   2934: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   2935: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40      wiz      2936: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   2937: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6       rillig   2938: </dl></dd>
1.108     rillig   2939: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6       rillig   2940: <dd><dl>
                   2941: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   2942: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      2943: <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.6       rillig   2944: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   2945: </dl></dd>
1.108     rillig   2946: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6       rillig   2947: <dd><dl>
                   2948: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   2949: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   2950: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   2951: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   2952: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   2953: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   2954: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   2955: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   2956: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      2957: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   2958: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   2959: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   2960: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   2961: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   2962: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   2963: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   2964: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   2965: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  2966:     emulation</a></span></dt>
1.6       rillig   2967: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   2968: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  2969: </dl></dd>
1.6       rillig   2970: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  2971: </dl></dd>
1.6       rillig   2972: <dt><span class="chapter"><a href="#debug">20. Debugging</a></span></dt>
                   2973: <dt><span class="chapter"><a href="#submit">21. Submitting and Committing</a></span></dt>
1.1       dsieger  2974: <dd><dl>
1.6       rillig   2975: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   2976: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   2977: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.130     wiz      2978: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
                   2979: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
                   2980: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
                   2981: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
                   2982: <dt><span class="sect1"><a href="#moving-package">21.8. Moving a package in pkgsrc</a></span></dt>
1.6       rillig   2983: </dl></dd>
                   2984: <dt><span class="chapter"><a href="#devfaq">22. Frequently Asked Questions</a></span></dt>
                   2985: <dt><span class="chapter"><a href="#gnome">23. GNOME packaging and porting</a></span></dt>
                   2986: <dd><dl>
                   2987: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   2988: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   2989: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   2990: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  2991: </dl></dd>
                   2992: </dl>
                   2993: </div>
                   2994: </div>
1.41      asau     2995: <div class="chapter">
1.1       dsieger  2996: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   2997: <a name="creating"></a>Chapter 10. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1       dsieger  2998: <div class="toc">
                   2999: <p><b>Table of Contents</b></p>
1.100     leot     3000: <dl class="toc">
1.6       rillig   3001: <dt><span class="sect1"><a href="#creating.common">10.1. Common types of packages</a></span></dt>
1.1       dsieger  3002: <dd><dl>
1.6       rillig   3003: <dt><span class="sect2"><a href="#creating.perl-module">10.1.1. Perl modules</a></span></dt>
1.121     sevan    3004: <dt><span class="sect2"><a href="#creating.kde-app">10.1.2. KDE3 &amp; KDE4 applications</a></span></dt>
1.17      imil     3005: <dt><span class="sect2"><a href="#creating.python-module">10.1.3. Python modules and programs</a></span></dt>
1.1       dsieger  3006: </dl></dd>
1.6       rillig   3007: <dt><span class="sect1"><a href="#creating.examples">10.2. Examples</a></span></dt>
                   3008: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">10.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.1       dsieger  3009: </dl>
                   3010: </div>
                   3011: <p>When you find a package that is not yet in pkgsrc, you
                   3012: most likely have a URL from where you can download the source
                   3013: code. Starting with this URL, creating a package involves only a
                   3014: few steps.</p>
1.23      wiz      3015: <div class="procedure"><ol class="procedure" type="1">
1.120     sevan    3016: <li class="step"><p>First, install the packages <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.41      asau     3017: <li class="step"><p>Then, choose one of the top-level directories as the
1.1       dsieger  3018: category in which you want to place your package. You can also create a
                   3019: directory of your own (maybe called <code class="filename">local</code>). In that
                   3020: category directory, create another directory for your package and change
                   3021: into it.</p></li>
1.41      asau     3022: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1       dsieger  3023: you for a URL. Enter the URL of the distribution file (in most cases a
                   3024: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3025: of your package are created automatically. The distribution file is
                   3026: extracted automatically to fill in some details in the
                   3027: <code class="filename">Makefile</code> that would otherwise have to be done
                   3028: manually.</p></li>
1.41      asau     3029: <li class="step">
1.1       dsieger  3030: <p>Examine the extracted files to determine the dependencies of
                   3031: your package. Ideally, this is mentioned in some
                   3032: <code class="filename">README</code> file, but things may differ. For each of
                   3033: these dependencies, look where it exists in pkgsrc, and if there is a
                   3034: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3035: line to your package <code class="filename">Makefile</code> which includes that
                   3036: file just before the last line. If the
1.25      spz      3037: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3038: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3039: <p>If you just need binaries from a package, add a
1.1       dsieger  3040: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3041: version of the dependency and where it can be found in pkgsrc. This line
                   3042: should be placed in the third paragraph. If the dependency is only
                   3043: needed for building the package, but not when using it, use
                   3044: <code class="varname">BUILD_DEPENDS</code> instead of <code class="varname">DEPENDS</code>.
                   3045: Your package may then look like this:</p>
                   3046: <pre class="programlisting">
                   3047: [...]
                   3048: 
1.66      asau     3049: BUILD_DEPENDS+= libxslt-[0-9]*:../../textproc/libxslt
1.1       dsieger  3050: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3051: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3052: 
                   3053: [...]
                   3054: 
                   3055: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3056: .include "../../devel/glib2/buildlink3.mk"
                   3057: .include "../../mk/bsd.pkg.mk"
                   3058: </pre>
                   3059: </li>
1.41      asau     3060: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23      wiz      3061: 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.10      hubertf  3062: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3063: --explain</strong></span> or <span class="command"><strong>pkglint
1.1       dsieger  3064: -e</strong></span>, which outputs additional
                   3065: explanations.</p></li>
1.41      asau     3066: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.10      hubertf  3067: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="10.1. Common types of packages">Section 10.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.1       dsieger  3068: over there, you can hopefully continue here.</p></li>
1.41      asau     3069: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1       dsieger  3070: directory from the extracted files. Besides these files, a lot of cache
                   3071: files and other system information has been saved in the working
                   3072: directory, which may become wrong after you edited the
                   3073: <code class="filename">Makefile</code>.</p></li>
1.41      asau     3074: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.10      hubertf  3075: 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.41      asau     3076: <li class="step"><p>When the package builds fine, the next step is to install
1.10      hubertf  3077: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1       dsieger  3078: everything works.</p></li>
1.41      asau     3079: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1       dsieger  3080: contains a list of the files that are installed by the package, is
1.10      hubertf  3081: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1       dsieger  3082: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3083: the file using your preferred text editor to see if the list of
                   3084: files looks plausible.</p></li>
1.41      asau     3085: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1       dsieger  3086: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41      asau     3087: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1       dsieger  3088: has been registered in the database of installed files, but with an
1.10      hubertf  3089: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3090: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1       dsieger  3091: registered with the list of files from
                   3092: <code class="filename">PLIST</code>.</p></li>
1.41      asau     3093: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1       dsieger  3094: package from the set of installed files.</p></li>
                   3095: </ol></div>
1.41      asau     3096: <div class="sect1">
1.1       dsieger  3097: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3098: <a name="creating.common"></a>10.1. Common types of packages</h2></div></div></div>
1.41      asau     3099: <div class="sect2">
1.1       dsieger  3100: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3101: <a name="creating.perl-module"></a>10.1.1. Perl modules</h3></div></div></div>
1.1       dsieger  3102: <p>Simple Perl modules are handled automatically by
1.10      hubertf  3103: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1       dsieger  3104: </div>
1.41      asau     3105: <div class="sect2">
1.1       dsieger  3106: <div class="titlepage"><div><div><h3 class="title">
1.121     sevan    3107: <a name="creating.kde-app"></a>10.1.2. KDE3 &amp; KDE4 applications</h3></div></div></div>
1.66      asau     3108: <p>KDE3 applications should always include
1.1       dsieger  3109: <code class="filename">meta-pkgs/kde3/kde3.mk</code>, which contains numerous
1.121     sevan    3110: settings that are typical of KDE3 packages and KDE4 applications should
                   3111: always include <code class="filename">meta-pkgs/kde4/kde4.mk</code>, respectively.</p>
1.1       dsieger  3112: </div>
1.41      asau     3113: <div class="sect2">
1.17      imil     3114: <div class="titlepage"><div><div><h3 class="title">
                   3115: <a name="creating.python-module"></a>10.1.3. Python modules and programs</h3></div></div></div>
                   3116: <p>Python modules and programs packages are easily created using a
                   3117: set of predefined variables.</p>
                   3118: <p>
1.63      wiz      3119: If some Python versions are not supported by the software, set the
                   3120: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3121: that are not supported, e.g.
1.17      imil     3122: </p>
                   3123: <pre class="programlisting">
1.93      sevan    3124: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.17      imil     3125: </pre>
                   3126: <p>
1.103     wiz      3127: If the packaged software is a Python module, include one of
                   3128: <code class="filename">../../lang/python/egg.mk</code>,
                   3129: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3130: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3131: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3132: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3133: if the packaged software is using setuptools, you only need
                   3134: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3135: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   3136: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   3137: so pkgsrc will use this framework.
                   3138: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3139: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3140: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3141: to the name of the script.</p>
                   3142: <p>Either way, the package directory should be called
1.23      wiz      3143: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3144: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.17      imil     3145: </p>
                   3146: <pre class="programlisting">
                   3147: DISTNAME=   foopymodule-1.2.10
                   3148: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3149: </pre>
1.63      wiz      3150: <p>If it is an application, include
                   3151: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3152: In order to correctly set the path to the Python interpreter, use the
1.17      imil     3153: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35      wiz      3154: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63      wiz      3155: For example:
1.17      imil     3156: </p>
                   3157: <pre class="programlisting">
1.35      wiz      3158: REPLACE_PYTHON=   *.py
1.17      imil     3159: </pre>
1.63      wiz      3160: <p>Some Python modules have separate distributions for Python-2.x
                   3161: and Python-3.x support. In pkgsrc this is handled by the
                   3162: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3163: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3164: packages that should be depended upon and include
                   3165: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3166: then the pkgsrc infrastructure will depend on the appropriate package
                   3167: version. For example:
                   3168: </p>
                   3169: <pre class="programlisting">
1.123     wiz      3170: PYTHON_VERSIONED_DEPENDENCIES=gobject
1.63      wiz      3171: </pre>
                   3172: <p>
                   3173: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3174: of supported packages.</p>
1.17      imil     3175: </div>
1.1       dsieger  3176: </div>
1.41      asau     3177: <div class="sect1">
1.1       dsieger  3178: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3179: <a name="creating.examples"></a>10.2. Examples</h2></div></div></div>
1.41      asau     3180: <div class="sect2">
1.1       dsieger  3181: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3182: <a name="creating.nvu"></a>10.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41      asau     3183: <div class="sect3">
1.1       dsieger  3184: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   3185: <a name="creating.nvu.init"></a>10.2.1.1. The initial package</h4></div></div></div>
1.1       dsieger  3186: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23      wiz      3187: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.1       dsieger  3188: pkgsrc. As the description says it has to do with the web, the obvious
1.23      wiz      3189: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.1       dsieger  3190: <pre class="programlisting">
                   3191: <code class="prompt">$</code> mkdir www/nvu
                   3192: <code class="prompt">$</code> cd www/nvu
                   3193: </pre>
                   3194: <p>The web site says that the sources are available as a tar file, so
1.10      hubertf  3195: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1       dsieger  3196: <pre class="programlisting">
                   3197: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3198: </pre>
                   3199: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3200: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23      wiz      3201: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
1.1       dsieger  3202: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3203: <code class="varname">COMMENT</code> fields. Then the package
                   3204: <code class="filename">Makefile</code> looked like that:</p>
                   3205: <pre class="programlisting">
1.121     sevan    3206: # $NetBSD $
1.1       dsieger  3207: #
                   3208: 
                   3209: DISTNAME=       nvu-1.0-sources
                   3210: PKGNAME=        nvu-1.0
                   3211: CATEGORIES=     www
                   3212: MASTER_SITES=   http://cvs.nvu.com/download/
                   3213: EXTRACT_SUFX=   .tar.bz2
                   3214: 
                   3215: MAINTAINER=     rillig@NetBSD.org
                   3216: HOMEPAGE=       http://cvs.nvu.com/
                   3217: COMMENT=        Web Authoring System
                   3218: 
                   3219: # url2pkg-marker (please do not remove this line.)
                   3220: .include "../../mk/bsd.pkg.mk"
                   3221: </pre>
1.124     wiz      3222: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.121     sevan    3223: this is a workaround to prevent CVS expanding to the filename of the
                   3224: guide.</p>
1.1       dsieger  3225: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3226: source archive:</p>
                   3227: <pre class="programlisting">
                   3228: url2pkg&gt; Running "make makesum" ...
                   3229: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3230: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3231: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3232: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3233: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3234: url2pkg&gt; Running "make extract" ...
                   3235: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3236: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3237: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3238: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3239: ===&gt; Installing dependencies for nvu-1.0
                   3240: ===&gt; Overriding tools for nvu-1.0
                   3241: ===&gt; Extracting for nvu-1.0
                   3242: url2pkg&gt; Adjusting the Makefile.
                   3243: 
                   3244: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   3245: 
                   3246: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   3247: </pre>
                   3248: </div>
1.41      asau     3249: <div class="sect3">
1.1       dsieger  3250: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   3251: <a name="creating.nvu.problems"></a>10.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.1       dsieger  3252: <p>Now that the package has been extracted, let's see what's inside
                   3253: it. The package has a <code class="filename">README.txt</code>, but that only
                   3254: says something about mozilla, so it's probably useless for seeing what
                   3255: dependencies this package has. But since there is a GNU configure script
                   3256: in the package, let's hope that it will complain about everything it
                   3257: needs.</p>
                   3258: <pre class="programlisting">
                   3259: <code class="prompt">$</code> bmake
                   3260: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3261: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3262: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3263: ===&gt; Patching for nvu-1.0
                   3264: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3265: ===&gt; Configuring for nvu-1.0
                   3266: [...]
                   3267: configure: error: Perl 5.004 or higher is required.
                   3268: [...]
                   3269: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3270: [...]
                   3271: </pre>
                   3272: <p>That worked quite well. So I opened the package Makefile in my
                   3273: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23      wiz      3274: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.1       dsieger  3275: package have changed now, and since a perl wrapper is automatically
1.23      wiz      3276: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.1       dsieger  3277: from scratch.</p>
                   3278: <pre class="programlisting">
                   3279: <code class="prompt">$</code> bmake clean
                   3280: ===&gt; Cleaning for nvu-1.0
                   3281: <code class="prompt">$</code> bmake
                   3282: [...]
                   3283: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3284: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3285: [...]
                   3286: </pre>
1.23      wiz      3287: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.1       dsieger  3288: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   3289: <pre class="programlisting">
                   3290: [...]
                   3291: checking for GTK - version &gt;= 1.2.0... no
                   3292: *** Could not run GTK test program, checking why...
                   3293: [...]
                   3294: </pre>
                   3295: <p>Now to the other dependencies. The first question is: Where is the
                   3296: GTK package hidden in pkgsrc?</p>
                   3297: <pre class="programlisting">
                   3298: <code class="prompt">$</code> echo ../../*/gtk*
                   3299: [many packages ...]
                   3300: <code class="prompt">$</code> echo ../../*/gtk
                   3301: ../../x11/gtk
                   3302: <code class="prompt">$</code> echo ../../*/gtk2
                   3303: ../../x11/gtk2
                   3304: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   3305: ../../x11/gtk2/buildlink3.mk
                   3306: </pre>
                   3307: <p>The first try was definitely too broad. The second one had exactly
                   3308: one result, which is very good. But there is one pitfall with GNOME
                   3309: packages. Before GNOME 2 had been released, there were already many
                   3310: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   3311: packages, the GNOME 2 packages were imported as separate packages, and
1.23      wiz      3312: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.1       dsieger  3313: whether this was the case here, and indeed it was.</p>
                   3314: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   3315: file, adding the dependency is very easy. I just inserted an
                   3316: <code class="literal">.include</code> line before the last line of the package
                   3317: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   3318: <pre class="programlisting">
                   3319: [...]
                   3320: .include "../../x11/gtk2/buildlink3.mk"
                   3321: .include "../../mk/bsd.pkg.mk
                   3322: </pre>
1.10      hubertf  3323: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.1       dsieger  3324: was:</p>
                   3325: <pre class="programlisting">
                   3326: [...]
                   3327: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3328: checking for GTK - version &gt;= 1.2.0... no
                   3329: *** Could not run GTK test program, checking why...
                   3330: *** The test program failed to compile or link. See the file config.log for the
                   3331: *** exact error that occured. This usually means GTK was incorrectly installed
                   3332: *** or that you have moved GTK since it was installed. In the latter case, you
                   3333: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3334: configure: error: Test for GTK failed.
                   3335: [...]
                   3336: </pre>
1.23      wiz      3337: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   3338: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.1       dsieger  3339: told me that this package really wanted to have the GNOME 1 version of
                   3340: GTK. If the package had looked for GTK2, it would have looked for
1.10      hubertf  3341: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1       dsieger  3342: So I changed the <code class="literal">x11/gtk2</code> to
                   3343: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   3344: and tried again.</p>
                   3345: <pre class="programlisting">
                   3346: [...]
1.59      jnemeth  3347: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.1       dsieger  3348: In file included from xpidl.c:42:
                   3349: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3350: In file included from xpidl.c:42:
                   3351: xpidl.h:132: error: parse error before "IDL_ns"
                   3352: [...]
                   3353: </pre>
                   3354: <p>The package still does not find all of its dependencies. Now the
                   3355: question is: Which package provides the
                   3356: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   3357: <pre class="programlisting">
                   3358: <code class="prompt">$</code> echo ../../*/*idl*
                   3359: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3360: <code class="prompt">$</code> echo ../../*/*IDL*
                   3361: ../../net/libIDL
                   3362: </pre>
                   3363: <p>Let's take the one from the second try. So I included the
                   3364: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   3365: again. But the error didn't change. After digging through some of the
                   3366: code, I concluded that the build process of the package was broken and
                   3367: couldn't have ever worked, but since the Mozilla source tree is quite
                   3368: large, I didn't want to fix it. So I added the following to the package
                   3369: <code class="filename">Makefile</code> and tried again:</p>
                   3370: <pre class="programlisting">
                   3371: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   3372: BUILDLINK_TRANSFORM+=   -l:IDL:IDL-2
                   3373: </pre>
                   3374: <p>The latter line is needed because the package expects the library
                   3375: <code class="filename">libIDL.so</code>, but only
                   3376: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   3377: wrapper to rewrite that on the fly.</p>
                   3378: <p>The next problem was related to a recent change of the FreeType
1.120     sevan    3379: interface. I looked up in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
1.1       dsieger  3380: which patch files were relevant for this issue and copied them to the
                   3381: <code class="filename">patches</code> directory. Then I retried, fixed the
                   3382: patches so that they applied cleanly and retried again. This time,
                   3383: everything worked.</p>
                   3384: </div>
1.41      asau     3385: <div class="sect3">
1.1       dsieger  3386: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   3387: <a name="creating.nvu.inst"></a>10.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  3388: <pre class="programlisting">
                   3389: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   3390: [...]
                   3391: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   3392: <code class="prompt">$</code> bmake deinstall
                   3393: <code class="prompt">$</code> bmake install
                   3394: </pre>
                   3395: </div>
                   3396: </div>
                   3397: </div>
                   3398: </div>
1.41      asau     3399: <div class="chapter">
1.1       dsieger  3400: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   3401: <a name="components"></a>Chapter 11. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  3402: <div class="toc">
                   3403: <p><b>Table of Contents</b></p>
1.100     leot     3404: <dl class="toc">
1.23      wiz      3405: <dt><span class="sect1"><a href="#components.Makefile">11.1. <code class="filename">Makefile</code></a></span></dt>
                   3406: <dt><span class="sect1"><a href="#components.distinfo">11.2. <code class="filename">distinfo</code></a></span></dt>
1.108     rillig   3407: <dt><span class="sect1"><a href="#components.patches">11.3. <code class="filename">patches/*</code></a></span></dt>
1.6       rillig   3408: <dd><dl>
                   3409: <dt><span class="sect2"><a href="#components.patch.structure">11.3.1. Structure of a single patch file</a></span></dt>
                   3410: <dt><span class="sect2"><a href="#components.patches.caveats">11.3.2. Creating patch files</a></span></dt>
                   3411: <dt><span class="sect2"><a href="#components.patches.sources">11.3.3. Sources where the patch files come from</a></span></dt>
                   3412: <dt><span class="sect2"><a href="#components.patches.guidelines">11.3.4. Patching guidelines</a></span></dt>
                   3413: <dt><span class="sect2"><a href="#components.patches.feedback">11.3.5. Feedback to the author</a></span></dt>
                   3414: </dl></dd>
                   3415: <dt><span class="sect1"><a href="#other-mandatory-files">11.4. Other mandatory files</a></span></dt>
                   3416: <dt><span class="sect1"><a href="#components.optional">11.5. Optional files</a></span></dt>
                   3417: <dd><dl>
                   3418: <dt><span class="sect2"><a href="#components.optional.bin">11.5.1. Files affecting the binary package</a></span></dt>
                   3419: <dt><span class="sect2"><a href="#components.optional.build">11.5.2. Files affecting the build process</a></span></dt>
                   3420: <dt><span class="sect2"><a href="#components.optional.none">11.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  3421: </dl></dd>
1.23      wiz      3422: <dt><span class="sect1"><a href="#work-dir">11.6. <code class="filename">work*</code></a></span></dt>
                   3423: <dt><span class="sect1"><a href="#files-dir">11.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  3424: </dl>
                   3425: </div>
                   3426: <p>Whenever you're preparing a package, there are a number of
                   3427: files involved which are described in the following
                   3428: sections.</p>
1.41      asau     3429: <div class="sect1">
1.1       dsieger  3430: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3431: <a name="components.Makefile"></a>11.1. <code class="filename">Makefile</code>
1.1       dsieger  3432: </h2></div></div></div>
                   3433: <p>Building, installation and creation of a binary package are all
                   3434:   controlled by the package's <code class="filename">Makefile</code>.
                   3435:   The <code class="filename">Makefile</code> describes various things about
                   3436:   a package, for example from where to get it, how to configure,
                   3437:   build, and install it.</p>
                   3438: <p>A package <code class="filename">Makefile</code> contains several
                   3439:   sections that describe the package.</p>
                   3440: <p>In the first section there are the following variables, which
                   3441:   should appear exactly in the order given here.  The order and
                   3442:   grouping of the variables is mostly historical and has no further
                   3443:   meaning.</p>
1.41      asau     3444: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3445: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1       dsieger  3446:     distribution file to be downloaded from the package's
                   3447:     website.</p></li>
1.23      wiz      3448: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66      asau     3449:     package, as used by pkgsrc. You need to provide it if
1.1       dsieger  3450:     <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66      asau     3451:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3452:     provided (no distribution file is required).  Usually it is the pkgsrc
1.1       dsieger  3453:     directory name together with the version number. It must match the
                   3454:     regular expression
                   3455:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3456:     starts with a letter or digit, and contains only letters, digits,
                   3457:     dashes, underscores, dots and plus signs.</p></li>
1.23      wiz      3458: <li class="listitem">
1.1       dsieger  3459: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3460:     which the package fits in. You can choose any of the top-level
                   3461:     directories of pkgsrc for it.</p>
                   3462: <p>Currently the following values are available for
                   3463:     <code class="varname">CATEGORIES</code>. If more than
                   3464:     one is used, they need to be separated by spaces:</p>
                   3465: <pre class="programlisting">
                   3466: archivers     cross         geography     meta-pkgs     security
                   3467: audio         databases     graphics      misc          shells
                   3468: benchmarks    devel         ham           multimedia    sysutils
                   3469: biology       editors       inputmethod   net           textproc
                   3470: cad           emulators     lang          news          time
                   3471: chat          finance       mail          parallel      wm
                   3472: comms         fonts         math          pkgtools      www
                   3473: converters    games         mbone         print         x11
                   3474: </pre>
                   3475: </li>
1.23      wiz      3476: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1       dsieger  3477:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3478:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3479:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.23      wiz      3480:     <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.1       dsieger  3481: </ul></div>
                   3482: <p>The second section contains information about separately
                   3483:   downloaded patches, if any.
                   3484:   </p>
1.41      asau     3485: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80      wiz      3486: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1       dsieger  3487:     Name(s) of additional files that contain distribution patches.
                   3488:     There is no default. pkgsrc will look for them at
                   3489:     <code class="varname">PATCH_SITES</code>.
                   3490:     They will automatically be uncompressed before patching if
                   3491:     the names end with <code class="filename">.gz</code> or
                   3492:     <code class="filename">.Z</code>.</p></li>
1.23      wiz      3493: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1       dsieger  3494:     Primary location(s) for distribution patch files (see
1.80      wiz      3495:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3496: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.125     leot     3497:     an argument to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.80      wiz      3498:     help find the correct files to patch. It defaults to
                   3499:     <span class="command"><strong>-p0</strong></span>.</p></li>
1.1       dsieger  3500: </ul></div>
                   3501: <p>The third section contains the following variables.
                   3502:   </p>
1.41      asau     3503: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3504: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14      jmcneill 3505:     address of the person who feels responsible for this package,
                   3506:     and who is most likely to look at problems or questions regarding
1.125     leot     3507:     this package which have been reported with <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14      jmcneill 3508:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3509:     before making changes to the package, but are not required to
                   3510:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3511:     to yourself. If you really can't maintain the package for future
                   3512:     updates, set it to
1.10      hubertf  3513:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.23      wiz      3514: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14      jmcneill 3515:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3516:     developers to update or change the package without contacting
                   3517:     you first. A package Makefile should contain one of
                   3518:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3519:     not both.  </p></li>
1.23      wiz      3520: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1       dsieger  3521:     find more information about the package.</p></li>
1.23      wiz      3522: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1       dsieger  3523:     description of the package (should not include the package
                   3524:     name).</p></li>
1.122     leot     3525: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3526:     applicable for the package. See <a class="xref" href="#handling-licenses" title="19.1.3. Handling licenses">Section 19.1.3, &#8220;Handling licenses&#8221;</a> for further details.</p></li>
1.1       dsieger  3527: </ul></div>
                   3528: <p>Other variables that affect the build:
                   3529:   </p>
1.41      asau     3530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1       dsieger  3531: <p><code class="varname">WRKSRC</code>: The directory where the
                   3532:       interesting distribution files of the package are found. The
                   3533:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3534:       works for most packages.</p>
                   3535: <p>If a package doesn't create a subdirectory for itself
                   3536:       (most GNU software does, for instance), but extracts itself in
                   3537:       the current directory, you should set
                   3538:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3539: <p>If a package doesn't create a subdirectory with the
                   3540:       name of <code class="varname">DISTNAME</code> but some different name,
                   3541:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3542:       <code class="filename">${WRKDIR}</code>, for example
                   3543:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.120     sevan    3544:       <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
1.1       dsieger  3545: <p>The name of the working directory created by pkgsrc is
                   3546:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3547:       variable. By default, its value is
                   3548:       <code class="filename">work</code>. If you want to use the same
                   3549:       pkgsrc tree for building different kinds of binary packages,
                   3550:       you can change the variable according to your needs. Two
                   3551:       other variables handle common cases of setting
                   3552:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3553:       <code class="varname">OBJHOSTNAME</code> is defined in
1.10      hubertf  3554:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1       dsieger  3555:       the host's name is attached to the directory name. If
                   3556:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3557:       is attached, which might look like
                   3558:       <code class="filename">work.i386</code> or
                   3559:       <code class="filename">work.sparc</code>.</p>
                   3560: </li></ul></div>
                   3561: <p>Please pay attention to the following gotchas:</p>
1.41      asau     3562: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3563: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1       dsieger  3564:       installed in compressed form by the package.  For packages using
                   3565:       BSD-style makefiles which honor MANZ, there is
                   3566:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23      wiz      3567: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3568:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.1       dsieger  3569:       below).</p></li>
1.23      wiz      3570: <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.1       dsieger  3571: </ul></div>
                   3572: </div>
1.41      asau     3573: <div class="sect1">
1.1       dsieger  3574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3575: <a name="components.distinfo"></a>11.2. <code class="filename">distinfo</code>
1.1       dsieger  3576: </h2></div></div></div>
                   3577: <p>The <code class="filename">distinfo</code> file contains the message
                   3578:   digest, or checksum, of each distfile needed for the package. This
                   3579:   ensures that the distfiles retrieved from the Internet have not been
                   3580:   corrupted during transfer or altered by a malign force to introduce
1.108     rillig   3581:   a security hole. To provide maximum security, all distfiles are
                   3582:   protected using three different message digest algorithms (SHA1,
                   3583:   RMD160, SHA512), as well as the file size.</p>
1.1       dsieger  3584: <p>The <code class="filename">distinfo</code> file also contains the
                   3585:   checksums for all the patches found in the
1.108     rillig   3586:   <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.1       dsieger  3587: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108     rillig   3588:   <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1       dsieger  3589: <p>Some packages have different sets of distfiles depending on
1.120     sevan    3590:   the platform, for example <a href="http://cdn.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.1       dsieger  3591:   <code class="filename">distinfo</code> file and care should be taken when
                   3592:   upgrading such a package to ensure distfile information is not
                   3593:   lost.</p>
                   3594: </div>
1.41      asau     3595: <div class="sect1">
1.1       dsieger  3596: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   3597: <a name="components.patches"></a>11.3. <code class="filename">patches/*</code>
                   3598: </h2></div></div></div>
                   3599: <p>Some packages don't work out-of-the box on the various
                   3600:   platforms that are supported by pkgsrc. These packages need
                   3601:   to be patched to make them work. The patch files can be
1.1       dsieger  3602:   found in the <code class="filename">patches/</code> directory.</p>
                   3603: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3604:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.108     rillig   3605:   extracting them, in alphabetic order.</p>
1.41      asau     3606: <div class="sect2">
1.1       dsieger  3607: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3608: <a name="components.patch.structure"></a>11.3.1. Structure of a single patch file</h3></div></div></div>
1.1       dsieger  3609: <p>The <code class="filename">patch-*</code> files should be in
1.10      hubertf  3610:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1       dsieger  3611:   problems. (To force patches to apply with fuzz you can set
                   3612:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3613:   should contain only changes for a single file, and no file should be
                   3614:   patched by more than one patch file. This helps to keep future
                   3615:   modifications simple.</p>
                   3616: <p>Each patch file is structured as follows: In the first line,
                   3617:   there is the RCS Id of the patch itself. The second line should be
                   3618:   empty for aesthetic reasons. After that, there should be a comment for
                   3619:   each change that the patch does. There are a number of standard
                   3620:   cases:</p>
1.41      asau     3621: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3622: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1       dsieger  3623:   mention the vulnerability ID (CAN, CVE).</p></li>
1.23      wiz      3624: <li class="listitem"><p>Patches that change source code should mention the
1.1       dsieger  3625:   platform and other environment (for example, the compiler) that the
                   3626:   patch is needed for.</p></li>
                   3627: </ul></div>
1.108     rillig   3628: <p>The patch should be commented so that any
1.1       dsieger  3629:   developer who knows the code of the application can make some use of
                   3630:   the patch. Special care should be taken for the upstream developers,
                   3631:   since we generally want that they accept our patches, so we have less
                   3632:   work in the future.</p>
                   3633: </div>
1.41      asau     3634: <div class="sect2">
1.1       dsieger  3635: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3636: <a name="components.patches.caveats"></a>11.3.2. Creating patch files</h3></div></div></div>
1.1       dsieger  3637: <p>One important thing to mention is to pay attention that no RCS
                   3638:   IDs get stored in the patch files, as these will cause problems when
                   3639:   later checked into the NetBSD CVS tree. Use the
1.120     sevan    3640:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
1.1       dsieger  3641:   problems.</p>
                   3642: <p>For even more automation, we recommend using
1.10      hubertf  3643:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1       dsieger  3644:   whole set of patches. You just have to backup files before you
                   3645:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.10      hubertf  3646:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3647:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1       dsieger  3648:   you upgrade a package this way, you can easily compare the new
                   3649:   set of patches with the previously existing one with
1.24      wiz      3650:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3651:   are replaced by new files, so carefully check if you want to take all
                   3652:   the changes.</p>
1.1       dsieger  3653: <p>When you have finished a package, remember to generate
1.10      hubertf  3654:   the checksums for the patch files by using the <span class="command"><strong>make
1.23      wiz      3655:   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.1       dsieger  3656: <p>When adding a patch that corrects a problem in the
                   3657:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3658:   man pages should go), send the patch as a bug report to the
                   3659:   maintainer.  This benefits non-pkgsrc users of the package,
                   3660:   and usually makes it possible to remove the patch in future
                   3661:   version.</p>
1.2       rillig   3662: <p>The file names of the patch files are usually of the form
1.24      wiz      3663:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3664:   Many packages still use the previous convention
                   3665:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3666:   but new patches should be of the form containing the filename.
1.120     sevan    3667:   <span class="command"><strong>mkpatches</strong></span> included in <a href="http://cdn.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.24      wiz      3668:   automatically.</p>
1.1       dsieger  3669: </div>
1.41      asau     3670: <div class="sect2">
1.1       dsieger  3671: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3672: <a name="components.patches.sources"></a>11.3.3. Sources where the patch files come from</h3></div></div></div>
1.1       dsieger  3673: <p>If you want to share patches between multiple packages
                   3674:   in pkgsrc, e.g. because they use the same distfiles, set
                   3675:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3676:   can be found, e.g.:</p>
                   3677: <pre class="programlisting">
                   3678: PATCHDIR= ${.CURDIR}/../xemacs/patches
                   3679: </pre>
                   3680: <p>Patch files that are distributed by the author or other
                   3681:     maintainers can be listed in
                   3682:     <code class="varname">PATCHFILES</code>.</p>
                   3683: <p>If it is desired to store any patches that should not be
                   3684:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3685:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3686:     directory tree there is expected to have the same
1.23      wiz      3687:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.1       dsieger  3688:     patches are expected to be stored inside these dirs (also
                   3689:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3690:     example, if you want to keep a private patch for
                   3691:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3692:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3693:     files in the named directory are expected to be patch files,
                   3694:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3695:     applied</em></span>.</p>
                   3696: </div>
1.41      asau     3697: <div class="sect2">
1.1       dsieger  3698: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3699: <a name="components.patches.guidelines"></a>11.3.4. Patching guidelines</h3></div></div></div>
1.1       dsieger  3700: <p>When fixing a portability issue in the code do not use
                   3701:       preprocessor magic to check for the current operating system nor
                   3702:       platform.  Doing so hurts portability to other platforms because
                   3703:       the OS-specific details are not abstracted appropriately.</p>
                   3704: <p>The general rule to follow is: instead of checking for the
                   3705:       operating system the application is being built on, check for the
                   3706:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3707:       instead of assuming that kqueue is available under NetBSD and
                   3708:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14      jmcneill 3709:       kqueue support, add a check that detects kqueue itself &mdash;
1.1       dsieger  3710:       yes, this generally involves patching the
1.10      hubertf  3711:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.1       dsieger  3712:       that prevents some OSes from adopting interfaces from other OSes
                   3713:       (e.g. Linux implementing kqueue), something that the above checks
                   3714:       cannot take into account.</p>
                   3715: <p>Of course, checking for features generally involves more
                   3716:       work on the developer's side, but the resulting changes are
                   3717:       cleaner and there are chances they will work on many other
                   3718:       platforms.  Not to mention that there are higher chances of being
                   3719:       later integrated into the mainstream sources.  Remember:
                   3720:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3721: <p>Some typical examples:</p>
                   3722: <div class="table">
1.6       rillig   3723: <a name="patch-examples"></a><p class="title"><b>Table 11.1. Patching examples</b></p>
1.106     tnn      3724: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1       dsieger  3725: <colgroup>
                   3726: <col>
                   3727: <col>
                   3728: <col>
                   3729: </colgroup>
                   3730: <thead><tr>
                   3731: <th>Where</th>
                   3732: <th>Incorrect</th>
                   3733: <th>Correct</th>
                   3734: </tr></thead>
                   3735: <tbody>
                   3736: <tr>
                   3737: <td>configure script</td>
                   3738: <td>
                   3739: <pre class="programlisting">
                   3740: case ${target_os} in
                   3741: netbsd*) have_kvm=yes ;;
                   3742: *)       have_kvm=no  ;;
                   3743: esac
                   3744: </pre>
                   3745:              </td>
                   3746: <td>
                   3747: <pre class="programlisting">
                   3748: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   3749: </pre>
                   3750:              </td>
                   3751: </tr>
                   3752: <tr>
                   3753: <td>C source file</td>
                   3754: <td>
                   3755: <pre class="programlisting">
                   3756: #if defined(__NetBSD__)
                   3757: #  include &lt;sys/event.h&gt;
                   3758: #endif
                   3759: </pre>
                   3760:              </td>
                   3761: <td>
                   3762: <pre class="programlisting">
                   3763: #if defined(HAVE_SYS_EVENT_H)
                   3764: #  include &lt;sys/event.h&gt;
                   3765: #endif
                   3766: </pre>
                   3767:              </td>
                   3768: </tr>
                   3769: <tr>
                   3770: <td>C source file</td>
                   3771: <td>
                   3772: <pre class="programlisting">
                   3773: int
                   3774: monitor_file(...)
                   3775: {
                   3776: #if defined(__NetBSD__)
                   3777:         int fd = kqueue();
                   3778:         ...
                   3779: #else
                   3780:         ...
                   3781: #endif
                   3782: }
                   3783: </pre>
                   3784:              </td>
                   3785: <td>
                   3786: <pre class="programlisting">
                   3787: int
                   3788: monitor_file(...)
                   3789: {
                   3790: #if defined(HAVE_KQUEUE)
                   3791:         int fd = kqueue();
                   3792:         ...
                   3793: #else
1.112     rillig   3794:         ...
1.1       dsieger  3795: #endif
                   3796: }
                   3797: </pre>
                   3798:              </td>
                   3799: </tr>
                   3800: </tbody>
                   3801: </table></div>
                   3802: </div>
                   3803: <br class="table-break"><p>For more information, please read the <span class="emphasis"><em>Making
1.10      hubertf  3804:       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
                   3805:       1</a>, <a class="ulink" href="http://www.oreillynet.com/pub/a/onlamp/2005/04/28/packaging2.html" target="_top">part
1.1       dsieger  3806:       2</a>).  It summarizes multiple details on how to make
                   3807:       software easier to package; all the suggestions in it were
                   3808:       collected from our experience in pkgsrc work, so they are possibly
                   3809:       helpful when creating patches too.</p>
                   3810: </div>
1.41      asau     3811: <div class="sect2">
1.1       dsieger  3812: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3813: <a name="components.patches.feedback"></a>11.3.5. Feedback to the author</h3></div></div></div>
1.1       dsieger  3814: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3815:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3816:       improvements you do to a package to the mainstream developers.
                   3817:       This is the only way to get their attention on portability issues
                   3818:       and to ensure that future versions can be built out-of-the box on
                   3819:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3820:       the fixes straight from the packaged code.</p>
                   3821: <p>This generally involves cleaning up the patches
                   3822:       (because sometimes the patches that are
1.40      wiz      3823:       added to pkgsrc are quick hacks), filing bug reports in the
1.1       dsieger  3824:       appropriate trackers for the projects and working with the
                   3825:       mainstream authors to accept your changes.  It is
                   3826:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3827:       the packages in pkgsrc are kept simple and thus further changes
                   3828:       can be done without much hassle.</p>
1.24      wiz      3829: <p>When you have done this, please add a URL to the upstream
                   3830:       bug report to the patch comment.</p>
1.1       dsieger  3831: <p>Support the idea of free software!</p>
                   3832: </div>
                   3833: </div>
1.41      asau     3834: <div class="sect1">
1.1       dsieger  3835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3836: <a name="other-mandatory-files"></a>11.4. Other mandatory files</h2></div></div></div>
1.41      asau     3837: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3838: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3839: <dd><p>A multi-line description of the piece of software.  This should include
                   3840:          any credits where they are due.  Please bear in mind that others do not
                   3841:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3842:          will read everything that you write here.</p></dd>
                   3843: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3844: <dd><p>This file governs the files that are installed on your
                   3845:          system: all the binaries, manual pages, etc. There are other
                   3846:          directives which may be entered in this file, to control the
                   3847:          creation and deletion of directories, and the location of
1.10      hubertf  3848:          inserted files.  See <a class="xref" href="#plist" title="Chapter 13. PLIST issues">Chapter 13, <i>PLIST issues</i></a> for more
1.1       dsieger  3849:          information.</p></dd>
                   3850: </dl></div>
                   3851: </div>
1.41      asau     3852: <div class="sect1">
1.1       dsieger  3853: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3854: <a name="components.optional"></a>11.5. Optional files</h2></div></div></div>
1.41      asau     3855: <div class="sect2">
1.1       dsieger  3856: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3857: <a name="components.optional.bin"></a>11.5.1. Files affecting the binary package</h3></div></div></div>
1.41      asau     3858: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3859: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28      wiz      3860: <dd>
1.125     leot     3861: <p>This shell script is invoked twice by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1       dsieger  3862:            First time after package extraction and before files are
                   3863:            moved in place, the second time after the files to install
                   3864:            are moved in place. This can be used to do any custom
                   3865:            procedures not possible with @exec commands in
1.125     leot     3866:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   3867:            <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1"><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.28      wiz      3868:            Please note that you can modify variables in it easily by using
                   3869:            <code class="varname">FILES_SUBST</code> in the package's
                   3870:            <code class="filename">Makefile</code>:</p>
                   3871: <pre class="programlisting">
                   3872: FILES_SUBST+=  SOMEVAR="somevalue"
                   3873: </pre>
                   3874: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3875:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3876:            performed for <code class="varname">PREFIX</code>,
                   3877:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3878:            <code class="varname">VARBASE</code>, and a few others, type
                   3879:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3880:            complete list.</p>
                   3881: </dd>
1.1       dsieger  3882: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   3883: <dd><p>This script is executed before and after any files are removed.  It is
                   3884:            this script's responsibility to clean up any additional messy details
                   3885:            around the package's installation, since all pkg_delete knows is how to
                   3886:            delete the files created in the original distribution.
1.125     leot     3887:            See <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   3888:            and <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28      wiz      3889:            The same methods to replace variables can be used as for
                   3890:            the <code class="filename">INSTALL</code> file.</p></dd>
1.1       dsieger  3891: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   3892: <dd>
                   3893: <p>This file is displayed after installation of the package.
                   3894:            Useful for things like legal notices on almost-free
                   3895:            software and hints for updating config files after
                   3896:            installing modules for apache, PHP etc.
                   3897:            Please note that you can modify variables in it easily by using
                   3898:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3899:            <code class="filename">Makefile</code>:</p>
                   3900: <pre class="programlisting">
                   3901: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   3902: </pre>
1.23      wiz      3903: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.1       dsieger  3904:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3905:            performed for <code class="varname">PKGNAME</code>,
                   3906:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99      sevan    3907:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1       dsieger  3908:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3909:            <code class="varname">ROOT_GROUP</code>, and
1.16      jnemeth  3910:            <code class="varname">ROOT_USER</code>.</p>
1.1       dsieger  3911: <p>You can display a different or additional files by
                   3912:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3913:            default is <code class="filename">MESSAGE</code>, if the file
                   3914:            exists.</p>
                   3915: </dd>
                   3916: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66      asau     3917: <dd>
                   3918: <p>This file is used by the alternatives framework.
                   3919:            It creates, configures, and destroys generic wrappers used to
                   3920:            run programs with similar interfaces.
                   3921:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3922:             for more information.</p>
                   3923: <p>Each line of the file contains two filenames, first
                   3924:            the wrapper and then the alternative provided by the package.
                   3925:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3926: </dd>
1.1       dsieger  3927: </dl></div>
                   3928: </div>
1.41      asau     3929: <div class="sect2">
1.1       dsieger  3930: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3931: <a name="components.optional.build"></a>11.5.2. Files affecting the build process</h3></div></div></div>
1.41      asau     3932: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3933: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3934: <dd><p>This file contains arbitrary things that could
                   3935:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3936:        to be used by more than one package. This file should only be
                   3937:        used when the packages that will use the file are known in
                   3938:        advance. For other purposes it is often better to write a
                   3939:        <code class="filename">*.mk</code> file and give it a good name that
                   3940:        describes what it does.</p></dd>
                   3941: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3942: <dd><p>This file contains the dependency information
1.10      hubertf  3943:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p></dd>
1.1       dsieger  3944: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3945: <dd><p>This file contains workarounds for compiler bugs
                   3946:        and similar things. It is included automatically by the pkgsrc
                   3947:        infrastructure, so you don't need an extra
                   3948:        <code class="literal">.include</code> line for
                   3949:        it.</p></dd>
                   3950: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3951: <dd><p>This file contains the code for the
1.10      hubertf  3952:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
1.1       dsieger  3953:        selected by the user. If a package has only one or two options,
                   3954:        it is equally acceptable to put the code directly into the
                   3955:        <code class="filename">Makefile</code>.</p></dd>
                   3956: </dl></div>
                   3957: </div>
1.41      asau     3958: <div class="sect2">
1.1       dsieger  3959: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   3960: <a name="components.optional.none"></a>11.5.3. Files affecting nothing at all</h3></div></div></div>
1.41      asau     3961: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3962: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   3963: <dd><p>These files do not take place in the creation of
                   3964:        a package and thus are purely informative to the package
                   3965:        developer.</p></dd>
                   3966: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   3967: <dd><p>This file contains things that need to be done
                   3968:        to make the package even
                   3969:        better.</p></dd>
                   3970: </dl></div>
                   3971: </div>
                   3972: </div>
1.41      asau     3973: <div class="sect1">
1.1       dsieger  3974: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3975: <a name="work-dir"></a>11.6. <code class="filename">work*</code>
1.1       dsieger  3976: </h2></div></div></div>
1.10      hubertf  3977: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1       dsieger  3978:     unpacked into the directory denoted by
                   3979:     <code class="varname">WRKDIR</code>. It can be removed by running
1.10      hubertf  3980:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1       dsieger  3981:     directory is also used to keep various timestamp files.
                   3982:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   3983:     The default is <code class="filename">${.CURDIR}/work</code>
                   3984:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   3985:     if <code class="varname">OBJMACHINE</code> is set.</p>
                   3986: </div>
1.41      asau     3987: <div class="sect1">
1.1       dsieger  3988: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   3989: <a name="files-dir"></a>11.7. <code class="filename">files/*</code>
1.1       dsieger  3990: </h2></div></div></div>
                   3991: <p>If you have any files that you wish to be placed in the package prior
                   3992:     to configuration or building, you could place these files here and use
1.10      hubertf  3993:     a <span class="command"><strong>${CP}</strong></span> command in the
1.23      wiz      3994:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.1       dsieger  3995:     this. Alternatively, you could simply diff the file against
                   3996:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   3997:     the creation of this file.</p>
                   3998: <p>If you want to share files in this way with other
                   3999:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4000:     to the other package's <code class="filename">files</code> directory,
                   4001:     e.g.:</p>
                   4002: <pre class="programlisting">
                   4003: FILESDIR=${.CURDIR}/../xemacs/files
                   4004: </pre>
                   4005: </div>
                   4006: </div>
1.41      asau     4007: <div class="chapter">
1.1       dsieger  4008: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4009: <a name="makefile"></a>Chapter 12. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  4010: <div class="toc">
                   4011: <p><b>Table of Contents</b></p>
1.100     leot     4012: <dl class="toc">
1.6       rillig   4013: <dt><span class="sect1"><a href="#makefile.style">12.1. Caveats</a></span></dt>
1.23      wiz      4014: <dt><span class="sect1"><a href="#makefile.variables">12.2. <code class="filename">Makefile</code> variables</a></span></dt>
1.6       rillig   4015: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">12.2.1. Naming conventions</a></span></dt></dl></dd>
                   4016: <dt><span class="sect1"><a href="#makefile.code">12.3. Code snippets</a></span></dt>
                   4017: <dd><dl>
                   4018: <dt><span class="sect2"><a href="#adding-to-list">12.3.1. Adding things to a list</a></span></dt>
1.117     sevan    4019: <dt><span class="sect2"><a href="#echo-literal">12.3.2. Echoing a string exactly as-is</a></span></dt>
1.108     rillig   4020: <dt><span class="sect2"><a href="#cflags-gnu-configure">12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   4021: <dt><span class="sect2"><a href="#empty-variables">12.3.4. Handling possibly empty variables</a></span></dt>
1.1       dsieger  4022: </dl></dd>
                   4023: </dl>
                   4024: </div>
                   4025: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   4026:   each of which forms a well-defined part of the pkgsrc system. Using
1.125     leot     4027:   the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1       dsieger  4028:   like pkgsrc requires some discipline to keep the code correct and
                   4029:   understandable.</p>
                   4030: <p>The basic ingredients for <code class="filename">Makefile</code>
                   4031:   programming are variables (which are actually macros) and shell
                   4032:   commands. Among these shell commands may even be more complex ones
1.125     leot     4033:   like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1       dsieger  4034:   as intended it is necessary to quote all variables correctly when they
                   4035:   are used.</p>
                   4036: <p>This chapter describes some patterns, that appear quite often in
                   4037:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   4038:   with them.</p>
1.41      asau     4039: <div class="sect1">
1.1       dsieger  4040: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4041: <a name="makefile.style"></a>12.1. Caveats</h2></div></div></div>
1.41      asau     4042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1       dsieger  4043: <p>When you are creating a file as a
                   4044:     target of a rule, always write the data to a temporary file first
                   4045:     and finally rename that file. Otherwise there might occur an error
                   4046:     in the middle of generating the file, and when the user runs
1.125     leot     4047:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1       dsieger  4048:     regenerated properly. Example:</p>
                   4049: <pre class="programlisting">
                   4050: wrong:
                   4051:         @echo "line 1" &gt; ${.TARGET}
                   4052:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4053:         @false
                   4054: 
                   4055: correct:
                   4056:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4057:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4058:         @false
                   4059:         @mv ${.TARGET}.tmp ${.TARGET}
                   4060: </pre>
1.10      hubertf  4061: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1       dsieger  4062:     <code class="filename">wrong</code> will exist, although there was an error
1.10      hubertf  4063:     message in the first run. On the other hand, running <span class="command"><strong>make
1.1       dsieger  4064:     correct</strong></span> gives an error message twice, as expected.</p>
1.125     leot     4065: <p>You might remember that <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1       dsieger  4066:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4067:     happens when it is interrupted, for example by pressing
                   4068:     <code class="literal">^C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.125     leot     4069:     when one of the commands fails (like <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1       dsieger  4070: </li></ul></div>
                   4071: </div>
1.41      asau     4072: <div class="sect1">
1.1       dsieger  4073: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4074: <a name="makefile.variables"></a>12.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1       dsieger  4075: <p><code class="filename">Makefile</code> variables contain strings that
                   4076:     can be processed using the five operators ``='', ``+='', ``?='',
1.125     leot     4077:     ``:='', and ``!='', which are described in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1       dsieger  4078:     page.</p>
                   4079: <p>When a variable's value is parsed from a
                   4080:     <code class="filename">Makefile</code>, the hash character ``#'' and the
                   4081:     backslash character ``\'' are handled specially. If a backslash is
                   4082:     followed by a newline, any whitespace immediately in front of the
                   4083:     backslash, the backslash, the newline, and any whitespace
                   4084:     immediately behind the newline are replaced with a single space. A
                   4085:     backslash character and an immediately following hash character are
                   4086:     replaced with a single hash character. Otherwise, the backslash is
                   4087:     passed as is. In a variable assignment, any hash character that is
                   4088:     not preceded by a backslash starts a comment that continues upto the
                   4089:     end of the logical line.</p>
1.108     rillig   4090: <p>The evaluation of variables either happens immediately or lazy.
                   4091:     It happens immediately when the variable occurs
                   4092:     on the right-hand side of the ``:='' or the ``!='' operator, in a
                   4093:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   4094:     In the other cases, it is evaluated lazily.</p>
1.1       dsieger  4095: <p>Some of the modifiers split the string into words and then
                   4096:     operate on the words, others operate on the string as a whole. When
1.125     leot     4097:     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.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.1       dsieger  4098: <p>There are several types of variables that should be handled
                   4099:     differently. Strings and two types of lists.</p>
1.41      asau     4100: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4101: <li class="listitem"><p><span class="emphasis"><em>Strings</em></span> can contain arbitrary
1.1       dsieger  4102:       characters. Nevertheless, you should restrict yourself to only
                   4103:       using printable characters. Examples are
                   4104:       <code class="varname">PREFIX</code> and
                   4105:       <code class="varname">COMMENT</code>.</p></li>
1.23      wiz      4106: <li class="listitem"><p><span class="emphasis"><em>Internal lists</em></span> are lists that
1.1       dsieger  4107:       are never exported to any shell command. Their elements are
                   4108:       separated by whitespace. Therefore, the elements themselves cannot
                   4109:       have embedded whitespace. Any other characters are allowed.
1.10      hubertf  4110:       Internal lists can be used in <span class="command"><strong>.for</strong></span> loops.
1.1       dsieger  4111:       Examples are <code class="varname">DEPENDS</code> and
                   4112:       <code class="varname">BUILD_DEPENDS</code>.</p></li>
1.23      wiz      4113: <li class="listitem"><p><span class="emphasis"><em>External lists</em></span> are lists that
1.1       dsieger  4114:       may be exported to a shell command. Their elements can contain any
                   4115:       characters, including whitespace. That's why they cannot be used
1.10      hubertf  4116:       in <span class="command"><strong>.for</strong></span> loops. Examples are
1.1       dsieger  4117:       <code class="varname">DISTFILES</code> and
                   4118:       <code class="varname">MASTER_SITES</code>.</p></li>
                   4119: </ul></div>
1.41      asau     4120: <div class="sect2">
1.1       dsieger  4121: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4122: <a name="makefile.variables.names"></a>12.2.1. Naming conventions</h3></div></div></div>
1.41      asau     4123: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4124: <li class="listitem"><p>All variable names starting with an underscore
1.1       dsieger  4125:        are reserved for use by the pkgsrc infrastructure. They shall
                   4126:        not be used by package
                   4127:        <code class="filename">Makefile</code>s.</p></li>
1.23      wiz      4128: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1       dsieger  4129:        lowercase variable names for the iteration
                   4130:        variables.</p></li>
1.23      wiz      4131: <li class="listitem"><p>All list variables should have a ``plural''
1.1       dsieger  4132:        name, e.g. <code class="varname">PKG_OPTIONS</code> or
                   4133:        <code class="varname">DISTFILES</code>.</p></li>
                   4134: </ul></div>
                   4135: </div>
                   4136: </div>
1.41      asau     4137: <div class="sect1">
1.1       dsieger  4138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4139: <a name="makefile.code"></a>12.3. Code snippets</h2></div></div></div>
1.41      asau     4140: <div class="sect2">
1.1       dsieger  4141: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4142: <a name="adding-to-list"></a>12.3.1. Adding things to a list</h3></div></div></div>
1.108     rillig   4143: <p>When adding a string that possibly contains whitespace or quotes to
                   4144: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   4145: modifier.</p>
                   4146: <p>When adding another list to a list (example 2), it must not be
                   4147: quoted, since its elements are already quoted.</p>
1.1       dsieger  4148: <pre class="programlisting">
1.108     rillig   4149: STRING=         foo * bar `date`
                   4150: LIST=           # empty
                   4151: ANOTHER_LIST=   a=b c=d
                   4152: 
                   4153: LIST+=          ${STRING:Q}       # 1
                   4154: LIST+=          ${ANOTHER_LIST}   # 2
1.1       dsieger  4155: </pre>
                   4156: </div>
1.41      asau     4157: <div class="sect2">
1.1       dsieger  4158: <div class="titlepage"><div><div><h3 class="title">
1.117     sevan    4159: <a name="echo-literal"></a>12.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.108     rillig   4160: <p>Echoing a string containing special characters needs special
                   4161: work.</p>
1.1       dsieger  4162: <pre class="programlisting">
                   4163: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
1.108     rillig   4164: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       dsieger  4165: 
                   4166: all:
                   4167:         echo ${STRING}                  # 1
1.108     rillig   4168:         echo ${STRING:Q}                # 2
                   4169:         printf '%s\n' ${STRING:Q}''     # 3
                   4170:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
                   4171: </pre>
                   4172: <p>Example 1 leads to a syntax error in the shell, as the characters
                   4173: are just copied.</p>
                   4174: <p>Example 2 quotes the string so that the shell interprets it
                   4175: correctly. But the echo command may additionally interpret strings with a
                   4176: leading dash or those containing backslashes.</p>
1.125     leot     4177: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.108     rillig   4178: interprets the format string, but not the next argument.</p>
                   4179: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   4180: need to be quoted because the quoting has already been done
                   4181: when adding elements to the list.</p>
1.1       dsieger  4182: </div>
1.41      asau     4183: <div class="sect2">
1.1       dsieger  4184: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   4185: <a name="cflags-gnu-configure"></a>12.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   4186: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   4187: GNU-style configure script (especially those that call other configure
                   4188: scripts), it must not have leading or trailing whitespace, since
                   4189: otherwise the configure script gets confused. To trim leading and
                   4190: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   4191: following example:</p>
1.1       dsieger  4192: <pre class="programlisting">
                   4193: CPPFLAGS=               # empty
1.108     rillig   4194: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
1.1       dsieger  4195: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4196: 
                   4197: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4198: 
                   4199: all:
                   4200:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
1.108     rillig   4201:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
1.1       dsieger  4202: </pre>
1.108     rillig   4203: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   4204: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   4205: space.</p>
                   4206: </div>
                   4207: <div class="sect2">
                   4208: <div class="titlepage"><div><div><h3 class="title">
                   4209: <a name="empty-variables"></a>12.3.4. Handling possibly empty variables</h3></div></div></div>
                   4210: <p>When a possibly empty variable is used in a shell program, it may
                   4211: lead to a syntax error.</p>
                   4212: <pre class="programlisting">
                   4213: EGFILES=        # empty
                   4214: 
                   4215: install-examples:   # produces a syntax error in the shell
                   4216:         for egfile in ${EGFILES}; do            \
                   4217:                 echo "Installing $$egfile";     \
                   4218:         done
                   4219: </pre>
                   4220: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.125     leot     4221: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.108     rillig   4222: To fix this syntax error, use one of the snippets below.</p>
                   4223: <pre class="programlisting">
                   4224: EMPTY=          # empty
                   4225: 
                   4226: install-examples:
                   4227:         for egfile in ${EGFILES} ""; do         \
                   4228:                 [ -n "$$egfile" ] || continue;  \
                   4229:                 echo "Installing $$egfile";     \
1.1       dsieger  4230:         done
1.108     rillig   4231: </pre>
                   4232: <p>In this case, an empty string is appended to the iteration list (to
                   4233: prevent the syntax error) and filtered out later.</p>
                   4234: <pre class="programlisting">
                   4235: EGFILES=        # empty
1.1       dsieger  4236: 
1.108     rillig   4237: install-examples:
                   4238: .for egfile in ${EGFILES}
                   4239:         echo "Installing ${egfile}"
1.1       dsieger  4240: .endfor
                   4241: </pre>
1.108     rillig   4242: <p>This variant only works when <code class="varname">EGFILES</code> does not
                   4243: contain filenames with spaces, since the <code class="code">.for</code> loop splits on
                   4244: simple whitespace.</p>
                   4245: <p>To have a shell command test whether a make variable is empty, use
                   4246: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1       dsieger  4247: </div>
                   4248: </div>
                   4249: </div>
1.41      asau     4250: <div class="chapter">
1.1       dsieger  4251: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4252: <a name="plist"></a>Chapter 13. PLIST issues</h2></div></div></div>
1.1       dsieger  4253: <div class="toc">
                   4254: <p><b>Table of Contents</b></p>
1.100     leot     4255: <dl class="toc">
1.6       rillig   4256: <dt><span class="sect1"><a href="#rcs-id">13.1. RCS ID</a></span></dt>
1.23      wiz      4257: <dt><span class="sect1"><a href="#automatic-plist-generation">13.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4258: <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.6       rillig   4259: <dt><span class="sect1"><a href="#plist.misc">13.4. Variable substitution in PLIST</a></span></dt>
                   4260: <dt><span class="sect1"><a href="#manpage-compression">13.5. Man page compression</a></span></dt>
1.23      wiz      4261: <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.6       rillig   4262: <dt><span class="sect1"><a href="#platform-specific-plist">13.7. Platform-specific and differing PLISTs</a></span></dt>
1.86      wiz      4263: <dt><span class="sect1"><a href="#build-plist">13.8. Build-specific PLISTs</a></span></dt>
                   4264: <dt><span class="sect1"><a href="#faq.common-dirs">13.9. Sharing directories between packages</a></span></dt>
1.1       dsieger  4265: </dl>
                   4266: </div>
                   4267: <p>The <code class="filename">PLIST</code> file contains a package's
1.23      wiz      4268:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.1       dsieger  4269:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4270:   directory it's been installed in) plus some additional statements
1.125     leot     4271:   - see the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1       dsieger  4272:   This chapter addresses some issues that need attention when
                   4273:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4274:   below!).</p>
1.41      asau     4275: <div class="sect1">
1.1       dsieger  4276: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4277: <a name="rcs-id"></a>13.1. RCS ID</h2></div></div></div>
1.1       dsieger  4278: <p>Be sure to add a RCS ID line as the first thing in any
                   4279:     <code class="filename">PLIST</code> file you write:</p>
                   4280: <pre class="programlisting">
1.121     sevan    4281: @comment $NetBSD $
1.111     sevan    4282: </pre>
1.123     wiz      4283: <p>An artificial space has been added between NetBSD and $, this is a
1.121     sevan    4284: workaround here to prevent CVS expanding to the filename of the guide. When
1.125     leot     4285: adding the RCS ID the space should be omitted.</p>
1.1       dsieger  4286: </div>
1.41      asau     4287: <div class="sect1">
1.1       dsieger  4288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4289: <a name="automatic-plist-generation"></a>13.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10      hubertf  4290: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1       dsieger  4291:     to output a PLIST that matches any new files since the package
1.10      hubertf  4292:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="17.17. Other helpful targets">Section 17.17, &#8220;Other helpful targets&#8221;</a> for
1.1       dsieger  4293:     more information on this target.</p>
                   4294: </div>
1.41      asau     4295: <div class="sect1">
1.1       dsieger  4296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.10      hubertf  4297: <a name="print-PLIST"></a>13.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  4298: </h2></div></div></div>
                   4299: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4300:     of AWK patterns and actions that are used to filter the output of
                   4301:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4302:     scripting you like to it, but be careful with quoting.</p>
                   4303: <p>For example, to get all files inside the
                   4304:     <code class="filename">libdata/foo</code> directory removed from the
                   4305:     resulting PLIST:</p>
                   4306: <pre class="programlisting">
                   4307: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.111     sevan    4308: </pre>
1.1       dsieger  4309: </div>
1.41      asau     4310: <div class="sect1">
1.1       dsieger  4311: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4312: <a name="plist.misc"></a>13.4. Variable substitution in PLIST</h2></div></div></div>
1.1       dsieger  4313: <p>A number of variables are substituted automatically in
                   4314:     PLISTs when a package is installed on a system. This includes the
                   4315:     following variables:</p>
1.41      asau     4316: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4317: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4318: <dd>
                   4319: <p>Some packages like emacs and perl embed information
                   4320:          about which architecture they were built on into the
                   4321:          pathnames where they install their files. To handle this
                   4322:          case, PLIST will be preprocessed before actually used, and
                   4323:          the symbol
1.23      wiz      4324:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.10      hubertf  4325:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1       dsieger  4326:          same is done if the string
                   4327:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4328:          PLIST somewhere - use this on packages that have GNU
                   4329:          autoconf-created configure scripts.</p>
1.41      asau     4330: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  4331: <h3 class="title">Legacy note</h3>
                   4332: <p>There used to be a symbol
1.23      wiz      4333:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.10      hubertf  4334:            was replaced by the output of <span class="command"><strong>uname
1.1       dsieger  4335:            -m</strong></span>, but that's no longer supported and has
                   4336:            been removed.</p>
                   4337: </div>
                   4338: </dd>
                   4339: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4340: <dd>
                   4341: <p>Some packages want to embed the OS name and version
                   4342:          into some paths.  To do this, use these variables in the
                   4343:          <code class="filename">PLIST</code>:
                   4344:          </p>
1.41      asau     4345: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4346: <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>
                   4347: <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>
                   4348: <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.1       dsieger  4349: </ul></div>
                   4350: </dd>
                   4351: </dl></div>
1.88      tnn      4352: <p>For a list of values which are replaced by
                   4353:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4354: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4355: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1       dsieger  4356: <p>If you want to change other variables not listed above, you
                   4357:     can add variables and their expansions to this variable in the
1.10      hubertf  4358:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="11.5. Optional files">Section 11.5, &#8220;Optional files&#8221;</a>):</p>
1.1       dsieger  4359: <pre class="programlisting">
                   4360: PLIST_SUBST+=   SOMEVAR="somevalue"
1.111     sevan    4361: </pre>
1.23      wiz      4362: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.1       dsieger  4363:     in the <code class="filename">PLIST</code> with
1.23      wiz      4364:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.18      snj      4365: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   4366:     the common case of conditionally including some
                   4367:     <code class="filename">PLIST</code> entries. It can be done by adding
                   4368:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   4369:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   4370:     to <code class="literal">yes</code> if the entry should be included.
1.23      wiz      4371:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.18      snj      4372:     in the <code class="filename">PLIST</code> with either
1.23      wiz      4373:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   4374:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.18      snj      4375:     For example, in <code class="filename">Makefile</code>:</p>
                   4376: <pre class="programlisting">
1.112     rillig   4377: PLIST_VARS+=    foo
1.18      snj      4378: .if <em class="replaceable"><code>condition</code></em>
1.112     rillig   4379: PLIST.foo=      yes
1.18      snj      4380: .else
1.111     sevan    4381: </pre>
1.18      snj      4382: <p>And then in <code class="filename">PLIST</code>:</p>
                   4383: <pre class="programlisting">
1.121     sevan    4384: @comment $NetBSD $
1.18      snj      4385: bin/bar
                   4386: man/man1/bar.1
                   4387: ${PLIST.foo}bin/foo
                   4388: ${PLIST.foo}man/man1/foo.1
                   4389: ${PLIST.foo}share/bar/foo.data
1.111     sevan    4390: </pre>
1.123     wiz      4391: <p>An artificial space has been added between NetBSD and $, this is a
1.121     sevan    4392: workaround here to prevent CVS expanding to the filename of the guide. When
                   4393: adding the RCS ID the space should be ommited.</p>
1.1       dsieger  4394: </div>
1.41      asau     4395: <div class="sect1">
1.1       dsieger  4396: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4397: <a name="manpage-compression"></a>13.5. Man page compression</h2></div></div></div>
1.1       dsieger  4398: <p>Man pages should be installed in compressed form if
                   4399:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   4400:     and uncompressed otherwise. To handle this in the
1.23      wiz      4401:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.1       dsieger  4402:     appended/removed automatically for man pages according to
                   4403:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   4404:     or not, see above for details. This modification of the
                   4405:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   4406:     <code class="filename">PLIST</code> itself.</p>
                   4407: </div>
1.41      asau     4408: <div class="sect1">
1.1       dsieger  4409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4410: <a name="using-PLIST_SRC"></a>13.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1       dsieger  4411: </h2></div></div></div>
                   4412: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   4413:     in generating the binary package, set the variable
                   4414:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.125     leot     4415:     The files are later concatenated using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1       dsieger  4416:     important. The default for <code class="varname">PLIST_SRC</code> is
                   4417:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
                   4418: </div>
1.41      asau     4419: <div class="sect1">
1.1       dsieger  4420: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4421: <a name="platform-specific-plist"></a>13.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1       dsieger  4422: <p>Some packages decide to install a different set of files based on
                   4423:     the operating system being used. These differences can be
                   4424:     automatically handled by using the following files:</p>
1.41      asau     4425: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4426: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   4427: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   4428: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   4429: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   4430: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1       dsieger  4431: </ul></div>
                   4432: </div>
1.41      asau     4433: <div class="sect1">
1.1       dsieger  4434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.86      wiz      4435: <a name="build-plist"></a>13.8. Build-specific PLISTs</h2></div></div></div>
                   4436: <p>Some packages decide to generate hard-to-guess file names
                   4437:     during installation that are hard to wire down.</p>
                   4438: <p>In such cases, you can set the
                   4439:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   4440:     terminated (with a semicolon) that will output PLIST entries which
                   4441:     will be appended to the PLIST</p>
                   4442: <p>You can find one example in editors/xemacs:</p>
                   4443: <pre class="programlisting">
1.111     sevan    4444: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   4445: </pre>
1.86      wiz      4446: <p>which will append something like
                   4447:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   4448:     <code class="filename">PLIST</code>.
                   4449:     </p>
                   4450: </div>
                   4451: <div class="sect1">
                   4452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4453: <a name="faq.common-dirs"></a>13.9. Sharing directories between packages</h2></div></div></div>
1.23      wiz      4454: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.1       dsieger  4455:     multiple (and unrelated) packages install files.  These
1.22      jakllsch 4456:     directories were problematic because you had to add special
                   4457:     tricks in the PLIST to conditionally remove them, or have some
1.1       dsieger  4458:     centralized package handle them.</p>
1.22      jakllsch 4459: <p>In pkgsrc, it is now easy: Each package should create
                   4460:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   4461:     will remove any directories left empty after uninstalling a
                   4462:     package.</p>
                   4463: <p>If a package needs an empty directory to work, create
                   4464:     the directory during installation as usual, and also add an
                   4465:     entry to the PLIST:
1.111     sevan    4466: 
                   4467: </p>
1.1       dsieger  4468: <pre class="programlisting">
1.22      jakllsch 4469: @pkgdir path/to/empty/directory
1.111     sevan    4470: </pre>
1.22      jakllsch 4471: <p>
1.111     sevan    4472: 
1.86      wiz      4473:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   4474:     <code class="varname">OWN_DIRS</code>.
1.22      jakllsch 4475:     </p>
1.1       dsieger  4476: </div>
                   4477: </div>
1.41      asau     4478: <div class="chapter">
1.1       dsieger  4479: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4480: <a name="buildlink"></a>Chapter 14. Buildlink methodology</h2></div></div></div>
1.1       dsieger  4481: <div class="toc">
                   4482: <p><b>Table of Contents</b></p>
1.100     leot     4483: <dl class="toc">
1.6       rillig   4484: <dt><span class="sect1"><a href="#converting-to-buildlink3">14.1. Converting packages to use buildlink3</a></span></dt>
1.23      wiz      4485: <dt><span class="sect1"><a href="#creating-buildlink3.mk">14.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  4486: <dd><dl>
1.6       rillig   4487: <dt><span class="sect2"><a href="#anatomy-of-bl3">14.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
1.26      wiz      4488: <dt><span class="sect2"><a href="#updating-buildlink-depends">14.2.2. Updating
                   4489:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4490:       and
                   4491:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4492:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  4493: </dl></dd>
1.23      wiz      4494: <dt><span class="sect1"><a href="#writing-builtin.mk">14.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1       dsieger  4495: <dd><dl>
1.23      wiz      4496: <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.6       rillig   4497: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">14.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1       dsieger  4498: </dl></dd>
                   4499: </dl>
                   4500: </div>
                   4501: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   4502:   are seen by a package's configure and build processes.  This is implemented
                   4503:   in a two step process:</p>
1.23      wiz      4504: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4505: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1       dsieger  4506:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   4507:       of <code class="varname">WRKDIR</code>.</p></li>
1.23      wiz      4508: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1       dsieger  4509:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   4510:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   4511:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   4512:       native compiler on some operating systems look like GCC, so that
                   4513:       packages that expect GCC won't require modifications to build with
                   4514:       those native compilers.</p></li>
                   4515: </ol></div>
                   4516: <p>This normalizes the environment in which a package is built so that the
                   4517:   package may be built consistently despite what other software may be
                   4518:   installed. Please note that the normal system header and library paths,
                   4519:   e.g. <code class="filename">/usr/include</code>,
                   4520:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   4521:   designed to insulate the package build from non-system-supplied
                   4522:   software.</p>
1.41      asau     4523: <div class="sect1">
1.1       dsieger  4524: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4525: <a name="converting-to-buildlink3"></a>14.1. Converting packages to use buildlink3</h2></div></div></div>
1.1       dsieger  4526: <p>The process of converting packages to use the buildlink3
1.23      wiz      4527:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.1       dsieger  4528:     The things to keep in mind are:</p>
1.23      wiz      4529: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4530: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1       dsieger  4531:        instead of the actual toolchain.  Some packages are tricky,
                   4532:        and the only way to know for sure is the check
                   4533:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   4534:        wrappers are being invoked.</p></li>
1.23      wiz      4535: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1       dsieger  4536:        the package Makefile, e.g. Java VMs, standalone shells,
                   4537:        etc., because the code to symlink files into
                   4538:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23      wiz      4539:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
1.1       dsieger  4540:        </p></li>
1.23      wiz      4541: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1       dsieger  4542:        <code class="filename">buildlink3.mk</code> files that you list in a
                   4543:        package's Makefile are added as dependencies for that package.
                   4544:        </p></li>
                   4545: </ol></div>
                   4546: <p>If a dependency on a particular package is required for its libraries and
                   4547:     headers, then we replace:</p>
                   4548: <pre class="programlisting">
                   4549: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   4550: </pre>
                   4551: <p>with</p>
                   4552: <pre class="programlisting">
                   4553: .include "../../category/foo/buildlink3.mk"
                   4554: </pre>
                   4555: <p>The buildlink3.mk files usually define the required dependencies.
                   4556:     If you need a newer version of the dependency when using buildlink3.mk
                   4557:     files, then you can define it in your Makefile; for example:</p>
                   4558: <pre class="programlisting">
                   4559: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   4560: .include "../../category/foo/buildlink3.mk"
                   4561: </pre>
                   4562: <p>There are several <code class="filename">buildlink3.mk</code>
                   4563:     files in <code class="filename">pkgsrc/mk</code>
                   4564:     that handle special package issues:</p>
1.41      asau     4565: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4566: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1       dsieger  4567:        the native or a pkgsrc Berkeley DB implementation based on
                   4568:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   4569:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23      wiz      4570: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1       dsieger  4571:        comes with neither Curses nor NCurses, this will take care
1.120     sevan    4572:        to install the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
1.23      wiz      4573: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1       dsieger  4574:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   4575:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   4576:        require a Kerberos 5 implementation.</p></li>
1.23      wiz      4577: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1       dsieger  4578:        system-provided Motif installation or adds a dependency on
1.126     leot     4579:        <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
1.23      wiz      4580:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.126     leot     4581:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   4582:        to choose which Motif version will be used.</p></li>
1.55      ryoon    4583: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56      wiz      4584:        system-provided GNU readline or editline (libedit) installation,
1.120     sevan    4585:        or adds a dependency on <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
                   4586:        <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
1.55      ryoon    4587:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   4588:        If your package really needs GNU readline library, its Makefile
                   4589:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   4590:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23      wiz      4591: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1       dsieger  4592:        variables that may be used by packages that use the
                   4593:        Open Sound System (OSS) API.</p></li>
1.23      wiz      4594: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35      wiz      4595:        any of the Postgres versions in the variable
                   4596:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   4597:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1       dsieger  4598:        the file for more information.</p></li>
1.23      wiz      4599: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1       dsieger  4600:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.120     sevan    4601:        a dependency on <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
1.23      wiz      4602: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1       dsieger  4603:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   4604:        library.</p></li>
                   4605: </ul></div>
                   4606: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   4607:     files provide a more complete
                   4608:     description of how to use them properly.</p>
                   4609: </div>
1.41      asau     4610: <div class="sect1">
1.1       dsieger  4611: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4612: <a name="creating-buildlink3.mk"></a>14.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7       rillig   4613: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1       dsieger  4614:     included by Makefiles to indicate the need to compile and link
                   4615:     against header files and libraries provided by the package.  A
                   4616:     <code class="filename">buildlink3.mk</code> file should always provide
                   4617:     enough information to add the correct type of dependency
                   4618:     relationship and include any other
                   4619:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   4620:     headers and libraries that it needs in turn.</p>
                   4621: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.120     sevan    4622:     file for further editing, Rene Hexel's <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
1.1       dsieger  4623:     package is highly recommended.  For most packages, the following
                   4624:     command will generate a good starting point for
                   4625:     <code class="filename">buildlink3.mk</code> files:</p>
                   4626: <pre class="screen">
                   4627: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   4628: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   4629:     </pre>
1.41      asau     4630: <div class="sect2">
1.1       dsieger  4631: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4632: <a name="anatomy-of-bl3"></a>14.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1       dsieger  4633: <p>The following real-life example
                   4634:       <code class="filename">buildlink3.mk</code> is taken
                   4635:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
                   4636: <pre class="programlisting">
1.18      snj      4637: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       dsieger  4638: 
1.112     rillig   4639: BUILDLINK_TREE+=        tiff
1.1       dsieger  4640: 
1.18      snj      4641: .if !defined(TIFF_BUILDLINK3_MK)
                   4642: TIFF_BUILDLINK3_MK:=
1.1       dsieger  4643: 
1.112     rillig   4644: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   4645: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   4646: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
1.1       dsieger  4647: 
                   4648: .include "../../devel/zlib/buildlink3.mk"
                   4649: .include "../../graphics/jpeg/buildlink3.mk"
1.18      snj      4650: .endif # TIFF_BUILDLINK3_MK
1.1       dsieger  4651: 
1.112     rillig   4652: BUILDLINK_TREE+=        -tiff
1.1       dsieger  4653: </pre>
                   4654: <p>The header and footer manipulate
1.18      snj      4655:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1       dsieger  4656:       <code class="filename">buildlink3.mk</code> files and is used to track
1.18      snj      4657:       the dependency tree.</p>
                   4658: <p>The main section is protected from multiple inclusion
1.1       dsieger  4659:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   4660:       added.  Several important variables are set in the section:</p>
1.41      asau     4661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4662: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4663:          is the actual dependency recorded in the installed
                   4664:          package; this should always be set using
1.10      hubertf  4665:          <span class="command"><strong>+=</strong></span> to ensure that
1.1       dsieger  4666:          we're appending to any pre-existing list of values.  This
                   4667:          variable should be set to the first version of the
1.26      wiz      4668:          package that had an backwards-incompatible API change.
1.1       dsieger  4669:          </p></li>
1.23      wiz      4670: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4671:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   4672:          pkgsrc directory.</p></li>
1.23      wiz      4673: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4674:          (not shown above) controls whether we use
                   4675:          <code class="varname">BUILD_DEPENDS</code> or
                   4676:          <code class="varname">DEPENDS</code> to add the dependency on
                   4677:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   4678:          selected by setting
                   4679:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4680:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.1       dsieger  4681:          used.</p></li>
1.23      wiz      4682: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4683:            and
                   4684:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   4685:            (not shown above) are lists of subdirectories of
                   4686:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   4687:            to add to the header and library search paths.  These
1.23      wiz      4688:            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.1       dsieger  4689:          respectively.</p></li>
1.23      wiz      4690: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4691:            (not shown above) is the list of preprocessor flags to add
                   4692:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23      wiz      4693:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.1       dsieger  4694:            should be avoided and instead be handled using
                   4695:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   4696:          above.</p></li>
                   4697: </ul></div>
                   4698: <p>The following variables are all optionally defined within
                   4699:       this second section (protected against multiple inclusion) and
                   4700:       control which package files are symlinked into
                   4701:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   4702:       transformed during the symlinking:</p>
1.41      asau     4703: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4704: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4705:            (not shown above) is a shell glob pattern relative to
                   4706:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   4707:            to be symlinked into
                   4708:            <code class="filename">${BUILDLINK_DIR}</code>,
                   4709:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.23      wiz      4710: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4711:            (not shown above) is a shell pipeline that
                   4712:            outputs to stdout a list of files relative to
                   4713:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   4714:            The resulting files are to be symlinked
                   4715:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   4716:            this takes the <code class="filename">+CONTENTS</code> of a
                   4717:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   4718:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23      wiz      4719: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4720:            (not shown above) is a filter command that filters
                   4721:            <code class="filename">+CONTENTS</code> input into a list of files
                   4722:            relative to
                   4723:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84      wiz      4724:            on stdout.  By default,
1.1       dsieger  4725:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   4726:            outputs the contents of the <code class="filename">include</code>
                   4727:            and <code class="filename">lib</code> directories in the package
1.84      wiz      4728:            <code class="filename">+CONTENTS</code>.</p></li>
1.23      wiz      4729: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4730:            (not shown above) is a list of sed arguments used to
                   4731:            transform the name of the source filename into a
1.10      hubertf  4732:            destination filename, e.g. <span class="command"><strong>-e
1.1       dsieger  4733:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   4734: </ul></div>
1.18      snj      4735: <p>This section can additionally include any
1.1       dsieger  4736:       <code class="filename">buildlink3.mk</code> needed for
                   4737:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   4738:       Including these <code class="filename">buildlink3.mk</code> files
                   4739:       means that the headers and libraries for these
                   4740:       dependencies are also symlinked into
                   4741:       <code class="filename">${BUILDLINK_DIR}</code>
                   4742:       whenever the <em class="replaceable"><code>pkg</code></em>
                   4743:       <code class="filename">buildlink3.mk</code>
1.18      snj      4744:       file is included. Dependencies are only added for directly
                   4745:       include <code class="filename">buildlink3.mk</code> files.</p>
1.47      wiz      4746: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   4747:       including other <code class="filename">buildlink3.mk</code> files in it,
1.50      wiz      4748:       please only add necessary ones, i.e., those whose libraries or
1.47      wiz      4749:       header files are automatically exposed when the package is
                   4750:       use.</p>
                   4751: <p>In particular, if only an executable
                   4752:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   4753:       library does not need to be propagated in the
                   4754:       <code class="filename">buildlink3.mk</code> file.</p>
                   4755: <p>The following steps should help you decide if a
                   4756:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   4757:       </p>
                   4758: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4759: <li class="listitem"><p>Look at the installed header files: What
                   4760:        headers do they include? The packages providing these files
                   4761:        must be buildlinked.</p></li>
1.49      wiz      4762: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   4763:        libraries and look against what other libraries they link.
                   4764:        Some of the packages providing these probably need to be
                   4765:        buildlinked; however, it's not automatic, since e.g. GTK on
                   4766:        some systems pulls in the X libraries, so they will show up in
                   4767:        the <code class="filename">ldd</code> output, while on others (like OS
1.50      wiz      4768:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.49      wiz      4769:        used as a hint.</p></li>
1.47      wiz      4770: </ul></div>
                   4771: <p>
                   4772:       </p>
1.1       dsieger  4773: </div>
1.41      asau     4774: <div class="sect2">
1.1       dsieger  4775: <div class="titlepage"><div><div><h3 class="title">
1.26      wiz      4776: <a name="updating-buildlink-depends"></a>14.2.2. Updating
1.1       dsieger  4777:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      4778:       and
                   4779:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4780:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   4781: <p>These two variables differ in that one describes source
                   4782:       compatibility (API) and the other binary compatibility (ABI).
                   4783:       The difference is that a change in the API breaks compilation of
                   4784:       programs while changes in the ABI stop compiled programs from
                   4785:       running.</p>
                   4786: <p>Changes to the
1.27      wiz      4787:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      4788:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   4789:       very rarely. One possible reason is that all packages depending
                   4790:       on this already need a newer version. In case it is bumped see
                   4791:       the description below.</p>
                   4792: <p>The most common example of an ABI change is that the major
                   4793:       version of a shared library is increased. In this case,
                   4794:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4795:       should be adjusted to require at least the new package version.
                   4796:       Then the packages that depend on this package need their
                   4797:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   4798:       <code class="filename">buildlink3.mk</code> files, their
                   4799:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4800:       adjusted, too. This is needed so pkgsrc will require the correct
                   4801:       package dependency and not settle for an older one when building
                   4802:       the source.</p>
1.108     rillig   4803: <p>See <a class="xref" href="#dependencies" title="19.1.5. Handling dependencies">Section 19.1.5, &#8220;Handling dependencies&#8221;</a> for
1.26      wiz      4804:       more information about dependencies on other packages,
                   4805:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1       dsieger  4806:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   4807: <p>Please take careful consideration before adjusting
                   4808:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4809:       or
                   4810:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4811:       as we don't want to cause unneeded package deletions and
                   4812:       rebuilds.  In many cases, new versions of packages work just
                   4813:       fine with older dependencies.</p>
                   4814: <p>Also it is not needed to set
1.26      wiz      4815:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4816:       when it is identical to
1.1       dsieger  4817:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
                   4818: </div>
                   4819: </div>
1.41      asau     4820: <div class="sect1">
1.1       dsieger  4821: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   4822: <a name="writing-builtin.mk"></a>14.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1       dsieger  4823: <p>Some packages in pkgsrc install headers and libraries that
                   4824:       coincide with headers and libraries present in the base system.
                   4825:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   4826:       packages should also include a <code class="filename">builtin.mk</code>
                   4827:       file that includes the necessary checks to decide whether using
                   4828:       the built-in software or the pkgsrc software is
                   4829:     appropriate.</p>
                   4830: <p>The only requirements of a builtin.mk file for
                   4831:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.23      wiz      4832: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4833: <li class="listitem"><p>It should set
1.1       dsieger  4834:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4835:        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.1       dsieger  4836:        after it is included.</p></li>
1.23      wiz      4837: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1       dsieger  4838:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4839:        which is already set before the
                   4840:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.23      wiz      4841: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.1       dsieger  4842:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   4843:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   4844: </ol></div>
1.41      asau     4845: <div class="sect2">
1.1       dsieger  4846: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4847: <a name="anatomy-of-builtin.mk"></a>14.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.1       dsieger  4848: <p>The following is the recommended template for builtin.mk
                   4849:       files:</p>
                   4850: <pre class="programlisting">
                   4851: .if !defined(IS_BUILTIN.foo)
                   4852: #
                   4853: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   4854: # genuinely exists in the system or not.
                   4855: #
                   4856: IS_BUILTIN.foo?=        no
                   4857: 
                   4858: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   4859: # version can be determined.
                   4860: #
                   4861: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   4862: BUILTIN_PKG.foo?=       foo-1.0
                   4863: .  endif
                   4864: .endif  # IS_BUILTIN.foo
                   4865: 
                   4866: .if !defined(USE_BUILTIN.foo)
                   4867: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   4868: .  if defined(BUILTIN_PKG.foo)
                   4869: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   4870: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   4871: USE_BUILTIN.foo!=                                                       \
                   4872:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   4873:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   4874: .      endif
                   4875: .    endfor
                   4876: .  endif
                   4877: .endif  # USE_BUILTIN.foo
                   4878: 
                   4879: CHECK_BUILTIN.foo?=     no
                   4880: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   4881: #
                   4882: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   4883: # "yes" or "no".
                   4884: #
                   4885: .endif  # CHECK_BUILTIN.foo
                   4886: </pre>
                   4887: <p>The first section sets
                   4888:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4889:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   4890:       in the base system.  This should not be a base system software
                   4891:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23      wiz      4892:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.1       dsieger  4893:       included as part of the base system.  This variable is only
                   4894:       used internally within the <code class="filename">builtin.mk</code>
                   4895:       file.</p>
                   4896: <p>The second section sets
                   4897:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4898:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   4899:       system if it exists (if
                   4900:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4901:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.1       dsieger  4902:       within the <code class="filename">builtin.mk</code> file.</p>
                   4903: <p>The third section sets
                   4904:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4905:       and is <span class="emphasis"><em>required</em></span> in all
                   4906:       <code class="filename">builtin.mk</code> files.  The code in this
                   4907:       section must make the determination whether the built-in
                   4908:       software is adequate to satisfy the dependencies listed in
                   4909:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4910:       This is typically done by comparing
                   4911:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4912:       against each of the dependencies in
                   4913:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   4914:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4915:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   4916:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   4917:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4918:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.1       dsieger  4919:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4920:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.1       dsieger  4921:       that the built-in version of the software is similar enough to
                   4922:       be used as a replacement.</p>
                   4923: <p>The last section is guarded by
                   4924:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   4925:       and includes code that uses the value of
                   4926:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4927:       set in the previous section.  This typically includes, e.g.,
                   4928:       adding additional dependency restrictions and listing additional
                   4929:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   4930:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   4931: </div>
1.41      asau     4932: <div class="sect2">
1.1       dsieger  4933: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   4934: <a name="native-or-pkgsrc-preference"></a>14.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1       dsieger  4935: <p>When building packages, it's possible to choose whether to set
                   4936:        a global preference for using either the built-in (native)
                   4937:        version or the pkgsrc version of software to satisfy a
                   4938:        dependency.  This is controlled by setting
                   4939:        <code class="varname">PREFER_PKGSRC</code> and
                   4940:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.23      wiz      4941:        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.1       dsieger  4942:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   4943:        use the pkgsrc versions of software, while
                   4944:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   4945:        built-in versions.  Preferences are determined by the most
                   4946:        specific instance of the package in either
                   4947:        <code class="varname">PREFER_PKGSRC</code> or
                   4948:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   4949:        in neither or in both variables, then
                   4950:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   4951:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   4952:        using pkgsrc versions of software for all but the most basic
                   4953:       bits on a NetBSD system, you can set:</p>
                   4954: <pre class="programlisting">
                   4955: PREFER_PKGSRC=  yes
                   4956: PREFER_NATIVE=  getopt skey tcp_wrappers
                   4957: </pre>
                   4958: <p>A package <span class="emphasis"><em>must</em></span> have a
                   4959:       <code class="filename">builtin.mk</code>
                   4960:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   4961:       otherwise it is simply ignored in that list.</p>
1.117     sevan    4962: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
                   4963:       straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
                   4964:       bootstrap.
                   4965:       Switching between settings globally at a later date can introduce
                   4966:       complications with dependency resolution. This is caused by packages
                   4967:       built with the opposite preference being installed alongside each other.</p>
                   4968: <pre class="screen">
                   4969: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
                   4970: </pre>
1.1       dsieger  4971: </div>
                   4972: </div>
                   4973: </div>
1.41      asau     4974: <div class="chapter">
1.1       dsieger  4975: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   4976: <a name="pkginstall"></a>Chapter 15. The pkginstall framework</h2></div></div></div>
1.1       dsieger  4977: <div class="toc">
                   4978: <p><b>Table of Contents</b></p>
1.100     leot     4979: <dl class="toc">
1.6       rillig   4980: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">15.1. Files and directories outside the installation prefix</a></span></dt>
1.1       dsieger  4981: <dd><dl>
1.6       rillig   4982: <dt><span class="sect2"><a href="#dirs-outside-prefix">15.1.1. Directory manipulation</a></span></dt>
                   4983: <dt><span class="sect2"><a href="#files-outside-prefix">15.1.2. File manipulation</a></span></dt>
1.1       dsieger  4984: </dl></dd>
1.6       rillig   4985: <dt><span class="sect1"><a href="#conf-files">15.2. Configuration files</a></span></dt>
1.1       dsieger  4986: <dd><dl>
1.23      wiz      4987: <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.6       rillig   4988: <dt><span class="sect2"><a href="#conf-files-configure">15.2.2. Telling the software where configuration files are</a></span></dt>
                   4989: <dt><span class="sect2"><a href="#conf-files-patching">15.2.3. Patching installations</a></span></dt>
                   4990: <dt><span class="sect2"><a href="#conf-files-disable">15.2.4. Disabling handling of configuration files</a></span></dt>
                   4991: </dl></dd>
                   4992: <dt><span class="sect1"><a href="#rcd-scripts">15.3. System startup scripts</a></span></dt>
                   4993: <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>
                   4994: <dt><span class="sect1"><a href="#users-and-groups">15.4. System users and groups</a></span></dt>
                   4995: <dt><span class="sect1"><a href="#shells">15.5. System shells</a></span></dt>
                   4996: <dd><dl><dt><span class="sect2"><a href="#shells-disable">15.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   4997: <dt><span class="sect1"><a href="#fonts">15.6. Fonts</a></span></dt>
                   4998: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">15.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.1       dsieger  4999: </dl>
                   5000: </div>
                   5001: <p>This chapter describes the framework known as
                   5002: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41      asau     5003: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5004: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1       dsieger  5005:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5006: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1       dsieger  5007:     provided that packages are correctly designed.</p></li>
1.23      wiz      5008: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5009: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5010: <li class="listitem"><p>Registration of system shells.</p></li>
                   5011: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1       dsieger  5012: </ul></div>
                   5013: <p>The following sections inspect each of the above points in detail.</p>
                   5014: <p>You may be thinking that many of the things described here could be
                   5015: easily done with simple code in the package's post-installation target
                   5016: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5017: as the code in them is only executed when building from source.  Machines
                   5018: using binary packages could not benefit from it at all (as the code itself
                   5019: could be unavailable).  Therefore, the only way to achieve any of the items
                   5020: described above is by means of the installation scripts, which are
                   5021: automatically generated by pkginstall.</p>
1.41      asau     5022: <div class="sect1">
1.1       dsieger  5023: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5024: <a name="files-and-dirs-outside-prefix"></a>15.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1       dsieger  5025: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   5026: of files and directories that belong to a package.  The names used in it
                   5027: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   5028: which means that it cannot register files outside this directory (absolute
                   5029: path names are not allowed).  Despite this restriction, some packages need
                   5030: to install files outside this location; e.g., under
                   5031: <code class="filename">${VARBASE}</code> or
                   5032: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5033: is to create such files during installation time by using
                   5034: installation scripts.</p>
                   5035: <p>The generic installation scripts are shell scripts that can
                   5036: contain arbitrary code.  The list of scripts to execute is taken from
                   5037: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5038: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5039: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5040: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5041: commands, so they have the potential to create and manage files
                   5042: anywhere in the file system.</p>
                   5043: <p>Using these general installation files is not recommended, but
                   5044: may be needed in some special cases.  One reason for avoiding them is
                   5045: that the user has to trust the packager that there is no unwanted or
                   5046: simply erroneous code included in the installation script. Also,
                   5047: previously there were many similar scripts for the same functionality,
                   5048: and fixing a common error involved finding and changing all of
                   5049: them.</p>
                   5050: <p>The pkginstall framework offers another, standardized way.  It
                   5051: provides generic scripts to abstract the manipulation of such files
                   5052: and directories based on variables set in the package's
                   5053: <code class="filename">Makefile</code>.  The rest of this section describes
                   5054: these variables.</p>
1.41      asau     5055: <div class="sect2">
1.1       dsieger  5056: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5057: <a name="dirs-outside-prefix"></a>15.1.1. Directory manipulation</h3></div></div></div>
1.1       dsieger  5058: <p>The following variables can be set to request the creation of
                   5059: directories anywhere in the file system:</p>
1.41      asau     5060: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108     rillig   5061: <li class="listitem">
                   5062: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1       dsieger  5063:     contain a list of directories that should be created and should attempt
                   5064:     to be destroyed by the installation scripts.  The difference between
                   5065:     the two is that the latter prompts the administrator to remove any
                   5066:     directories that may be left after deinstallation (because they were
1.108     rillig   5067:     not empty), while the former does not.  Example:</p>
                   5068: <pre class="programlisting">
                   5069: MAKE_DIRS+=             ${VARBASE}/foo/private
                   5070: </pre>
                   5071: </li>
1.23      wiz      5072: <li class="listitem">
1.1       dsieger  5073: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5074:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5075:     which directories should be created and should attempt to be destroyed
                   5076:     by the installation scripts.  Each tuple holds the following values,
                   5077:     separated by spaces: the directory name, its owner, its group and its
                   5078:     numerical mode.  For example:</p>
                   5079: <pre class="programlisting">
1.108     rillig   5080: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5081:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  5082: </pre>
                   5083: <p>The difference between the two is exactly the same as their
                   5084:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5085: </li>
                   5086: </ul></div>
                   5087: </div>
1.41      asau     5088: <div class="sect2">
1.1       dsieger  5089: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5090: <a name="files-outside-prefix"></a>15.1.2. File manipulation</h3></div></div></div>
1.1       dsieger  5091: <p>Creating non-empty files outside the installation prefix is tricky
                   5092: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   5093: To overcome this problem, the only solution is to extract the file in the
                   5094: known place (i.e., inside the installation prefix) and copy it to the
                   5095: appropriate location during installation (done by the installation scripts
                   5096: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5097: file</em></span> in the following paragraphs, which describe the variables
                   5098: that can be used to automatically and consistently handle files outside the
                   5099: installation prefix:</p>
1.41      asau     5100: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5101: <li class="listitem">
1.1       dsieger  5102: <p><code class="varname">CONF_FILES</code> and
1.30      wiz      5103:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1       dsieger  5104:     During installation time, the master file is copied to the target one
                   5105:     if and only if the latter does not exist.  Upon deinstallation, the
                   5106:     target file is removed provided that it was not modified by the
                   5107:     installation.</p>
                   5108: <p>The difference between the two is that the latter prompts the
                   5109:     administrator to remove any files that may be left after
                   5110:     deinstallation (because they were not empty), while the former does
                   5111:     not.</p>
                   5112: </li>
1.23      wiz      5113: <li class="listitem">
1.1       dsieger  5114: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30      wiz      5115:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1       dsieger  5116:     files as well as their target locations.  For each of them, it also
                   5117:     specifies their owner, their group and their numeric permissions, in
                   5118:     this order.  For example:</p>
                   5119: <pre class="programlisting">
1.108     rillig   5120: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5121:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  5122: </pre>
                   5123: <p>The difference between the two is exactly the same as their
                   5124:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5125: </li>
                   5126: </ul></div>
                   5127: </div>
                   5128: </div>
1.41      asau     5129: <div class="sect1">
1.1       dsieger  5130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5131: <a name="conf-files"></a>15.2. Configuration files</h2></div></div></div>
1.1       dsieger  5132: <p>Configuration files are special in the sense that they are installed
                   5133: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5134: need special treatment during installation (most of which is automated by
                   5135: pkginstall).  The main concept you must bear in mind is that files marked
                   5136: as configuration files are automatically copied to the right place (somewhere
                   5137: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5138: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5139: be removed if they have local modifications.  This ensures that
                   5140: administrators never lose any custom changes they may have made.</p>
1.41      asau     5141: <div class="sect2">
1.1       dsieger  5142: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5143: <a name="conf-files-sysconfdir"></a>15.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1       dsieger  5144: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5145: specifies where configuration files shall be installed.  Its contents are
                   5146: set based upon the following variables:</p>
1.41      asau     5147: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5148: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1       dsieger  5149:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   5150:     be overridden by the user to point to his preferred location (e.g.,
                   5151:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   5152:     Packages must not use it directly.</p></li>
1.23      wiz      5153: <li class="listitem">
1.1       dsieger  5154: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5155:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5156:     for the package being built shall be installed.  The definition of this
                   5157:     variable only makes sense in the package's
                   5158:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   5159: <p>As an example, consider the Apache package,
1.120     sevan    5160:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
1.1       dsieger  5161:     configuration files under the
                   5162:     <code class="filename">httpd/</code> subdirectory of
                   5163:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5164:     Makefile.</p>
                   5165: </li>
1.23      wiz      5166: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1       dsieger  5167:     variable that holds this package's configuration directory (if
                   5168:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5169:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5170:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23      wiz      5171: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1       dsieger  5172:     directory where the configuration files for the package identified by
                   5173:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5174: </ul></div>
                   5175: <p>Based on the above variables, pkginstall determines the value of
                   5176: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5177: variable that can be used within a package to refer to its configuration
                   5178: directory.  The algorithm used to set its value is basically the
                   5179: following:</p>
1.23      wiz      5180: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5181: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1       dsieger  5182:     its value is used.</p></li>
1.23      wiz      5183: <li class="listitem"><p>If the previous variable is not defined but
1.1       dsieger  5184:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   5185:     <code class="filename">Makefile</code>, the resulting value is
                   5186:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23      wiz      5187: <li class="listitem"><p>Otherwise, it is set to
1.1       dsieger  5188:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   5189: </ol></div>
                   5190: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.16      jnemeth  5191: 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
                   5192: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5193: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1       dsieger  5194: </div>
1.41      asau     5195: <div class="sect2">
1.1       dsieger  5196: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5197: <a name="conf-files-configure"></a>15.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1       dsieger  5198: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5199: known place, you need to teach each package where it shall install its
                   5200: files.  In some cases you will have to patch the package Makefiles to
                   5201: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5202: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5203: generated files:</p>
                   5204: <pre class="programlisting">
                   5205: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   5206: </pre>
                   5207: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5208: for</em></span> its configuration files, not where they will be originally
                   5209: installed (although the difference is never explicit,
                   5210: unfortunately).</p>
                   5211: </div>
1.41      asau     5212: <div class="sect2">
1.1       dsieger  5213: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5214: <a name="conf-files-patching"></a>15.2.3. Patching installations</h3></div></div></div>
1.1       dsieger  5215: <p>As said before, pkginstall automatically handles configuration files.
                   5216: This means that <span class="strong"><strong>the packages themselves must not
                   5217: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   5218: directly</strong></span>.  Bad news is that many software installation scripts
                   5219: will, out of the box, mess with the contents of that directory.  So what is
                   5220: the correct procedure to fix this issue?</p>
                   5221: <p>You must teach the package (usually by manually patching it) to
                   5222: install any configuration files under the examples hierarchy,
                   5223: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5224: <code class="filename">PLIST</code> registers them and the administrator always
                   5225: has the original copies available.</p>
                   5226: <p>Once the required configuration files are in place (i.e., under the
                   5227: examples hierarchy), the pkginstall framework can use them as master copies
                   5228: during the package installation to update what is in
                   5229: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   5230: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.10      hubertf  5231: used.  Check out <a class="xref" href="#files-outside-prefix" title="15.1.2. File manipulation">Section 15.1.2, &#8220;File manipulation&#8221;</a> for information
1.1       dsieger  5232: about their syntax and their purpose.  Here is an example, taken from the
1.120     sevan    5233: <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.1       dsieger  5234: <pre class="programlisting">
                   5235: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5236: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   5237: </pre>
                   5238: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5239: package and has no meaning outside it.</p>
                   5240: </div>
1.41      asau     5241: <div class="sect2">
1.1       dsieger  5242: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5243: <a name="conf-files-disable"></a>15.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1       dsieger  5244: <p>The automatic copying of config files can be toggled by setting the
                   5245: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5246: installation.</p>
                   5247: </div>
                   5248: </div>
1.41      asau     5249: <div class="sect1">
1.1       dsieger  5250: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5251: <a name="rcd-scripts"></a>15.3. System startup scripts</h2></div></div></div>
1.1       dsieger  5252: <p>System startup scripts are special files because they must be
                   5253: installed in a place known by the underlying OS, usually outside the
1.10      hubertf  5254: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="15.1. Files and directories outside the installation prefix">Section 15.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.1       dsieger  5255: can be used.  However, pkginstall provides a special mechanism to handle
                   5256: these files.</p>
                   5257: <p>In order to provide system startup scripts, the package has
                   5258: to:</p>
1.23      wiz      5259: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5260: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1       dsieger  5261:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.120     sevan    5262:     <a href="http://cdn.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.1       dsieger  5263:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23      wiz      5264: <li class="listitem">
1.1       dsieger  5265: <p>Tell pkginstall to handle it, appending the name of the script,
                   5266:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5267:     Continuing the previous example:</p>
                   5268: <pre class="programlisting">
                   5269: RCD_SCRIPTS+=   cupsd
                   5270: </pre>
                   5271: </li>
                   5272: </ol></div>
                   5273: <p>Once this is done, pkginstall will do the following steps for each
                   5274: script in an automated fashion:</p>
1.23      wiz      5275: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5276: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1       dsieger  5277:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   5278:     variable.</p></li>
1.23      wiz      5279: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1       dsieger  5280:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   5281:     that this master file must be explicitly registered in the
                   5282:     <code class="filename">PLIST</code>.</p></li>
1.23      wiz      5283: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1       dsieger  5284:     from the examples hierarchy into the system-wide startup scripts
                   5285:     directory.</p></li>
                   5286: </ol></div>
1.41      asau     5287: <div class="sect2">
1.1       dsieger  5288: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5289: <a name="rcd-scripts-disable"></a>15.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1       dsieger  5290: <p>The automatic copying of config files can be toggled by setting the
                   5291: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5292: installation.  Note that the scripts will be always copied inside the
                   5293: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   5294: matter what the value of this variable is.</p>
                   5295: </div>
                   5296: </div>
1.41      asau     5297: <div class="sect1">
1.1       dsieger  5298: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5299: <a name="users-and-groups"></a>15.4. System users and groups</h2></div></div></div>
1.1       dsieger  5300: <p>If a package needs to create special users and/or groups during
                   5301: installation, it can do so by using the pkginstall framework.</p>
                   5302: <p>Users can be created by adding entries to the
                   5303: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5304: syntax:</p>
                   5305: <pre class="programlisting">
                   5306: user:group
                   5307: </pre>
                   5308: <p>Further specification of user details may be done by setting
                   5309: per-user variables.
                   5310: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5311: numeric UID for the user.
                   5312: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5313: user's description or comment.
                   5314: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5315: user's home directory, and defaults to
                   5316: <code class="filename">/nonexistent</code> if not specified.
                   5317: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   5318: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   5319: not specified.</p>
                   5320: <p>Similarly, groups can be created by adding entries to the
                   5321: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5322: <pre class="programlisting">
                   5323: group
                   5324: </pre>
                   5325: <p>The numeric GID of the group may be set by defining
                   5326: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5327: <p>If a package needs to create the users and groups at an earlier
1.116     wiz      5328: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   5329: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   5330: <code class="literal">pre-install</code> to indicate the phase before which the
                   5331: users and groups are created. In this case, the numeric UIDs and GIDs
                   5332: of the created users and groups are automatically hardcoded into the
                   5333: final installation scripts.</p>
1.1       dsieger  5334: </div>
1.41      asau     5335: <div class="sect1">
1.1       dsieger  5336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5337: <a name="shells"></a>15.5. System shells</h2></div></div></div>
1.1       dsieger  5338: <p>Packages that install system shells should register them in the shell
                   5339: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   5340: administrator.  This must be done from the installation scripts to keep
                   5341: binary packages working on any system.  pkginstall provides an easy way to
                   5342: accomplish this task.</p>
                   5343: <p>When a package provides a shell interpreter, it has to set the
                   5344: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5345: add some hooks to the installation scripts to handle it.  Consider the
1.120     sevan    5346: following example, taken from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
1.1       dsieger  5347: <pre class="programlisting">
                   5348: PKG_SHELL=      ${PREFIX}/bin/zsh
                   5349: </pre>
1.41      asau     5350: <div class="sect2">
1.1       dsieger  5351: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5352: <a name="shells-disable"></a>15.5.1. Disabling shell registration</h3></div></div></div>
1.1       dsieger  5353: <p>The automatic registration of shell interpreters can be disabled by
                   5354: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   5355: environment variable to <code class="literal">NO</code>.</p>
                   5356: </div>
                   5357: </div>
1.41      asau     5358: <div class="sect1">
1.1       dsieger  5359: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5360: <a name="fonts"></a>15.6. Fonts</h2></div></div></div>
1.1       dsieger  5361: <p>Packages that install X11 fonts should update the database files
                   5362: that index the fonts within each fonts directory.  This can easily be
                   5363: accomplished within the pkginstall framework.</p>
                   5364: <p>When a package installs X11 fonts, it must list the directories in
                   5365: which fonts are installed in the
                   5366: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23      wiz      5367: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5368: <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.1       dsieger  5369: installation scripts to run the appropriate commands to update the fonts
                   5370: database files within each of those directories.  For convenience, if the
                   5371: directory path is relative, it is taken to be relative to the package's
1.120     sevan    5372: installation prefix.  Consider the following example, taken from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.1       dsieger  5373: <pre class="programlisting">
1.67      wiz      5374: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       dsieger  5375: </pre>
1.41      asau     5376: <div class="sect2">
1.1       dsieger  5377: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5378: <a name="fonts-disable"></a>15.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1       dsieger  5379: <p>The automatic update of fonts databases can be disabled by
                   5380: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   5381: environment variable to <code class="literal">NO</code>.</p>
                   5382: </div>
                   5383: </div>
                   5384: </div>
1.41      asau     5385: <div class="chapter">
1.1       dsieger  5386: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5387: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
1.1       dsieger  5388: <div class="toc">
                   5389: <p><b>Table of Contents</b></p>
1.100     leot     5390: <dl class="toc">
1.6       rillig   5391: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
1.23      wiz      5392: <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.6       rillig   5393: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
1.7       rillig   5394: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.1       dsieger  5395: </dl>
                   5396: </div>
                   5397: <p>Many packages have the ability to be built to support different
                   5398: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5399: in pkgsrc that provides generic handling of those options that
                   5400: determine different ways in which the packages can be built.  It's
                   5401: possible for the user to specify exactly which sets of options will be
                   5402: built into a package or to allow a set of global default options
                   5403: apply.</p>
1.7       rillig   5404: <p>There are two broad classes of behaviors that one might want to
                   5405: control via options.  One is whether some particular feature is
                   5406: enabled in a program that will be built anyway, often by including or
                   5407: not including a dependency on some other package.  The other is
                   5408: whether or not an additional program will be built as part of the
                   5409: package.  Generally, it is better to make a split package for such
                   5410: additional programs instead of using options, because it enables
                   5411: binary packages to be built which can then be added separately.  For
                   5412: example, the foo package might have minimal dependencies (those
                   5413: packages without which foo doesn't make sense), and then the foo-gfoo
                   5414: package might include the GTK frontend program gfoo.  This is better
                   5415: than including a gtk option to foo that adds gfoo, because either that
                   5416: option is default, in which case binary users can't get foo without
                   5417: gfoo, or not default, in which case they can't get gfoo.  With split
                   5418: packages, they can install foo without having GTK, and later decide to
                   5419: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5420: source users too, avoiding the need for rebuilds.</p>
                   5421: <p>Plugins with widely varying dependencies should usually be split
                   5422: instead of options.</p>
                   5423: <p>It is often more work to maintain split packages, especially if
                   5424: the upstream package does not support this.  The decision of split
                   5425: vs. option should be made based on the likelihood that users will want
                   5426: or object to the various pieces, the size of the dependencies that are
                   5427: included, and the amount of work.</p>
                   5428: <p>A further consideration is licensing.  Non-free parts, or parts
                   5429: that depend on non-free dependencies (especially plugins) should
                   5430: almost always be split if feasible.</p>
1.41      asau     5431: <div class="sect1">
1.1       dsieger  5432: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5433: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
1.1       dsieger  5434: <p>Global default options are listed in
                   5435: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5436: that should be built into every package if that option is supported.
1.10      hubertf  5437: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  5438: </div>
1.41      asau     5439: <div class="sect1">
1.1       dsieger  5440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5441: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1       dsieger  5442: </h2></div></div></div>
                   5443: <p>The following example shows how
                   5444: <code class="filename">bsd.options.mk</code> should be used
                   5445: by the hypothetical ``wibble'' package, either in the package
                   5446: <code class="filename">Makefile</code>, or in a file,
                   5447: e.g. <code class="filename">options.mk</code>, that is included by the
                   5448: main package <code class="filename">Makefile</code>.</p>
                   5449: <pre class="programlisting">
                   5450: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5451: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5452: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5453: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5454: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5455: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5456: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5457: 
                   5458: .include "../../mk/bsd.prefs.mk"
                   5459: 
                   5460: # this package was previously named wibble2
                   5461: .if defined(PKG_OPTIONS.wibble2)
                   5462: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5463: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5464:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5465: .endif
                   5466: 
                   5467: .include "../../mk/bsd.options.mk"
                   5468: 
                   5469: # Package-specific option-handling
                   5470: 
                   5471: ###
                   5472: ### FOO support
                   5473: ###
                   5474: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5475: CONFIGURE_ARGS+=    --enable-foo
                   5476: .endif
                   5477: 
                   5478: ###
                   5479: ### LDAP support
                   5480: ###
                   5481: .if !empty(PKG_OPTIONS:Mldap)
                   5482: .  include "../../databases/openldap-client/buildlink3.mk"
                   5483: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5484: .endif
                   5485: 
                   5486: ###
                   5487: ### database support
                   5488: ###
                   5489: .if !empty(PKG_OPTIONS:Mmysql)
                   5490: .  include "../../mk/mysql.buildlink3.mk"
                   5491: .endif
                   5492: .if !empty(PKG_OPTIONS:Mpgsql)
                   5493: .  include "../../mk/pgsql.buildlink3.mk"
                   5494: .endif
                   5495: </pre>
                   5496: <p>The first section contains the information about which build
                   5497: options are supported by the package, and any default options settings
                   5498: if needed.</p>
1.23      wiz      5499: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5500: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.125     leot     5501: <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1       dsieger  5502: options.  It should be set to
                   5503: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5504: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5505: at the point where the options are processed.</p></li>
1.23      wiz      5506: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1       dsieger  5507: build options supported by the package.</p></li>
1.23      wiz      5508: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1       dsieger  5509: list of names of groups of mutually exclusive options.  The options in
                   5510: each group are listed in
                   5511: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5512: The most specific setting of any option from the group takes
                   5513: precedence over all other options in the group.  Options from the
                   5514: groups will be automatically added to
                   5515: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23      wiz      5516: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1       dsieger  5517: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5518: packages will fail if no option from the group is
                   5519: selected.</p></li>
1.23      wiz      5520: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1       dsieger  5521: of names of sets of options.  At least one option from each set must
                   5522: be selected.  The options in each set are listed in
                   5523: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5524: Options from the sets will be automatically added to
                   5525: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5526: fail if no option from the set is selected.</p></li>
1.23      wiz      5527: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1       dsieger  5528: build options which are enabled by default.</p></li>
1.23      wiz      5529: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1       dsieger  5530: of
1.23      wiz      5531: <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.10      hubertf  5532: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1       dsieger  5533: their option counterparts.  Pairs should be added with
1.23      wiz      5534: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.1       dsieger  5535: warning will be issued if the user uses a legacy
                   5536: variable.</p></li>
1.23      wiz      5537: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1       dsieger  5538: of
1.23      wiz      5539: <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.1       dsieger  5540: pairs that map options that have been renamed to their new
1.23      wiz      5541: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.1       dsieger  5542: the listing of global legacy options.  A warning will be issued if
                   5543: the user uses a legacy option.</p></li>
1.23      wiz      5544: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1       dsieger  5545: options implied by deprecated variables used.  This can be used for
                   5546: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5547: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5548: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23      wiz      5549: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1       dsieger  5550: a list of warnings about deprecated variables or options used, and
                   5551: what to use instead.</p></li>
                   5552: </ol></div>
                   5553: <p>A package should never modify
                   5554: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5555: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5556: To suggest a default set of options, use
                   5557: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5558: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5559: including <code class="filename">bsd.options.mk</code>.  If none of
                   5560: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5561: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5562: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5563: happen with platform-specific options if none of them is supported on
                   5564: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5565: empty list and the package is otherwise treated as not using the
                   5566: options framework.</p>
                   5567: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5568: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5569: build options, properly filtered to remove unsupported and duplicate
                   5570: options.</p>
                   5571: <p>The remaining sections contain the logic that is specific to
                   5572: each option.  The correct way to check for an option is to check
                   5573: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5574: <pre class="programlisting">
                   5575: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   5576: </pre>
                   5577: </div>
1.41      asau     5578: <div class="sect1">
1.1       dsieger  5579: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5580: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
1.1       dsieger  5581: <p>Options that enable similar features in different packages (like
                   5582: optional support for a library) should use a common name in all
                   5583: packages that support it (like the name of the library).  If another
                   5584: package already has an option with the same meaning, use the same
                   5585: name.</p>
                   5586: <p>Options that enable features specific to one package, where it's
                   5587: unlikely that another (unrelated) package has the same (or a similar)
                   5588: optional feature, should use a name prefixed with
                   5589: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5590: <p>If a group of related packages share an optional feature
                   5591: specific to that group, prefix it with the name of the
1.23      wiz      5592: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.1       dsieger  5593: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5594: <p>For new options, add a line to
                   5595: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5596: fields, separated by tab.  The first field is the option name, the
                   5597: second its description.  The description should be a whole sentence
                   5598: (starting with an uppercase letter and ending with a period) that
1.23      wiz      5599: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5600: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.1       dsieger  5601: </div>
1.41      asau     5602: <div class="sect1">
1.7       rillig   5603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5604: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
1.10      hubertf  5605: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7       rillig   5606: different dependencies based on the options with which the package was
                   5607: built. For querying these options, the file
                   5608: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5609: typical example looks like this:</p>
                   5610: <pre class="programlisting">
                   5611: pkgbase := libpurple
                   5612: .include "../../mk/pkg-build-options.mk"
                   5613: 
                   5614: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5615: ...
                   5616: .endif
                   5617: </pre>
                   5618: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5619: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5620: options of the libpurple package, which can then be queried like
                   5621: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5622: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5623: details.</p>
                   5624: </div>
1.1       dsieger  5625: </div>
1.41      asau     5626: <div class="chapter">
1.1       dsieger  5627: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   5628: <a name="build"></a>Chapter 17. The build process</h2></div></div></div>
1.1       dsieger  5629: <div class="toc">
                   5630: <p><b>Table of Contents</b></p>
1.100     leot     5631: <dl class="toc">
1.6       rillig   5632: <dt><span class="sect1"><a href="#build.intro">17.1. Introduction</a></span></dt>
                   5633: <dt><span class="sect1"><a href="#build.prefix">17.2. Program location</a></span></dt>
                   5634: <dt><span class="sect1"><a href="#build.builddirs">17.3. Directories used during the build process</a></span></dt>
                   5635: <dt><span class="sect1"><a href="#build.running">17.4. Running a phase</a></span></dt>
1.23      wiz      5636: <dt><span class="sect1"><a href="#build.fetch">17.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig   5637: <dd><dl>
                   5638: <dt><span class="sect2"><a href="#build.fetch.what">17.5.1. What to fetch and where to get it from</a></span></dt>
                   5639: <dt><span class="sect2"><a href="#build.fetch.how">17.5.2. How are the files fetched?</a></span></dt>
                   5640: </dl></dd>
1.23      wiz      5641: <dt><span class="sect1"><a href="#build.checksum">17.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   5642: <dt><span class="sect1"><a href="#build.extract">17.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   5643: <dt><span class="sect1"><a href="#build.patch">17.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   5644: <dt><span class="sect1"><a href="#build.tools">17.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   5645: <dt><span class="sect1"><a href="#build.wrapper">17.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   5646: <dt><span class="sect1"><a href="#build.configure">17.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   5647: <dt><span class="sect1"><a href="#build.build">17.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   5648: <dt><span class="sect1"><a href="#build.test">17.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   5649: <dt><span class="sect1"><a href="#build.install">17.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   5650: <dt><span class="sect1"><a href="#build.package">17.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
1.6       rillig   5651: <dt><span class="sect1"><a href="#build.clean">17.16. Cleaning up</a></span></dt>
                   5652: <dt><span class="sect1"><a href="#build.helpful-targets">17.17. Other helpful targets</a></span></dt>
1.1       dsieger  5653: </dl>
                   5654: </div>
1.41      asau     5655: <div class="sect1">
1.1       dsieger  5656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5657: <a name="build.intro"></a>17.1. Introduction</h2></div></div></div>
1.1       dsieger  5658: <p>This chapter gives a detailed description on how a package is
                   5659:     built. Building a package is separated into different
                   5660:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   5661:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18      snj      5662:     described in the following sections. Each phase is split into
1.1       dsieger  5663:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   5664:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   5665:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   5666:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   5667:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   5668: <p>Never override the regular targets (like
                   5669:     <code class="varname">fetch</code>), if you have to, override the
                   5670:     <code class="varname">do-*</code> ones instead.</p>
                   5671: <p>The basic steps for building a program are always the same.  First
                   5672:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   5673:     the local system and then extracted. After any pkgsrc-specific patches
                   5674:     to compile properly are applied, the software can be configured, then
                   5675:     built (usually by compiling), and finally the generated binaries, etc.
                   5676:     can be put into place on the system.</p>
                   5677: <p>To get more details about what is happening at each step,
                   5678:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   5679:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   5680:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   5681: </div>
1.41      asau     5682: <div class="sect1">
1.1       dsieger  5683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5684: <a name="build.prefix"></a>17.2. Program location</h2></div></div></div>
1.1       dsieger  5685: <p>Before outlining the process performed by the NetBSD package system in
                   5686:     the next section, here's a brief discussion on where programs are
                   5687:     installed, and which variables influence this.</p>
                   5688: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   5689:     where all files of the final program shall be installed. It is
                   5690:     usually set to <code class="varname">LOCALBASE</code>
                   5691:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   5692:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   5693:     <code class="varname">PREFIX</code> needs to be put
                   5694:     into the various places in the program's source where paths to
1.108     rillig   5695:     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.1       dsieger  5696: <p>When choosing which of these variables to use,
                   5697:     follow the following rules:</p>
1.41      asau     5698: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5699: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1       dsieger  5700:        where the current pkg will be installed.  When referring to a
                   5701:        pkg's own installation path, use
1.23      wiz      5702:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   5703: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1       dsieger  5704:        are installed.  If you need to construct a -I or -L argument
                   5705:        to the compiler to find includes and libraries installed by
1.23      wiz      5706:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.1       dsieger  5707:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   5708:        installed all packages in <code class="filename">/usr/local</code>. As
                   5709:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   5710:        administrator, this variable is a misnomer.</p></li>
1.23      wiz      5711: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1       dsieger  5712:        distribution (from xsrc, etc.) is installed. When looking for
                   5713:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23      wiz      5714:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.99      sevan    5715: <li class="listitem"><p>X11-based packages using imake must set
                   5716:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   5717:        <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5718: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.125     leot     5719:        install files according to <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1       dsieger  5720:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   5721:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   5722: </ul></div>
                   5723: </div>
1.41      asau     5724: <div class="sect1">
1.1       dsieger  5725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5726: <a name="build.builddirs"></a>17.3. Directories used during the build process</h2></div></div></div>
1.14      jmcneill 5727: <p>When building a package, various directories are used to store
1.1       dsieger  5728:     source files, temporary files, pkgsrc-internal files, and so on. These
                   5729:     directories are explained here.</p>
                   5730: <p>Some of the directory variables contain relative pathnames. There
                   5731:     are two common base directories for these relative directories:
                   5732:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   5733:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   5734:     inside the package itself.</p>
1.41      asau     5735: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  5736: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   5737: <dd><p>This is an absolute pathname that points to the pkgsrc
                   5738:       root directory. Generally, you don't need
                   5739:       it.</p></dd>
                   5740: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   5741: <dd><p>This is an absolute pathname that points to the
                   5742:       current package.</p></dd>
                   5743: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   5744: <dd><p>This is a pathname relative to
                   5745:       <code class="varname">PKGSRCDIR</code> that points to the current
                   5746:       package.</p></dd>
                   5747: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   5748: <dd><p>This is an absolute pathname pointing to the directory
                   5749:       where all work takes place. The distfiles are extracted to this
                   5750:       directory. It also contains temporary directories and log files used by
                   5751:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   5752:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   5753: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   5754: <dd><p>This is an absolute pathname pointing to the directory
                   5755:       where the distfiles are extracted. It is usually a direct subdirectory
                   5756:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   5757:       that isn't hidden. This variable may be changed by a package
                   5758:       <code class="filename">Makefile</code>.</p></dd>
                   5759: </dl></div>
1.14      jmcneill 5760: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   5761:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15      rillig   5762:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14      jmcneill 5763:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   5764:     If users would like to have their pkgsrc trees behave in a
                   5765:     read-only manner, then the value of
                   5766:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   5767:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  5768: </div>
1.41      asau     5769: <div class="sect1">
1.1       dsieger  5770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5771: <a name="build.running"></a>17.4. Running a phase</h2></div></div></div>
1.10      hubertf  5772: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1       dsieger  5773:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   5774:     phase. This will automatically run all phases that are required for this
                   5775:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.10      hubertf  5776:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1       dsieger  5777:     the package will be built, but not installed.</p>
                   5778: </div>
1.41      asau     5779: <div class="sect1">
1.1       dsieger  5780: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5781: <a name="build.fetch"></a>17.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  5782: <p>The first step in building a package is to fetch the
                   5783:     distribution files (distfiles) from the sites that are providing
                   5784:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   5785:     phase.</p>
1.41      asau     5786: <div class="sect2">
1.1       dsieger  5787: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5788: <a name="build.fetch.what"></a>17.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1       dsieger  5789: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   5790:       defines all URLs from where the distfile, whose name is
                   5791:       derived from the <code class="varname">DISTNAME</code> variable, is
                   5792:       fetched. The more complicated cases are described
                   5793:       below.</p>
                   5794: <p>The variable <code class="varname">DISTFILES</code> specifies
                   5795:       the list of distfiles that have to be fetched. Its value
1.66      asau     5796:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   5797:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1       dsieger  5798:       so that most packages don't need to define it at all.
                   5799:       <code class="varname">EXTRACT_SUFX</code> is
                   5800:       <code class="literal">.tar.gz</code> by default, but can be changed
                   5801:       freely. Note that if your package requires additional
                   5802:       distfiles to the default one, you cannot just append the
                   5803:       additional filenames using the <code class="literal">+=</code>
                   5804:       operator, but you have write for example:</p>
                   5805: <pre class="programlisting">
1.66      asau     5806: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1       dsieger  5807: </pre>
                   5808: <p>Each distfile is fetched from a list of sites, usually
                   5809:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   5810:       <code class="varname">DISTFILES</code> or multiple
                   5811:       <code class="varname">PATCHFILES</code> from different sites, you can
                   5812:       set
                   5813:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   5814:       to the list of URLs where the file
                   5815:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   5816:       (including the suffix) can be found.</p>
                   5817: <pre class="programlisting">
                   5818: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   5819: DISTFILES+=     foo-file.tar.gz
                   5820: SITES.foo-file.tar.gz= \
                   5821: http://www.somewhere.com/somehow/ \
                   5822: http://www.somewhereelse.com/mirror/somehow/
                   5823: </pre>
                   5824: <p>When actually fetching the distfiles, each item from
                   5825:       <code class="varname">MASTER_SITES</code> or
                   5826:       <code class="varname">SITES.*</code> gets the name of each distfile
                   5827:       appended to it, without an intermediate slash. Therefore,
                   5828:       all site values have to end with a slash or other separator
                   5829:       character. This allows for example to set
                   5830:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   5831:       that gets the name of the distfile as a parameter. In this
                   5832:       case, the definition would look like:</p>
                   5833: <pre class="programlisting">
                   5834: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   5835: </pre>
1.22      jakllsch 5836: <p> The exception to this rule are URLs starting with a dash.
1.66      asau     5837:       In that case the URL is taken as is, fetched and the result
                   5838:       stored under the name of the distfile. You can use this style
                   5839:       for the case when the download URL style does not match the
                   5840:       above common case. For example, if permanent download URL is a
                   5841:       redirector to the real download URL, or the download file name
                   5842:       is offered by an HTTP Content-Disposition header. In the
                   5843:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   5844:       created instead of the default
                   5845:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   5846: <pre class="programlisting">
                   5847: DISTNAME=       foo-1.0.0
                   5848: MASTER_SITES=   -http://www.example.com/archive/v1.0.0.tar.gz
                   5849: </pre>
1.1       dsieger  5850: <p>There are some predefined values for
                   5851:       <code class="varname">MASTER_SITES</code>, which can be used in
                   5852:       packages.  The names of the variables should speak for
                   5853:       themselves.</p>
                   5854: <pre class="programlisting">
                   5855: ${MASTER_SITE_APACHE}
                   5856: ${MASTER_SITE_BACKUP}
                   5857: ${MASTER_SITE_CYGWIN}
                   5858: ${MASTER_SITE_DEBIAN}
                   5859: ${MASTER_SITE_FREEBSD}
                   5860: ${MASTER_SITE_FREEBSD_LOCAL}
                   5861: ${MASTER_SITE_GENTOO}
                   5862: ${MASTER_SITE_GNOME}
                   5863: ${MASTER_SITE_GNU}
                   5864: ${MASTER_SITE_GNUSTEP}
1.66      asau     5865: ${MASTER_SITE_HASKELL_HACKAGE}
1.1       dsieger  5866: ${MASTER_SITE_IFARCHIVE}
                   5867: ${MASTER_SITE_KDE}
                   5868: ${MASTER_SITE_MOZILLA}
1.66      asau     5869: ${MASTER_SITE_MOZILLA_ALL}
                   5870: ${MASTER_SITE_MOZILLA_ESR}
1.1       dsieger  5871: ${MASTER_SITE_MYSQL}
1.66      asau     5872: ${MASTER_SITE_NETLIB}
1.1       dsieger  5873: ${MASTER_SITE_OPENOFFICE}
1.98      ryoon    5874: ${MASTER_SITE_OSDN}
1.1       dsieger  5875: ${MASTER_SITE_PERL_CPAN}
                   5876: ${MASTER_SITE_PGSQL}
1.66      asau     5877: ${MASTER_SITE_RUBYGEMS}
1.1       dsieger  5878: ${MASTER_SITE_R_CRAN}
                   5879: ${MASTER_SITE_SOURCEFORGE}
                   5880: ${MASTER_SITE_SUNSITE}
                   5881: ${MASTER_SITE_SUSE}
                   5882: ${MASTER_SITE_TEX_CTAN}
                   5883: ${MASTER_SITE_XCONTRIB}
                   5884: ${MASTER_SITE_XEMACS}
1.66      asau     5885: ${MASTER_SITE_XORG}
1.1       dsieger  5886: </pre>
                   5887: <p>Some explanations for the less self-explaining ones:
                   5888:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26      wiz      5889:       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.25      spz      5890:       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.1       dsieger  5891: <p>If you choose one of these predefined sites, you may
                   5892:       want to specify a subdirectory of that site. Since these
                   5893:       macros may expand to more than one actual site, you
                   5894:       <span class="emphasis"><em>must</em></span> use the following construct to
                   5895:       specify a subdirectory:</p>
                   5896: <pre class="programlisting">
                   5897: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   5898: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   5899: </pre>
                   5900: <p>Note the trailing slash after the subdirectory
                   5901:       name.</p>
                   5902: </div>
1.41      asau     5903: <div class="sect2">
1.1       dsieger  5904: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   5905: <a name="build.fetch.how"></a>17.5.2. How are the files fetched?</h3></div></div></div>
1.1       dsieger  5906: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   5907:       all the distfiles exist in a local directory
                   5908:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   5909:       user). If the files do not exist, they are fetched using
                   5910:       commands of the form</p>
                   5911: <pre class="programlisting">
                   5912: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   5913: </pre>
                   5914: <p>where <code class="literal">${site}</code> varies through
                   5915:       several possibilities in turn: first,
                   5916:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   5917:       sites specified in either <code class="varname">SITES.file</code> if
                   5918:       defined, else <code class="varname">MASTER_SITES</code> or
                   5919:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   5920:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   5921:       all except the first and the last can be optionally sorted
                   5922:       by the user, via setting either
                   5923:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   5924:       <code class="varname">MASTER_SORT_AWK</code> or
                   5925:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16      jnemeth  5926: <p> The specific command and arguments used depend on the
                   5927:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   5928:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.1       dsieger  5929: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   5930:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   5931:       distfiles, if they are freely distributable.  Packages setting
                   5932:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23      wiz      5933:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.1       dsieger  5934:       mirrored.</p>
                   5935: </div>
                   5936: </div>
1.41      asau     5937: <div class="sect1">
1.1       dsieger  5938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5939: <a name="build.checksum"></a>17.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1       dsieger  5940: <p>After the distfile(s) are fetched, their checksum is
                   5941:     generated and compared with the checksums stored in the
                   5942:     distinfo file. If the checksums don't match, the build is
                   5943:     aborted. This is to ensure the same distfile is used for
                   5944:     building, and that the distfile wasn't changed, e.g. by some
                   5945:     malign force, deliberately changed distfiles on the master
                   5946:     distribution site or network lossage.</p>
                   5947: </div>
1.41      asau     5948: <div class="sect1">
1.1       dsieger  5949: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5950: <a name="build.extract"></a>17.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1       dsieger  5951: <p>When the distfiles are present on the local system, they
                   5952:     need to be extracted, as they usually come in the form of some
                   5953:     compressed archive format.</p>
                   5954: <p>By default, all <code class="varname">DISTFILES</code> are
                   5955:     extracted. If you only need some of them, you can set the
                   5956:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   5957:     files.</p>
                   5958: <p>Extracting the files is usually done by a little
                   5959:     program, <code class="filename">mk/extract/extract</code>, which
                   5960:     already knows how to extract various archive formats, so most
                   5961:     likely you will not need to change anything here. But if you
                   5962:     need, the following variables may help you:</p>
1.41      asau     5963: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  5964: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   5965: <dd><p>Use these variables to override the default
                   5966:       options for an extract command, which are defined in
                   5967:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   5968: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   5969: <dd><p>This variable can be set to
1.14      jmcneill 5970:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   5971:       (which is the default value), <code class="literal">pax</code>, or an
1.1       dsieger  5972:       absolute pathname pointing to the command with which tar
1.14      jmcneill 5973:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   5974:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  5975: </dl></div>
                   5976: <p>If the <code class="filename">extract</code> program doesn't
                   5977:     serve your needs, you can also override the
                   5978:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   5979:     command used for extracting the files. This command is
                   5980:     executed in the <code class="filename">${WRKSRC}</code>
                   5981:     directory. During execution of this command, the shell
                   5982:     variable <code class="varname">extract_file</code> holds the absolute
                   5983:     pathname of the file that is going to be extracted.</p>
                   5984: <p>And if that still does not suffice, you can override the
                   5985:     <code class="varname">do-extract</code> target in the package
                   5986:     Makefile.</p>
                   5987: </div>
1.41      asau     5988: <div class="sect1">
1.1       dsieger  5989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   5990: <a name="build.patch"></a>17.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1       dsieger  5991: <p>After extraction, all the patches named by the
                   5992:     <code class="varname">PATCHFILES</code>, those present in the patches
                   5993:     subdirectory of the package as well as in
                   5994:     $LOCALPATCHES/$PKGPATH (e.g.
                   5995:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   5996:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   5997:     <code class="filename">.gz</code> are uncompressed before they are
                   5998:     applied, files ending in <code class="filename">.orig</code> or
                   5999:     <code class="filename">.rej</code> are ignored. Any special options to
1.125     leot     6000:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.108     rillig   6001:     <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.125     leot     6002: <p>By default <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1       dsieger  6003:     it fail if the patches apply with some lines of fuzz. Please
                   6004:     fix (regen) the patches so that they apply cleanly. The
                   6005:     rationale behind this is that patches that don't apply cleanly
                   6006:     may end up being applied in the wrong place, and cause severe
                   6007:     harm there.</p>
                   6008: </div>
1.41      asau     6009: <div class="sect1">
1.1       dsieger  6010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6011: <a name="build.tools"></a>17.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
1.10      hubertf  6012: <p>This is covered in <a class="xref" href="#tools" title="Chapter 18. Tools needed for building or running">Chapter 18, <i>Tools needed for building or running</i></a>.
1.1       dsieger  6013:     </p>
                   6014: </div>
1.41      asau     6015: <div class="sect1">
1.1       dsieger  6016: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6017: <a name="build.wrapper"></a>17.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1       dsieger  6018: <p>This phase creates wrapper programs for the compilers and
                   6019:     linkers. The following variables can be used to tweak the
                   6020:     wrappers.</p>
1.41      asau     6021: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6022: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6023: <dd><p>The command used to print progress
                   6024:       messages. Does nothing by default. Set to
                   6025:       <code class="literal">${ECHO}</code> to see the progress
                   6026:       messages.</p></dd>
                   6027: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6028: <dd><p>This variable can be set to
                   6029:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6030:       depending on whether you want additional information in the
                   6031:       wrapper log file.</p></dd>
                   6032: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6033: <dd><p>This variable can be set to
                   6034:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6035:       on whether the wrapper should use its cache, which will
                   6036:       improve the speed. The default value is
                   6037:       <code class="literal">yes</code>, but is forced to
                   6038:       <code class="literal">no</code> if the platform does not support
                   6039:       it.</p></dd>
                   6040: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   6041: <dd><p>A list of reordering commands. A reordering
                   6042:       command has the form
                   6043:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6044:       It ensures that that
                   6045:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6046:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6047:       </p></dd>
                   6048: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6049: <dd><p>A list of transformation commands. [TODO:
                   6050:       investigate further]</p></dd>
                   6051: </dl></div>
                   6052: </div>
1.41      asau     6053: <div class="sect1">
1.1       dsieger  6054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6055: <a name="build.configure"></a>17.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  6056: <p>Most pieces of software need information on the header
                   6057:     files, system calls, and library routines which are available
                   6058:     on the platform they run on. The process of determining this
                   6059:     information is known as configuration, and is usually
                   6060:     automated. In most cases, a script is supplied with the
                   6061:     distfiles, and its invocation results in generation of header
                   6062:     files, Makefiles, etc.</p>
                   6063: <p>If the package contains a configure script, this can be
                   6064:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23      wiz      6065:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.1       dsieger  6066:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23      wiz      6067:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.1       dsieger  6068:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6069: <pre class="programlisting">
                   6070: .for d in ${CONFIGURE_DIRS}
                   6071:         cd ${WRKSRC} \
                   6072:         &amp;&amp; cd ${d} \
                   6073:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6074: .endfor
                   6075: </pre>
                   6076: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23      wiz      6077:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6078:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6079:     configure script is run with the environment
                   6080:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6081:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6082:     <code class="varname">CONFIGURE_ENV</code>,
                   6083:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23      wiz      6084:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.1       dsieger  6085:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6086:     package.</p>
1.37      wiz      6087: <p>If the program uses the Perl way of configuration (mainly Perl
                   6088:     modules, but not only), i.e. a file called
                   6089:     <code class="filename">Makefile.PL</code>, it should include
                   6090:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6091:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6092:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1       dsieger  6093: <p>If the program uses an <code class="filename">Imakefile</code>
                   6094:     for configuration, the appropriate steps can be invoked by
                   6095:     setting <code class="varname">USE_IMAKE</code> to
1.99      sevan    6096:     <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>.
                   6097:     You can add variables to xmkmf's environment by adding them to the
1.1       dsieger  6098:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11      rillig   6099: <p>If the program uses <code class="filename">cmake</code>
                   6100:     for configuration, the appropriate steps can be invoked by
1.23      wiz      6101:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.11      rillig   6102:     You can add variables to cmake's environment by adding them to the
                   6103:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6104:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6105:     The top directory argument is given by the
                   6106:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23      wiz      6107:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1       dsieger  6108: <p>If there is no configure step at all, set
1.23      wiz      6109:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6110: </div>
1.41      asau     6111: <div class="sect1">
1.1       dsieger  6112: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6113: <a name="build.build"></a>17.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  6114: <p>For building a package, a rough equivalent of the
                   6115:     following code is executed.</p>
                   6116: <pre class="programlisting">
                   6117: .for d in ${BUILD_DIRS}
                   6118:         cd ${WRKSRC} \
                   6119:         &amp;&amp; cd ${d} \
                   6120:         &amp;&amp; env ${MAKE_ENV} \
                   6121:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6122:                 -f ${MAKE_FILE} \
                   6123:                 ${BUILD_TARGET}
                   6124: .endfor
                   6125: </pre>
                   6126: <p><code class="varname">BUILD_DIRS</code> (default:
1.23      wiz      6127:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6128:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6129:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6130:     <code class="varname">MAKE_ENV</code> and arguments
                   6131:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6132:     <code class="varname">MAKE_ENV</code>,
                   6133:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6134:     <code class="varname">MAKE_FILE</code> and
                   6135:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6136:     package.</p>
                   6137: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23      wiz      6138:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6139:     <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.1       dsieger  6140:     default value of <code class="varname">MAKE_FILE</code> is
1.23      wiz      6141:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6142:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.1       dsieger  6143: <p>If there is no build step at all, set
1.23      wiz      6144:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6145: </div>
1.41      asau     6146: <div class="sect1">
1.1       dsieger  6147: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6148: <a name="build.test"></a>17.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1       dsieger  6149: <p>[TODO]</p>
                   6150: </div>
1.41      asau     6151: <div class="sect1">
1.1       dsieger  6152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6153: <a name="build.install"></a>17.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  6154: <p>Once the build stage has completed, the final step is to
                   6155:     install the software in public directories, so users can
                   6156:     access the programs and files.</p>
                   6157: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   6158:     equivalent of the following code is executed. Additionally,
                   6159:     before and after this code, much magic is performed to do
                   6160:     consistency checks, registering the package, and so on.</p>
                   6161: <pre class="programlisting">
                   6162: .for d in ${INSTALL_DIRS}
                   6163:         cd ${WRKSRC} \
                   6164:         &amp;&amp; cd ${d} \
                   6165:         &amp;&amp; env ${MAKE_ENV} \
                   6166:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6167:                 -f ${MAKE_FILE} \
                   6168:                 ${INSTALL_TARGET}
                   6169: .endfor
                   6170: </pre>
                   6171: <p>The variable's meanings are analogous to the ones in the
                   6172:     <span class="emphasis"><em>build</em></span> phase.
                   6173:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6174:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23      wiz      6175:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6176:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.1       dsieger  6177:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6178:     defined.</p>
                   6179: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   6180:     variables are useful. They are all variations of the
1.125     leot     6181:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1       dsieger  6182:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6183:     install command. The specialized variants, together with their
                   6184:     intended use, are:</p>
1.41      asau     6185: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6186: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   6187: <dd><p>directories that contain
                   6188:       binaries</p></dd>
                   6189: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   6190: <dd><p>directories that contain
                   6191:       scripts</p></dd>
                   6192: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   6193: <dd><p>directories that contain shared and static
                   6194:       libraries</p></dd>
                   6195: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   6196: <dd><p>directories that contain data
                   6197:       files</p></dd>
                   6198: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   6199: <dd><p>directories that contain man
                   6200:       pages</p></dd>
1.100     leot     6201: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6202: <dd><p>directories that contain data files for games
                   6203:       </p></dd>
1.1       dsieger  6204: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   6205: <dd><p>binaries that can be stripped from debugging
                   6206:       symbols</p></dd>
                   6207: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   6208: <dd><p>binaries that cannot be
                   6209:       stripped</p></dd>
                   6210: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   6211: <dd><p>game
                   6212:       binaries</p></dd>
                   6213: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   6214: <dd><p>shared and static
                   6215:       libraries</p></dd>
                   6216: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6217: <dd><p>data files</p></dd>
                   6218: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   6219: <dd><p>data files for
                   6220:       games</p></dd>
                   6221: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6222: <dd><p>man pages</p></dd>
                   6223: </dl></div>
                   6224: <p>Some other variables are:</p>
1.41      asau     6225: <div class="variablelist"><dl class="variablelist">
1.106     tnn      6226: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.125     leot     6227: <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.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.106     tnn      6228:       when installing binaries. Any debugging sections and symbols present in
                   6229:       binaries will be preserved.
                   6230:       </p></dd>
1.1       dsieger  6231: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6232: <dd><p>A list of directories relative to
                   6233:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   6234:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6235:       The package is supposed to create all needed directories itself
                   6236:       before installing files to it and list all other directories here.
                   6237:       </p></dd>
                   6238: </dl></div>
                   6239: <p>In the rare cases that a package shouldn't install anything,
1.23      wiz      6240:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.1       dsieger  6241:     mostly relevant for packages in the <code class="filename">regress</code>
                   6242:     category.</p>
                   6243: </div>
1.41      asau     6244: <div class="sect1">
1.1       dsieger  6245: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6246: <a name="build.package"></a>17.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1       dsieger  6247: <p>Once the install stage has completed, a binary package of
                   6248:     the installed files can be built.  These binary packages can be
                   6249:     used for quick installation without previous compilation, e.g. by
1.10      hubertf  6250:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6251:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.1       dsieger  6252: <p>By default, the binary packages are created in
                   6253:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6254:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6255:     one for each category in the <code class="varname">CATEGORIES</code>
                   6256:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6257:     <code class="filename">pkgsrc/packages</code>.</p>
                   6258: </div>
1.41      asau     6259: <div class="sect1">
1.1       dsieger  6260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6261: <a name="build.clean"></a>17.16. Cleaning up</h2></div></div></div>
1.1       dsieger  6262: <p>Once you're finished with a package, you can clean the work
1.10      hubertf  6263:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.1       dsieger  6264:     to clean the work directories of all dependencies too, use
1.10      hubertf  6265:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  6266: </div>
1.41      asau     6267: <div class="sect1">
1.1       dsieger  6268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6269: <a name="build.helpful-targets"></a>17.17. Other helpful targets</h2></div></div></div>
1.41      asau     6270: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6271: <dt><span class="term">pre/post-*</span></dt>
                   6272: <dd><p>For any of the main targets described in the
                   6273:          previous section, two auxiliary targets exist with
1.23      wiz      6274:          <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.1       dsieger  6275:          prefix for the main target's name.  These targets are
                   6276:          invoked before and after the main target is called,
                   6277:          allowing extra configuration or installation steps be
                   6278:          performed from a package's Makefile, for example, which
                   6279:          a program's configure script or install target
                   6280:          omitted.</p></dd>
                   6281: <dt><span class="term">do-*</span></dt>
                   6282: <dd><p>Should one of the main targets do the wrong thing,
                   6283:          and should there be no variable to fix this, you can
                   6284:          redefine it with the do-* target.  (Note that redefining
                   6285:          the target itself instead of the do-* target is a bad
                   6286:          idea, as the pre-* and post-* targets won't be called
                   6287:          anymore, etc.) You will not usually need to do
                   6288:          this.</p></dd>
                   6289: <dt><span class="term">reinstall</span></dt>
                   6290: <dd>
1.10      hubertf  6291: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1       dsieger  6292:          you noticed some file was not installed properly, you
                   6293:          can repeat the installation with this target, which will
1.23      wiz      6294:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.1       dsieger  6295: <p>This is the default value of
                   6296:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10      hubertf  6297:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1       dsieger  6298:          package</strong></span>, where the defaults are
1.23      wiz      6299:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
1.1       dsieger  6300:          respectively.</p>
                   6301: </dd>
                   6302: <dt><span class="term">deinstall</span></dt>
                   6303: <dd>
1.125     leot     6304: <p>This target does a <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1       dsieger  6305:          current directory, effectively de-installing the
                   6306:          package. The following variables can be used to tune the
                   6307:          behaviour:</p>
1.41      asau     6308: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6309: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.125     leot     6310: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1       dsieger  6311: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   6312: <dd><p>Remove all packages that require (depend on)
                   6313:                the given package.  This can be used to remove any
                   6314:                packages that may have been pulled in by a given
1.10      hubertf  6315:                package, e.g. if <span class="command"><strong>make deinstall
1.1       dsieger  6316:                DEINSTALLDEPENDS=1</strong></span> is done in
                   6317:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6318:                likely to remove whole KDE. Works by adding
1.125     leot     6319:                <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.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1       dsieger  6320:                command line.</p></dd>
                   6321: </dl></div>
                   6322: </dd>
                   6323: <dt><span class="term">bin-install</span></dt>
                   6324: <dd><p>Install a binary package from local disk and via FTP
                   6325:          from a list of sites (see the
                   6326:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.10      hubertf  6327:          <span class="command"><strong>make package</strong></span> if no binary package is
1.1       dsieger  6328:          available anywhere.  The arguments given to
1.10      hubertf  6329:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.1       dsieger  6330:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6331:          operation, etc.</p></dd>
1.95      wiz      6332: <dt><span class="term">install-clean</span></dt>
                   6333: <dd><p>This target removes the state files for the "install" and later
                   6334:          phases so that the "install" target may be re-invoked. This can be
                   6335:          used after editing the PLIST to install the package without
                   6336:          rebuilding it.</p></dd>
                   6337: <dt><span class="term">build-clean</span></dt>
                   6338: <dd><p>This target removes the state files for the "build" and later
                   6339:          phases so that the "build" target may be re-invoked.</p></dd>
1.1       dsieger  6340: <dt><span class="term">update</span></dt>
                   6341: <dd>
                   6342: <p>This target causes the current package to be
                   6343:          updated to the latest version.  The package and all
                   6344:          depending packages first get de-installed, then current
                   6345:          versions of the corresponding packages get compiled and
                   6346:          installed.  This is similar to manually noting which
                   6347:          packages are currently installed, then performing a
1.10      hubertf  6348:          series of <span class="command"><strong>make deinstall</strong></span> and
                   6349:          <span class="command"><strong>make install</strong></span> (or whatever
1.1       dsieger  6350:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   6351:          packages.</p>
1.23      wiz      6352: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.10      hubertf  6353:          resume package updating in case a previous <span class="command"><strong>make
1.1       dsieger  6354:          update</strong></span> was interrupted for some reason.
                   6355:          However, in this case, make sure you don't call
1.10      hubertf  6356:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1       dsieger  6357:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   6358:          Otherwise, you lose the ability to automatically update
                   6359:          the current package along with the dependent packages
                   6360:          you have installed.</p>
1.10      hubertf  6361: <p>Resuming an interrupted <span class="command"><strong>make
1.1       dsieger  6362:          update</strong></span> will only work as long as the package
                   6363:          tree remains unchanged.  If the source code for one of
                   6364:          the packages to be updated has been changed, resuming
1.10      hubertf  6365:          <span class="command"><strong>make update</strong></span> will most certainly
1.1       dsieger  6366:          fail!</p>
                   6367: <p>The following variables can be used either on the
1.10      hubertf  6368:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   6369:          alter the behaviour of <span class="command"><strong>make
1.1       dsieger  6370:          update</strong></span>:</p>
1.41      asau     6371: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6372: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   6373: <dd><p>Install target to recursively use for the
                   6374:                updated package and the dependent packages.
                   6375:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23      wiz      6376:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.10      hubertf  6377:                <span class="command"><strong>make update</strong></span>.  Other good
1.23      wiz      6378:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   6379:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   6380:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.1       dsieger  6381:                endless loop!</p></dd>
                   6382: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   6383: <dd><p>Don't clean up after updating.  Useful if
                   6384:                you want to leave the work sources of the updated
                   6385:                packages around for inspection or other purposes.
                   6386:                Be sure you eventually clean up the source tree
1.23      wiz      6387:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.1       dsieger  6388:                or you may run into troubles with old source code
                   6389:                still lying around on your next
1.10      hubertf  6390:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1       dsieger  6391:                update</strong></span>.</p></dd>
                   6392: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   6393: <dd><p>Deinstall each package before installing
                   6394:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   6395:                may be necessary if the
1.23      wiz      6396:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.10      hubertf  6397:                called after interrupting a running <span class="command"><strong>make
1.1       dsieger  6398:                update</strong></span>.</p></dd>
                   6399: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   6400: <dd><p>Allows you to disable recursion and hardcode
                   6401:                the target for packages.  The default is
1.23      wiz      6402:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.1       dsieger  6403:                facilitating a recursive update of prerequisite
                   6404:                packages.  Only set
                   6405:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   6406:                disable recursive updates. Use
                   6407:                <code class="varname">UPDATE_TARGET</code> instead to just
                   6408:                set a specific target for each package to be
1.10      hubertf  6409:                installed during <span class="command"><strong>make update</strong></span>
1.1       dsieger  6410:                (see above).</p></dd>
                   6411: </dl></div>
                   6412: </dd>
                   6413: <dt><span class="term">clean-update</span></dt>
                   6414: <dd>
                   6415: <p>Clean the source tree for all packages that would
1.10      hubertf  6416:          get updated if <span class="command"><strong>make update</strong></span> was called
1.1       dsieger  6417:          from the current directory.  This target should not be
                   6418:          used if the current package (or any of its depending
                   6419:          packages) have already been de-installed (e.g., after
1.10      hubertf  6420:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1       dsieger  6421:          some packages you intended to update. As a rule of
                   6422:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10      hubertf  6423:          the first time you run <span class="command"><strong>make update</strong></span>
1.1       dsieger  6424:          and only if you have a dirty package tree (e.g., if you
                   6425:          used <code class="varname">NOCLEAN</code>).</p>
                   6426: <p>If you are unsure about whether your tree is
1.10      hubertf  6427:          clean, you can either perform a <span class="command"><strong>make
1.1       dsieger  6428:          clean</strong></span> at the top of the tree, or use the
                   6429:          following sequence of commands from the directory of the
                   6430:          package you want to update (<span class="emphasis"><em>before</em></span>
1.10      hubertf  6431:          running <span class="command"><strong>make update</strong></span> for the first
1.1       dsieger  6432:          time, otherwise you lose all the packages you wanted to
                   6433:          update!):</p>
                   6434: <pre class="screen">
                   6435: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   6436: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   6437: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   6438:          </pre>
                   6439: <p>The following variables can be used either on the
1.10      hubertf  6440:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   6441:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.41      asau     6442: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6443: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10      hubertf  6444: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1       dsieger  6445:                reconstruct the list of directories to update for
1.10      hubertf  6446:                this package.  Only use this if <span class="command"><strong>make
1.1       dsieger  6447:                update</strong></span> successfully installed all
                   6448:                packages you wanted to update.  Normally, this is
1.10      hubertf  6449:                done automatically on <span class="command"><strong>make
1.1       dsieger  6450:                update</strong></span>, but may have been suppressed by
                   6451:                the <code class="varname">NOCLEAN</code> variable (see
                   6452:                above).</p></dd>
                   6453: </dl></div>
                   6454: </dd>
                   6455: <dt><span class="term">replace</span></dt>
                   6456: <dd>
                   6457: <p>Update the installation of the current package.  This
                   6458:          differs from update in that it does not replace dependent
1.120     sevan    6459:          packages.  You will need to install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
1.1       dsieger  6460:          target to work.</p>
                   6461: <p><span class="emphasis"><em>Be careful when using this
                   6462:          target!</em></span> There are no guarantees that dependent
                   6463:          packages will still work, in particular they will most
1.10      hubertf  6464:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1       dsieger  6465:          library package whose shared library major version changed
                   6466:          between your installed version and the new one.  For this
                   6467:          reason, this target is not officially supported and only
                   6468:          recommended for advanced users.</p>
                   6469: </dd>
                   6470: <dt><span class="term">info</span></dt>
1.125     leot     6471: <dd><p>This target invokes <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1       dsieger  6472:          package. You can use this to check which version of a
                   6473:          package is installed.</p></dd>
                   6474: <dt><span class="term">index</span></dt>
                   6475: <dd>
                   6476: <p>This is a top-level command, i.e. it should be used in
                   6477:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   6478:          database of all packages in the local pkgsrc tree, including
                   6479:          dependencies, comment, maintainer, and some other useful
                   6480:          information.  Individual entries are created by running
1.10      hubertf  6481:          <span class="command"><strong>make describe</strong></span> in the packages'
1.1       dsieger  6482:          directories.  This index file is saved as
                   6483:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.10      hubertf  6484:          verbose format by running <span class="command"><strong>make
1.1       dsieger  6485:          print-index</strong></span>.  You can search in it with
1.10      hubertf  6486:          <span class="command"><strong>make search
1.1       dsieger  6487:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   6488:          extract a list of all packages that depend on a particular
1.10      hubertf  6489:          one by running <span class="command"><strong>make show-deps
1.1       dsieger  6490:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   6491: <p>Running this command takes a very long time, some
                   6492:          hours even on fast machines!</p>
                   6493: </dd>
                   6494: <dt><span class="term">readme</span></dt>
                   6495: <dd>
                   6496: <p>This target generates a
                   6497:          <code class="filename">README.html</code> file, which can be
1.120     sevan    6498:          viewed using a browser such as <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
1.1       dsieger  6499:          contain references to any packages which are in the
                   6500:          <code class="varname">PACKAGES</code> directory on the local
                   6501:          host. The generated files can be made to refer to URLs
                   6502:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   6503:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   6504:          wanted to generate <code class="filename">README.html</code>
                   6505:          files which pointed to binary packages on the local
                   6506:          machine, in the directory
                   6507:          <code class="filename">/usr/packages</code>, set
                   6508:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   6509:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   6510:          <code class="varname">${PACKAGES}</code> directory and its
                   6511:          subdirectories will be searched for all the binary
                   6512:          packages.</p>
                   6513: <p>The target can be run at the toplevel or in category
                   6514:          directories, in which case it descends recursively.</p>
                   6515: </dd>
                   6516: <dt><span class="term">readme-all</span></dt>
                   6517: <dd><p>This is a top-level command, run it in
                   6518:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   6519:          file <code class="filename">README-all.html</code> which contains a
                   6520:          list of all packages currently available in the NetBSD
                   6521:          Packages Collection, together with the category they belong
                   6522:          to and a short description. This file is compiled from the
                   6523:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10      hubertf  6524:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1       dsieger  6525:          readme</strong></span>.</p></dd>
                   6526: <dt><span class="term">cdrom-readme</span></dt>
                   6527: <dd><p>This is very much the same as the
1.23      wiz      6528:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.1       dsieger  6529:          used when generating a pkgsrc tree to be written to a
                   6530:          CD-ROM.  This target also produces
                   6531:          <code class="filename">README.html</code> files, and can be made
                   6532:          to refer to URLs based on
                   6533:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   6534:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   6535: <dt><span class="term">show-distfiles</span></dt>
                   6536: <dd><p>This target shows which distfiles and patchfiles
                   6537:          are needed to build the package
                   6538:          (<code class="varname">ALLFILES</code>, which contains all
                   6539:          <code class="varname">DISTFILES</code> and
                   6540:          <code class="varname">PATCHFILES</code>, but not
                   6541:          <code class="filename">patches/*</code>).</p></dd>
                   6542: <dt><span class="term">show-downlevel</span></dt>
                   6543: <dd><p>This target shows nothing if the package is not
                   6544:          installed. If a version of this package is installed,
                   6545:          but is not the version provided in this version of
                   6546:          pkgsrc, then a warning message is displayed. This target
                   6547:          can be used to show which of your installed packages are
                   6548:          downlevel, and so the old versions can be deleted, and
                   6549:          the current ones added.</p></dd>
                   6550: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   6551: <dd><p>This target shows the directory in the pkgsrc
                   6552:          hierarchy from which the package can be built and
                   6553:          installed. This may not be the same directory as the one
                   6554:          from which the package was installed. This target is
                   6555:          intended to be used by people who may wish to upgrade
                   6556:          many packages on a single host, and can be invoked from
                   6557:          the top-level pkgsrc Makefile by using the
1.23      wiz      6558:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.1       dsieger  6559: <dt><span class="term">show-installed-depends</span></dt>
                   6560: <dd><p>This target shows which installed packages match
                   6561:          the current package's <code class="varname">DEPENDS</code>. Useful
                   6562:          if out of date dependencies are causing build
                   6563:          problems.</p></dd>
1.95      wiz      6564: <dt><span class="term">print-build-depends-list</span></dt>
                   6565: <dd><p>This target shows the list of packages that the current package
                   6566:            depends on for building.</p></dd>
                   6567: <dt><span class="term">print-run-depends-list</span></dt>
                   6568: <dd><p>This target shows the list of packages that the current package
                   6569:            depends on for running.</p></dd>
1.1       dsieger  6570: <dt><span class="term">check-shlibs</span></dt>
                   6571: <dd><p>After a package is installed, check all its
                   6572:          binaries and (on ELF platforms) shared libraries to see
                   6573:          if they find the shared libs they need.  Run by default
1.10      hubertf  6574:          if <code class="varname">PKG_DEVELOPER</code> is set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></dd>
1.1       dsieger  6575: <dt><span class="term">print-PLIST</span></dt>
                   6576: <dd>
1.23      wiz      6577: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.1       dsieger  6578:          upgraded pkg, this prints out an attempt to generate a
1.10      hubertf  6579:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1       dsieger  6580:          -newer work/.extract_done</strong></span>.  An attempt is made
                   6581:          to care for shared libs etc., but it is
                   6582:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   6583:          result before putting it into
                   6584:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   6585:          diff the output of this command against an already
                   6586:          existing <code class="filename">PLIST</code> file.</p>
1.125     leot     6587: <p>If the package installs files via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1       dsieger  6588:          other methods that don't update file access times, be
                   6589:          sure to add these files manually to your
1.23      wiz      6590:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   6591:          -newer</span>&#8221;</span> command used by this target won't catch
1.1       dsieger  6592:          them!</p>
1.23      wiz      6593: <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.1       dsieger  6594:          information on this target.</p>
                   6595: </dd>
                   6596: <dt><span class="term">bulk-package</span></dt>
                   6597: <dd>
                   6598: <p>Used to do bulk builds. If an appropriate binary
                   6599:          package already exists, no action is taken. If not, this
                   6600:          target will compile, install and package it (and its
                   6601:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.66      asau     6602:          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
                   6603: builds)</i></a>).
1.1       dsieger  6604:          After creating the binary package, the sources, the
                   6605:          just-installed package and its required packages are
                   6606:          removed, preserving free disk space.</p>
                   6607: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6608:          all packages installed on a system!</em></span></p>
                   6609: </dd>
                   6610: <dt><span class="term">bulk-install</span></dt>
                   6611: <dd>
                   6612: <p>Used during bulk-installs to install required
                   6613:          packages. If an up-to-date binary package is available,
1.125     leot     6614:          it will be installed via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10      hubertf  6615:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1       dsieger  6616:          but the installed binary won't be removed.</p>
                   6617: <p>A binary package is considered
1.23      wiz      6618:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.125     leot     6619:          <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41      asau     6620: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6621: <li class="listitem"><p>None of the package's files
1.1       dsieger  6622:              (<code class="filename">Makefile</code>, ...) were modified
                   6623:              since it was built.</p></li>
1.23      wiz      6624: <li class="listitem"><p>None of the package's required (binary)
1.1       dsieger  6625:              packages were modified since it was built.</p></li>
                   6626: </ul></div>
                   6627: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6628:          all packages installed on a system!</em></span></p>
                   6629: </dd>
                   6630: </dl></div>
                   6631: </div>
                   6632: </div>
1.41      asau     6633: <div class="chapter">
1.1       dsieger  6634: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6635: <a name="tools"></a>Chapter 18. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  6636: <div class="toc">
                   6637: <p><b>Table of Contents</b></p>
1.100     leot     6638: <dl class="toc">
1.6       rillig   6639: <dt><span class="sect1"><a href="#pkgsrc-tools">18.1. Tools for pkgsrc builds</a></span></dt>
                   6640: <dt><span class="sect1"><a href="#package-tools">18.2. Tools needed by packages</a></span></dt>
                   6641: <dt><span class="sect1"><a href="#platform-tools">18.3. Tools provided by platforms</a></span></dt>
1.1       dsieger  6642: </dl>
                   6643: </div>
                   6644: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   6645: by pkgsrc and also for individual packages to define what commands
                   6646: are needed for building a package (like <code class="varname">BUILD_DEPENDS</code>)
                   6647: or for later run-time of an installed packaged (such as
                   6648: <code class="varname">DEPENDS</code>).
                   6649: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6650: package will not be used.</p>
                   6651: <p>When building a package, the replacement tools are
                   6652: made available in a directory (as symlinks or wrapper scripts)
                   6653: that is early in the executable search path. Just like the buildlink
                   6654: system, this helps with consistent builds.</p>
                   6655: <p>A tool may be needed to help build a specific package. For example,
                   6656: perl, GNU make (gmake) or yacc may be needed.</p>
                   6657: <p>Also a tool may be needed, for example, because the native system's supplied
                   6658: tool may be inefficient for building a package with pkgsrc.
                   6659: For example, a package may need GNU awk, bison (instead of
                   6660: yacc) or a better sed.</p>
                   6661: <p>The tools used by a package can be listed by running
1.10      hubertf  6662: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41      asau     6663: <div class="sect1">
1.1       dsieger  6664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6665: <a name="pkgsrc-tools"></a>18.1. Tools for pkgsrc builds</h2></div></div></div>
1.1       dsieger  6666: <p>The default set of tools used by pkgsrc is defined in
                   6667: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10      hubertf  6668: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6669: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1       dsieger  6670: These can be seen by running:
1.10      hubertf  6671: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1       dsieger  6672: <p>If a package needs a specific program to build
                   6673: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6674: to define the tools needed.</p>
                   6675: </div>
1.41      asau     6676: <div class="sect1">
1.1       dsieger  6677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6678: <a name="package-tools"></a>18.2. Tools needed by packages</h2></div></div></div>
1.28      wiz      6679: <p>In the following examples, the :run means that it is needed at
                   6680: run-time (and becomes a DEPENDS).
1.1       dsieger  6681: The default is a build dependency which can be set with
                   6682: :build. (So in this example, it is the same as gmake:build
                   6683: and pkg-config:build.)</p>
                   6684: <pre class="programlisting">
                   6685: USE_TOOLS+=     gmake perl:run pkg-config
                   6686: </pre>
                   6687: <p>When using the tools framework, a
                   6688: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6689: which contains the full path to the appropriate tool. For example,
1.23      wiz      6690: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.1       dsieger  6691: on Linux systems.</p>
                   6692: <p>If you always need a pkgsrc version of the
                   6693: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6694: </p>
                   6695: </div>
1.41      asau     6696: <div class="sect1">
1.1       dsieger  6697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6698: <a name="platform-tools"></a>18.3. Tools provided by platforms</h2></div></div></div>
1.1       dsieger  6699: <p>When improving or porting pkgsrc to a new platform, have a look
                   6700: at (or create) the corresponding platform specific make file fragment under
                   6701: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6702: the name of the common tools. For example:</p>
                   6703: <pre class="programlisting">
                   6704: .if exists(/usr/bin/bzcat)
                   6705: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6706: .elif exists(/usr/bin/bzip2)
                   6707: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6708: .endif
                   6709: 
                   6710: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   6711: </pre>
                   6712: </div>
                   6713: </div>
1.41      asau     6714: <div class="chapter">
1.1       dsieger  6715: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   6716: <a name="fixes"></a>Chapter 19. Making your package work</h2></div></div></div>
1.1       dsieger  6717: <div class="toc">
                   6718: <p><b>Table of Contents</b></p>
1.100     leot     6719: <dl class="toc">
1.6       rillig   6720: <dt><span class="sect1"><a href="#general-operation">19.1. General operation</a></span></dt>
1.1       dsieger  6721: <dd><dl>
1.108     rillig   6722: <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>
                   6723: <dt><span class="sect2"><a href="#user-interaction">19.1.2. User interaction</a></span></dt>
                   6724: <dt><span class="sect2"><a href="#handling-licenses">19.1.3. Handling licenses</a></span></dt>
                   6725: <dt><span class="sect2"><a href="#restricted-packages">19.1.4. Restricted packages</a></span></dt>
                   6726: <dt><span class="sect2"><a href="#dependencies">19.1.5. Handling dependencies</a></span></dt>
                   6727: <dt><span class="sect2"><a href="#conflicts">19.1.6. Handling conflicts with other packages</a></span></dt>
                   6728: <dt><span class="sect2"><a href="#not-building-packages">19.1.7. Packages that cannot or should not be built</a></span></dt>
                   6729: <dt><span class="sect2"><a href="#undeletable-packages">19.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   6730: <dt><span class="sect2"><a href="#security-handling">19.1.9. Handling packages with security problems</a></span></dt>
                   6731: <dt><span class="sect2"><a href="#bumping-pkgrevision">19.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   6732: <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.6       rillig   6733: </dl></dd>
1.108     rillig   6734: <dt><span class="sect1"><a href="#fixes.fetch">19.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig   6735: <dd><dl>
                   6736: <dt><span class="sect2"><a href="#no-plain-download">19.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   6737: <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.88      tnn      6738: <dt><span class="sect2"><a href="#build.fetch.github">19.2.3. Packages hosted on github.com</a></span></dt>
1.6       rillig   6739: </dl></dd>
1.108     rillig   6740: <dt><span class="sect1"><a href="#fixes.configure">19.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
1.6       rillig   6741: <dd><dl>
                   6742: <dt><span class="sect2"><a href="#fixes.libtool">19.3.1. Shared libraries - libtool</a></span></dt>
                   6743: <dt><span class="sect2"><a href="#using-libtool">19.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   6744: <dt><span class="sect2"><a href="#autoconf-automake">19.3.3. GNU Autoconf/Automake</a></span></dt>
                   6745: </dl></dd>
                   6746: <dt><span class="sect1"><a href="#programming-languages">19.4. Programming languages</a></span></dt>
                   6747: <dd><dl>
                   6748: <dt><span class="sect2"><a href="#basic-programming-languages">19.4.1. C, C++, and Fortran</a></span></dt>
                   6749: <dt><span class="sect2"><a href="#java-programming-language">19.4.2. Java</a></span></dt>
                   6750: <dt><span class="sect2"><a href="#perl-scripts">19.4.3. Packages containing perl scripts</a></span></dt>
1.40      wiz      6751: <dt><span class="sect2"><a href="#shell-scripts">19.4.4. Packages containing shell scripts</a></span></dt>
                   6752: <dt><span class="sect2"><a href="#other-programming-languages">19.4.5. Other programming languages</a></span></dt>
1.6       rillig   6753: </dl></dd>
1.108     rillig   6754: <dt><span class="sect1"><a href="#fixes.build">19.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
1.6       rillig   6755: <dd><dl>
                   6756: <dt><span class="sect2"><a href="#fixes.build.cpp">19.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   6757: <dt><span class="sect2"><a href="#compiler-bugs">19.5.2. How to handle compiler bugs</a></span></dt>
1.23      wiz      6758: <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.6       rillig   6759: <dt><span class="sect2"><a href="#out-of-memory">19.5.4. Running out of memory</a></span></dt>
                   6760: </dl></dd>
1.108     rillig   6761: <dt><span class="sect1"><a href="#fixes.install">19.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
1.6       rillig   6762: <dd><dl>
                   6763: <dt><span class="sect2"><a href="#install-scripts">19.6.1. Creating needed directories</a></span></dt>
                   6764: <dt><span class="sect2"><a href="#where-to-install-documentation">19.6.2. Where to install documentation</a></span></dt>
                   6765: <dt><span class="sect2"><a href="#installing-score-files">19.6.3. Installing highscore files</a></span></dt>
                   6766: <dt><span class="sect2"><a href="#destdir-support">19.6.4. Adding DESTDIR support to packages</a></span></dt>
                   6767: <dt><span class="sect2"><a href="#hardcoded-paths">19.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   6768: <dt><span class="sect2"><a href="#perl-modules">19.6.6. Packages installing perl modules</a></span></dt>
                   6769: <dt><span class="sect2"><a href="#faq.info-files">19.6.7. Packages installing info files</a></span></dt>
                   6770: <dt><span class="sect2"><a href="#manpages">19.6.8. Packages installing man pages</a></span></dt>
1.7       rillig   6771: <dt><span class="sect2"><a href="#gconf-data-files">19.6.9. Packages installing GConf data files</a></span></dt>
1.18      snj      6772: <dt><span class="sect2"><a href="#scrollkeeper-data-files">19.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
1.6       rillig   6773: <dt><span class="sect2"><a href="#x11-fonts">19.6.11. Packages installing X11 fonts</a></span></dt>
                   6774: <dt><span class="sect2"><a href="#gtk2-modules">19.6.12. Packages installing GTK2 modules</a></span></dt>
                   6775: <dt><span class="sect2"><a href="#sgml-xml-data">19.6.13. Packages installing SGML or XML data</a></span></dt>
                   6776: <dt><span class="sect2"><a href="#mime-database">19.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   6777: <dt><span class="sect2"><a href="#intltool">19.6.15. Packages using intltool</a></span></dt>
                   6778: <dt><span class="sect2"><a href="#startup-scripts">19.6.16. Packages installing startup scripts</a></span></dt>
                   6779: <dt><span class="sect2"><a href="#tex-packages">19.6.17. Packages installing TeX modules</a></span></dt>
                   6780: <dt><span class="sect2"><a href="#emulation-packages">19.6.18. Packages supporting running binaries in
1.1       dsieger  6781:     emulation</a></span></dt>
1.6       rillig   6782: <dt><span class="sect2"><a href="#hicolor-theme">19.6.19. Packages installing hicolor theme icons</a></span></dt>
                   6783: <dt><span class="sect2"><a href="#desktop-files">19.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  6784: </dl></dd>
1.6       rillig   6785: <dt><span class="sect1"><a href="#punting">19.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  6786: </dl>
                   6787: </div>
1.41      asau     6788: <div class="sect1">
1.1       dsieger  6789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   6790: <a name="general-operation"></a>19.1. General operation</h2></div></div></div>
1.1       dsieger  6791: <p>One appealing feature of pkgsrc is that it runs on many
1.108     rillig   6792:   different platforms. As a result, it is important to ensure,
                   6793:   where possible, that packages in pkgsrc are portable. This
                   6794:   chapter mentions some particular details you should pay
                   6795:   attention to while working on pkgsrc.</p>
1.41      asau     6796: <div class="sect2">
1.1       dsieger  6797: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   6798: <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.1       dsieger  6799: </h3></div></div></div>
                   6800: <p>The pkgsrc user can configure pkgsrc by overriding several
                   6801:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  6802:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  6803:     want to use those variables in the preprocessor directives of
1.125     leot     6804:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1       dsieger  6805:     <code class="literal">.for</code>), you need to include the file
                   6806:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   6807:     loads the user preferences.</p>
                   6808: <p>But note that some variables may not be completely defined
                   6809:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   6810:     included, as they may contain references to variables that are
1.108     rillig   6811:     not yet defined. In shell commands (the lines in
                   6812:     <code class="filename">Makefile</code> that are indented with a tab) this
                   6813:     is no problem, since variables are only expanded when they are
                   6814:     used. But in the preprocessor directives mentioned above and in
                   6815:     dependency lines (of the form <code class="literal">target:
1.1       dsieger  6816:     dependencies</code>) the variables are expanded at load
                   6817:     time.</p>
1.41      asau     6818: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  6819: <h3 class="title">Note</h3>
1.108     rillig   6820: <p>To check whether a variable can be used at load time,
                   6821:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1       dsieger  6822: </div>
                   6823: </div>
1.41      asau     6824: <div class="sect2">
1.1       dsieger  6825: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   6826: <a name="user-interaction"></a>19.1.2. User interaction</h3></div></div></div>
1.1       dsieger  6827: <p>Occasionally, packages require interaction from the user,
                   6828:     and this can be in a number of ways:</p>
1.41      asau     6829: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6830: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1       dsieger  6831:        interaction such as entering username/password or accepting a
                   6832:        license on a web page.</p></li>
1.23      wiz      6833: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1       dsieger  6834:        passwords.</p></li>
1.23      wiz      6835: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   6836: <li class="listitem"><p>help during the build process</p></li>
                   6837: <li class="listitem"><p>help during the installation of a package</p></li>
1.1       dsieger  6838: </ul></div>
1.108     rillig   6839: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   6840:     variable to define which stages need interaction. This should be
                   6841:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1       dsieger  6842: <pre class="programlisting">
                   6843: INTERACTIVE_STAGE=      configure install
1.111     sevan    6844: </pre>
1.1       dsieger  6845: <p>The user can then decide to skip this package by setting the
1.108     rillig   6846:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   6847:     are also excluded from bulk builds.</p>
1.1       dsieger  6848: </div>
1.41      asau     6849: <div class="sect2">
1.1       dsieger  6850: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   6851: <a name="handling-licenses"></a>19.1.3. Handling licenses</h3></div></div></div>
1.111     sevan    6852: <p>Authors of software can choose the licence under which software
                   6853:     can be copied.  The Free Software Foundation has declared some
                   6854:     licenses "Free", and the Open Source Initiative has a definition of
                   6855:     "Open Source".</p>
                   6856: <p>By default, pkgsrc allows packages with Free or Open Source
                   6857:     licenses to be built.  To allow packages with other licenses to be
                   6858:     built as well, the pkgsrc user needs to add these licenses to the
                   6859:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   6860:     that this variable only affects which packages may be
                   6861:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   6862:     restrict the actual use of the package and its redistribution.</p>
1.1       dsieger  6863: <p>One might want to only install packages with a BSD license,
1.108     rillig   6864:     or the GPL, and not the other.  The free licenses are added to the
1.111     sevan    6865:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.19      jnemeth  6866:     user can override the default by setting the
                   6867:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111     sevan    6868:     of "+=".  The licenses accepted by default are defined in the
                   6869:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   6870:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1       dsieger  6871: <p>The license tag mechanism is intended to address
                   6872:     copyright-related issues surrounding building, installing and
                   6873:     using a package, and not to address redistribution issues (see
                   6874:     <code class="varname">RESTRICTED</code> and
1.111     sevan    6875:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19      jnemeth  6876:     Packages with redistribution restrictions should set these
                   6877:     tags.</p>
1.1       dsieger  6878: <p>Denoting that a package may be copied according to a
                   6879:     particular license is done by placing the license in
                   6880:     <code class="filename">pkgsrc/licenses</code> and setting the
                   6881:     <code class="varname">LICENSE</code> variable to a string identifying the
1.120     sevan    6882:     license, e.g. in <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1       dsieger  6883: <pre class="programlisting">
                   6884: LICENSE=        xv-license
1.111     sevan    6885: </pre>
1.1       dsieger  6886: <p>When trying to build, the user will get a notice that the
                   6887:     package is covered by a license which has not been placed in the
                   6888:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   6889: <pre class="programlisting">
                   6890: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   6891: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   6892: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   6893: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   6894: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   6895: *** Error code 1
1.111     sevan    6896: </pre>
1.10      hubertf  6897: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  6898:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  6899:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  6900:     convey to pkgsrc that it should not in the future fail because of
                   6901:     that license:</p>
                   6902: <pre class="programlisting">
                   6903: ACCEPTABLE_LICENSES+=xv-license
1.111     sevan    6904: </pre>
                   6905: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   6906:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   6907:     is deprecated because it does not crisply refer to a particular
                   6908:     license text.  Another problem with such usage is that it does not
                   6909:     enable a user to tell pkgsrc to proceed for a single package
                   6910:     without also telling pkgsrc to proceed for all packages with that
                   6911:     tag.</p>
                   6912: <div class="sect3">
                   6913: <div class="titlepage"><div><div><h4 class="title">
                   6914: <a name="new-license"></a>19.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48      rodent   6915: <p>When adding a package with a new license, the following steps
                   6916:     are required:</p>
                   6917: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6918: <li class="listitem">
1.111     sevan    6919: <p>Check whether the license qualifies as Free or Open
                   6920:     Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
                   6921:     and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
                   6922:     Open Source Initiative</a>.  If this is the case, the filename in
                   6923:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   6924:     <code class="filename">-license</code> suffix, and the license name should be
                   6925:     added to:</p>
1.48      rodent   6926: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6927: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   6928: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
                   6929: </ul></div>
                   6930: </li>
                   6931: <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>
                   6932: </ol></div>
1.111     sevan    6933: </div>
                   6934: <div class="sect3">
                   6935: <div class="titlepage"><div><div><h4 class="title">
                   6936: <a name="change-license"></a>19.1.3.2. Change to the license</h4></div></div></div>
1.1       dsieger  6937: <p>When the license changes (in a way other than formatting),
1.111     sevan    6938:     make sure that the new license has a different name (e.g.,
1.1       dsieger  6939:     append the version number if it exists, or the date).  Just
                   6940:     because a user told pkgsrc to build programs under a previous
                   6941:     version of a license does not mean that pkgsrc should build
                   6942:     programs under the new licenses.  The higher-level point is that
                   6943:     pkgsrc does not evaluate licenses for reasonableness; the only
                   6944:     test is a mechanistic test of whether a particular text has been
1.111     sevan    6945:     approved by either of two bodies (FSF or OSI).</p>
                   6946: </div>
1.1       dsieger  6947: </div>
1.41      asau     6948: <div class="sect2">
1.1       dsieger  6949: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   6950: <a name="restricted-packages"></a>19.1.4. Restricted packages</h3></div></div></div>
1.1       dsieger  6951: <p>Some licenses restrict how software may be re-distributed.
1.111     sevan    6952:     By declaring the restrictions, package tools can
1.1       dsieger  6953:     automatically refrain from e.g. placing binary packages on FTP
                   6954:     sites.</p>
1.111     sevan    6955: <p>There are four possible restrictions, which are
1.1       dsieger  6956:     the cross product of sources (distfiles) and binaries not being
                   6957:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   6958:     language in any license, and because non-Free licenses tend to be
                   6959:     different from each other, pkgsrc adopts a definition of FTP and
1.111     sevan    6960:     CD-ROM.
                   6961: 
                   6962:     "FTP" means making the source or binary file available over the
                   6963:     Internet at no charge.
                   6964: 
                   6965:     "CD-ROM" means making the source or binary available on some kind of
                   6966:     media, together with other source and binary packages, which is sold
                   6967:     for a distribution charge.
1.1       dsieger  6968:     </p>
                   6969: <p>In order to encode these restrictions, the package system
                   6970:     defines five make variables that can be set to note these
                   6971:     restrictions:</p>
1.41      asau     6972: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6973: <li class="listitem">
1.1       dsieger  6974: <p><code class="varname">RESTRICTED</code></p>
                   6975: <p>This variable should be set whenever a restriction
                   6976:        exists (regardless of its kind).  Set this variable to a
                   6977:        string containing the reason for the restriction.  It should
                   6978:        be understood that those wanting to understand the restriction
                   6979:        will have to read the license, and perhaps seek advice of
                   6980:        counsel.</p>
                   6981: </li>
1.23      wiz      6982: <li class="listitem">
1.1       dsieger  6983: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   6984: <p>Binaries may not be placed on CD-ROM containing other
                   6985:        binary packages, for which a distribution charge may be made.
                   6986:        In this case, set this variable to
                   6987:        <code class="varname">${RESTRICTED}</code>.</p>
                   6988: </li>
1.23      wiz      6989: <li class="listitem">
1.1       dsieger  6990: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   6991: <p>Binaries may not made available on the Internet without
                   6992:        charge.  In this case, set this variable to
                   6993:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   6994:        binary packages will not be included on ftp.NetBSD.org.</p>
                   6995: </li>
1.23      wiz      6996: <li class="listitem">
1.1       dsieger  6997: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   6998: <p>Distfiles may not be placed on CD-ROM, together with
                   6999:        other distfiles, for which a fee may be charged.  In this
                   7000:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7001:        </p>
                   7002: </li>
1.23      wiz      7003: <li class="listitem">
1.1       dsieger  7004: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7005: <p>Distfiles may not made available via FTP at no charge.
                   7006:        In this case, set this variable to
                   7007:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7008:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7009: </li>
                   7010: </ul></div>
1.111     sevan    7011: <p>Please note that packages will be removed from pkgsrc when the
                   7012:     distfiles are not distributable and cannot be obtained for a period
                   7013:     of one full quarter branch. Packages with manual/interactive fetch
                   7014:     must have a maintainer and it is his/her responsibility to ensure
                   7015:     this.</p>
1.1       dsieger  7016: </div>
1.41      asau     7017: <div class="sect2">
1.1       dsieger  7018: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   7019: <a name="dependencies"></a>19.1.5. Handling dependencies</h3></div></div></div>
1.1       dsieger  7020: <p>Your package may depend on some other package being present
                   7021:     - and there are various ways of expressing this dependency.
                   7022:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
                   7023:     <code class="varname">DEPENDS</code> definitions, the
                   7024:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7025:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7026:     to handle dependencies, and which uses the variables named above.
1.10      hubertf  7027:     See <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a> for more information.</p>
1.1       dsieger  7028: <p>The basic difference between the two variables is as
                   7029:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7030:     that pre-requisite in the binary package so it will be pulled in
                   7031:     when the binary package is later installed, whilst the
                   7032:     <code class="varname">BUILD_DEPENDS</code> definition does not, marking a
                   7033:     dependency that is only needed for building the package.</p>
                   7034: <p>This means that if you only need a package present whilst
                   7035:     you are building, it should be noted as a
                   7036:     <code class="varname">BUILD_DEPENDS</code>.</p>
                   7037: <p>The format for a <code class="varname">BUILD_DEPENDS</code> and a
                   7038:     <code class="varname">DEPENDS</code> definition is:</p>
                   7039: <pre class="programlisting">
                   7040: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.111     sevan    7041: </pre>
1.23      wiz      7042: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.1       dsieger  7043:     may include any of the wildcard version numbers recognized by
1.125     leot     7044:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23      wiz      7045: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7046: <li class="listitem">
1.1       dsieger  7047: <p>If your package needs another package's binaries or
1.54      wiz      7048:        libraries to build and run, and if that package has a
1.1       dsieger  7049:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7050: <pre class="programlisting">
                   7051: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7052: </pre>
1.1       dsieger  7053: </li>
1.23      wiz      7054: <li class="listitem">
1.54      wiz      7055: <p>If your package needs another package's binaries or
                   7056:        libraries only for building, and if that package has a
                   7057:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7058: <pre class="programlisting">
                   7059: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7060: </pre>
1.54      wiz      7061: <p>but set
                   7062:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7063:        to make it a build dependency only. This case is rather
                   7064:        rare.</p>
                   7065: </li>
                   7066: <li class="listitem">
1.25      spz      7067: <p>If your package needs binaries from another package to build,
                   7068:        use the <code class="varname">BUILD_DEPENDS</code> definition:</p>
1.1       dsieger  7069: <pre class="programlisting">
1.25      spz      7070: BUILD_DEPENDS+= scons-[0-9]*:../../devel/scons
1.111     sevan    7071: </pre>
1.1       dsieger  7072: </li>
1.25      spz      7073: <li class="listitem"><p>If your package needs a library with which to link and
                   7074:        there is no <code class="filename">buildlink3.mk</code> file
                   7075:        available, create one. Using
                   7076:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7077:        include files and libraries will be hidden from the compiler.</p></li>
1.23      wiz      7078: <li class="listitem">
1.25      spz      7079: <p>If your package needs some executable to be able to run
                   7080:        correctly and if there's no
                   7081:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7082:        using the <code class="varname">DEPENDS</code> variable. The
1.120     sevan    7083:        <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.129     wiz      7084:        be able to execute the latex binary from the tex-latex-bin package
1.25      spz      7085:        when it runs, and that is specified:</p>
1.1       dsieger  7086: <pre class="programlisting">
1.129     wiz      7087: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111     sevan    7088: </pre>
1.25      spz      7089: </li>
                   7090: <li class="listitem">
                   7091: <p>You can use wildcards in package dependencies. Note that
                   7092:        such wildcard dependencies are retained when creating binary
                   7093:        packages. The dependency is checked when installing the binary
                   7094:        package and any package which matches the pattern will be
                   7095:        used. Wildcard dependencies should be used with care.</p>
1.23      wiz      7096: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7097:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7098:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7099:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.1       dsieger  7100: <p>Wildcards can also be used to specify that a package
                   7101:        will only build against a certain minimum version of a
                   7102:        pre-requisite:</p>
                   7103: <pre class="programlisting">
1.25      spz      7104: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.111     sevan    7105: </pre>
1.25      spz      7106: <p>This means that the package will build using version 6.0
                   7107:        of ImageMagick or newer. Such a dependency may be warranted
                   7108:        if, for example, the command line options of an executable
                   7109:        have changed.</p>
                   7110: <p>If you need to depend on minimum versions of libraries,
                   7111:        see the buildlink section of the pkgsrc guide.</p>
1.1       dsieger  7112: <p>For security fixes, please update the package
1.108     rillig   7113:        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.1       dsieger  7114:        information.</p>
                   7115: </li>
                   7116: </ol></div>
                   7117: <p>If your package needs files from another package to build,
                   7118:     add the relevant distribution files to
                   7119:     <code class="varname">DISTFILES</code>, so they will be extracted
1.120     sevan    7120:     automatically. See the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.1       dsieger  7121:     (It relies on the jpeg sources being present in source form
                   7122:     during the build.)</p>
                   7123: </div>
1.41      asau     7124: <div class="sect2">
1.1       dsieger  7125: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   7126: <a name="conflicts"></a>19.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  7127: <p>Your package may conflict with other packages a user might
                   7128:     already have installed on his system, e.g. if your package
                   7129:     installs the same set of files as another package in the pkgsrc
1.80      wiz      7130:     tree or has the same <code class="varname">PKGNAME</code>.</p>
                   7131: <p>These cases are handled automatically by the packaging tools
                   7132:     at package installation time and do not need to be handled
                   7133:     manually.</p>
                   7134: <p>In case the conflicts can not be recognized automatically
                   7135:     (e.g., packages using the same config file location but no other
                   7136:     shared files), you can set <code class="varname">CONFLICTS</code> to a
1.1       dsieger  7137:     space-separated list of packages (including version string) your
                   7138:     package conflicts with.</p>
1.120     sevan    7139: <p>For example, if both <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/bar/README.html" target="_top"><code class="filename">foo/bar</code></a>
                   7140:     and <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/foo/baz/README.html" target="_top"><code class="filename">foo/baz</code></a>
1.80      wiz      7141:     use the same config file, you would set in
                   7142:     <code class="filename">foo/bar/Makefile</code>:</p>
1.1       dsieger  7143: <pre class="programlisting">
1.80      wiz      7144: CONFLICTS=      baz-[0-9]*
1.111     sevan    7145: </pre>
1.80      wiz      7146: <p>and in <code class="filename">pkgsrc/foo/baz/Makefile</code>:</p>
1.1       dsieger  7147: <pre class="programlisting">
1.80      wiz      7148: CONFLICTS=      bar-[0-9]*
1.111     sevan    7149: </pre>
1.1       dsieger  7150: </div>
1.41      asau     7151: <div class="sect2">
1.1       dsieger  7152: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   7153: <a name="not-building-packages"></a>19.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  7154: <p>There are several reasons why a package might be
                   7155:     instructed to not build under certain circumstances.  If the
                   7156:     package builds and runs on most platforms, the exceptions
1.83      dholland 7157:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7158:     the package builds and runs on a small handful of platforms,
                   7159:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7160:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7161:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7162:     (OS-version-platform) that can use glob-style
                   7163:     wildcards.</p>
                   7164: <p>If a package is not appropriate for some platforms (as
1.114     maya     7165:     opposed to merely broken), a different set of variables should be
1.83      dholland 7166:     used as this affects failure reporting and statistics.
                   7167:     If the package is appropriate for most platforms, the exceptions
1.1       dsieger  7168:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.83      dholland 7169:     the package is appropriate for only a small handful of platforms
                   7170:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1       dsieger  7171:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7172:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7173:     (OS-version-platform) that can use glob-style
                   7174:     wildcards.</p>
                   7175: <p>Some packages are tightly bound to a specific version of an
1.120     sevan    7176:     operating system, e.g. LKMs or <a href="http://cdn.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.1       dsieger  7177:     backwards compatible with other versions of the OS, and should be
                   7178:     uploaded to a version specific directory on the FTP server.  Mark
                   7179:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23      wiz      7180:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.1       dsieger  7181:     the package system internals, but may be used in the
                   7182:     future.</p>
                   7183: <p>If the package should be skipped (for example, because it
                   7184:     provides functionality already provided by the system), set
                   7185:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7186:     the package should fail because some preconditions are not met,
                   7187:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   7188:     message.</p>
                   7189: </div>
1.41      asau     7190: <div class="sect2">
1.1       dsieger  7191: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   7192: <a name="undeletable-packages"></a>19.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  7193: <p>To ensure that a package may not be deleted, once it has been
                   7194:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7195:     be set in the package Makefile. This will be carried into any
                   7196:     binary package that is made from this pkgsrc entry. A
1.23      wiz      7197:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.125     leot     7198:     not be deleted using <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23      wiz      7199:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.1       dsieger  7200: </div>
1.41      asau     7201: <div class="sect2">
1.1       dsieger  7202: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   7203: <a name="security-handling"></a>19.1.9. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  7204: <p>When a vulnerability is found, this should be noted in
                   7205:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31      wiz      7206:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7207:     update the file on ftp.NetBSD.org.</p>
1.1       dsieger  7208: <p>After fixing the vulnerability by a patch, its
1.31      wiz      7209:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7210:     course not necessary if the problem is fixed by using a newer
                   7211:     release of the software), and the pattern in the
                   7212:     pkg-vulnerabilities file must be updated.</p>
1.1       dsieger  7213: <p>Also, if the fix should be applied to the stable pkgsrc
                   7214:     branch, be sure to submit a pullup request!</p>
                   7215: <p>Binary packages already on ftp.NetBSD.org will be handled
                   7216:     semi-automatically by a weekly cron job.</p>
                   7217: </div>
1.41      asau     7218: <div class="sect2">
1.1       dsieger  7219: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   7220: <a name="bumping-pkgrevision"></a>19.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1       dsieger  7221: <p>When making fixes to an existing package it can be useful
                   7222:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7223:     avoid conflicting with future versions by the original author, a
1.23      wiz      7224:     <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.1       dsieger  7225:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23      wiz      7226:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7227:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.1       dsieger  7228: <pre class="programlisting">
                   7229: DISTNAME=       foo-17.42
                   7230: PKGREVISION=    9
1.111     sevan    7231: </pre>
1.1       dsieger  7232: <p>will result in a <code class="varname">PKGNAME</code> of
1.23      wiz      7233:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7234:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.1       dsieger  7235:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7236:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   7237: <p>When a new release of the package is released, the
                   7238:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7239:     minor release of the above package, things should be like:</p>
                   7240: <pre class="programlisting">
                   7241: DISTNAME=       foo-17.43
1.111     sevan    7242: </pre>
1.1       dsieger  7243: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7244:     non-trivial change in the resulting binary package.  Without a
                   7245:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7246:     version installed has no way of knowing that their package is out
                   7247:     of date.  Thus, changes without increasing
                   7248:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7249:     trivial that no reasonable person would want to upgrade", and this
                   7250:     is the rough test for when increasing
                   7251:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7252:     changes that do not merit increasing
                   7253:     <code class="varname">PKGREVISION</code> are:</p>
1.41      asau     7254: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7255: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14      jmcneill 7256:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1       dsieger  7257:       or comments in Makefile.</p></li>
1.23      wiz      7258: <li class="listitem"><p>
1.1       dsieger  7259:       Changing build variables if the resulting binary package is the same.</p></li>
1.23      wiz      7260: <li class="listitem"><p>
1.1       dsieger  7261:       Changing <code class="filename">DESCR</code>.</p></li>
1.23      wiz      7262: <li class="listitem"><p>
1.1       dsieger  7263:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   7264: </ul></div>
                   7265: <p>Examples of changes that do merit an increase to
                   7266:     <code class="varname">PKGREVISION</code> include:</p>
1.41      asau     7267: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7268: <li class="listitem"><p>
1.1       dsieger  7269:       Security fixes</p></li>
1.23      wiz      7270: <li class="listitem"><p>
1.1       dsieger  7271:       Changes or additions to a patch file</p></li>
1.23      wiz      7272: <li class="listitem"><p>
1.1       dsieger  7273:       Changes to the <code class="filename">PLIST</code></p></li>
1.23      wiz      7274: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1       dsieger  7275: </ul></div>
                   7276: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7277:     changes.</p>
                   7278: </div>
1.41      asau     7279: <div class="sect2">
1.1       dsieger  7280: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   7281: <a name="fixes.subst"></a>19.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1       dsieger  7282: <p>When you want to replace the same text in multiple files
                   7283:     or when the replacement text varies, patches alone cannot help.
                   7284:     This is where the SUBST framework comes in. It provides an
                   7285:     easy-to-use interface for replacing text in files.
                   7286:     Example:</p>
                   7287: <pre class="programlisting">
                   7288: SUBST_CLASSES+=                 fix-paths
                   7289: SUBST_STAGE.fix-paths=          pre-configure
                   7290: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7291: SUBST_FILES.fix-paths=          src/*.c
                   7292: SUBST_FILES.fix-paths+=         scripts/*.sh
                   7293: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7294: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.111     sevan    7295: </pre>
1.1       dsieger  7296: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
                   7297:     that are used to identify the different SUBST blocks that are
                   7298:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7299:     important to always use the <code class="literal">+=</code> operator with
                   7300:     this variable. Otherwise some substitutions may be
                   7301:     skipped.</p>
                   7302: <p>The remaining variables of each SUBST block are
                   7303:     parameterized with the identifier from the first line
                   7304:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7305:     parameters to a function call.</p>
                   7306: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
                   7307:     which the replacement will take place. All combinations of
                   7308:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7309:     <code class="literal">post-</code> together with a phase name are
                   7310:     possible, though only few are actually used. Most commonly used
                   7311:     are <code class="literal">post-patch</code> and
                   7312:     <code class="literal">pre-configure</code>. Of these two,
                   7313:     <code class="literal">pre-configure</code> should be preferred because
1.10      hubertf  7314:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1       dsieger  7315:     have the state after applying the patches but before making any
                   7316:     other changes. This is especially useful when you are debugging
                   7317:     a package in order to create new patches for it. Similarly,
                   7318:     <code class="literal">post-build</code> is preferred over
                   7319:     <code class="literal">pre-install</code>, because the install phase should
                   7320:     generally be kept as simple as possible. When you use
                   7321:     <code class="literal">post-build</code>, you have the same files in the
                   7322:     working directory that will be installed later, so you can check
                   7323:     if the substitution has succeeded.</p>
                   7324: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
                   7325:     that is printed just before the substitution is done.</p>
                   7326: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
                   7327:     globbing patterns that specifies the files in which the
                   7328:     substitution will take place. The patterns are interpreted
                   7329:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
                   7330: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.125     leot     7331:     <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1       dsieger  7332:     command should be prefixed with <code class="literal">-e</code>, so that
                   7333:     all SUBST blocks look uniform.</p>
                   7334: <p>There are some more variables, but they are so seldomly
                   7335:     used that they are only documented in the
                   7336:     <code class="filename">mk/subst.mk</code> file.</p>
                   7337: </div>
                   7338: </div>
1.41      asau     7339: <div class="sect1">
1.1       dsieger  7340: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   7341: <a name="fixes.fetch"></a>19.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41      asau     7342: <div class="sect2">
1.1       dsieger  7343: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7344: <a name="no-plain-download"></a>19.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1       dsieger  7345: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  7346:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  7347:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   7348:     with the name of each file to download as an argument, expecting
                   7349:     it to output the URL of the directory from which to download
1.120     sevan    7350:     it. <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.1       dsieger  7351:     example of this usage.</p>
                   7352: <p>If the download can't be automated, because the user must
                   7353:     submit personal information to apply for a password, or must pay
                   7354:     for the source, or whatever, you can set
                   7355:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   7356:     displayed to the user before aborting the build. Example:</p>
                   7357: <pre class="programlisting">
                   7358: FETCH_MESSAGE=  "Please download the files"
                   7359: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   7360: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111     sevan    7361: </pre>
1.1       dsieger  7362: </div>
1.41      asau     7363: <div class="sect2">
1.1       dsieger  7364: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7365: <a name="modified-distfiles-same-name"></a>19.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1       dsieger  7366: <p>Sometimes authors of a software package make some
                   7367:     modifications after the software was released, and they put up a
                   7368:     new distfile without changing the package's version number. If a
                   7369:     package is already in pkgsrc at that time, the checksum will
                   7370:     no longer match. The contents of the new distfile should be
                   7371:     compared against the old one before changing anything, to make
                   7372:     sure the distfile was really updated on purpose, and that
                   7373:     no trojan horse or so crept in.
                   7374:     Please mention that the distfiles were compared and what was found
1.53      rodent   7375:     in your commit message.</p>
1.109     wiz      7376: <p>Then, the correct way to work around this is to set
                   7377:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   7378:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   7379:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   7380:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.1       dsieger  7381:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.109     wiz      7382:     subdirectory of the local distfiles directory. (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.) In case this
1.1       dsieger  7383:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109     wiz      7384:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   7385:     be appended, like
                   7386:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53      rodent   7387: <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>
                   7388: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1       dsieger  7389:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   7390:     path in the filenames.
1.53      rodent   7391:     Also, increase the PKGREVISION if the installed package is different.
1.1       dsieger  7392:     Furthermore, a mail to the package's authors seems appropriate
                   7393:     telling them that changing distfiles after releases without
                   7394:     changing the file names is not good practice.</p>
                   7395: </div>
1.88      tnn      7396: <div class="sect2">
                   7397: <div class="titlepage"><div><div><h3 class="title">
                   7398: <a name="build.fetch.github"></a>19.2.3. Packages hosted on github.com</h3></div></div></div>
1.90      tnn      7399: <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:
                   7400:     </p>
1.88      tnn      7401: <div class="sect3">
                   7402: <div class="titlepage"><div><div><h4 class="title">
                   7403: <a name="build.fetch.github.tag"></a>19.2.3.1. Fetch based on a tagged release</h4></div></div></div>
                   7404: <p>
                   7405:         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.
                   7406:       </p>
                   7407: <pre class="programlisting">
                   7408: DISTNAME=       exampleproject-1.0
1.90      tnn      7409: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7410: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7411: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.88      tnn      7412: EXTRACT_SUFX=   .zip
                   7413: </pre>
                   7414: </div>
                   7415: <div class="sect3">
                   7416: <div class="titlepage"><div><div><h4 class="title">
                   7417: <a name="build.fetch.github.commit"></a>19.2.3.2. Fetch based on a specific commit</h4></div></div></div>
                   7418: <p>
                   7419:         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.
                   7420:       </p>
                   7421: <pre class="programlisting">
                   7422: DISTNAME=       example-1.0
1.107     jnemeth  7423: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.90      tnn      7424: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7425: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111     sevan    7426: </pre>
1.88      tnn      7427: </div>
                   7428: <div class="sect3">
                   7429: <div class="titlepage"><div><div><h4 class="title">
                   7430: <a name="build.fetch.github.release"></a>19.2.3.3. Fetch based on release</h4></div></div></div>
                   7431: <p>
                   7432:         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.
                   7433:       </p>
                   7434: <pre class="programlisting">
                   7435: DISTNAME=       offensive-1.6
1.90      tnn      7436: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   7437: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7438: GITHUB_PROJECT= exampleproject
                   7439: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   7440: EXTRACT_SUFX=   .zip
1.111     sevan    7441: </pre>
1.88      tnn      7442: </div>
                   7443: </div>
1.1       dsieger  7444: </div>
1.41      asau     7445: <div class="sect1">
1.1       dsieger  7446: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   7447: <a name="fixes.configure"></a>19.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41      asau     7448: <div class="sect2">
1.1       dsieger  7449: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7450: <a name="fixes.libtool"></a>19.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  7451: <p>pkgsrc supports many different machines, with different
                   7452:     object formats like a.out and ELF, and varying abilities to do
                   7453:     shared library and dynamic loading at all. To accompany this,
                   7454:     varying commands and options have to be passed to the
                   7455:     compiler, linker, etc. to get the Right Thing, which can be
                   7456:     pretty annoying especially if you don't have all the machines
                   7457:     at your hand to test things.  The
1.120     sevan    7458:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23      wiz      7459:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.1       dsieger  7460:     both static and dynamic libraries from a set of source files,
                   7461:     thus being platform-independent.</p>
                   7462: <p>Here's how to use libtool in a package in seven simple
                   7463:     steps:</p>
1.23      wiz      7464: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7465: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1       dsieger  7466:        Makefile.</p></li>
1.23      wiz      7467: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   7468:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.1       dsieger  7469:        add it to the definition of <code class="varname">CC</code>, if only
                   7470:        libraries are being built in a given Makefile. This one command
                   7471:        will build both PIC and non-PIC library objects, so you need not
                   7472:        have separate shared and non-shared library rules.</p></li>
1.23      wiz      7473: <li class="listitem">
1.1       dsieger  7474: <p>For the linking of the library, remove any
1.23      wiz      7475:        <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
                   7476:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.1       dsieger  7477: <pre class="programlisting">
                   7478: ${LIBTOOL} --mode=link \
                   7479:     ${CC} -o ${.TARGET:.a=.la} \
                   7480:         ${OBJS:.o=.lo} \
                   7481:         -rpath ${PREFIX}/lib \
                   7482:         -version-info major:minor
1.111     sevan    7483: </pre>
1.1       dsieger  7484: <p>Note that the library is changed to have a
                   7485:        <code class="filename">.la</code> extension, and the objects are
                   7486:        changed to have a <code class="filename">.lo</code>
                   7487:        extension. Change <code class="varname">OBJS</code> as
                   7488:        necessary. This automatically creates all of the
                   7489:        <code class="filename">.a</code>,
                   7490:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   7491:        necessary) in the build directory. Be sure to include
1.23      wiz      7492:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.1       dsieger  7493:        minor are zero, as libtool will otherwise strip off the
                   7494:        shared library version.</p>
                   7495: <p>From the libtool manual:</p>
                   7496: <pre class="programlisting">
                   7497: So, libtool library versions are described by three integers:
                   7498: 
                   7499: CURRENT
                   7500: The most recent interface number that this library implements.
                   7501: 
                   7502: REVISION
                   7503: The implementation number of the CURRENT interface.
                   7504: 
                   7505: AGE
                   7506: The difference between the newest and oldest interfaces that
                   7507: this library implements.  In other words, the library implements
                   7508: all the interface numbers in the range from number `CURRENT -
                   7509: AGE' to `CURRENT'.
                   7510: 
                   7511: If two libraries have identical CURRENT and AGE numbers, then the
                   7512: dynamic linker chooses the library with the greater REVISION number.
1.111     sevan    7513: </pre>
1.23      wiz      7514: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.1       dsieger  7515:        different results for a.out and ELF (excluding symlinks)
                   7516:        in only one case. An ELF library of the form
1.23      wiz      7517:        <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.1       dsieger  7518:        will have a symlink of
1.23      wiz      7519:        <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.1       dsieger  7520:        on an a.out platform. This is handled
                   7521:        automatically.</p>
1.23      wiz      7522: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.1       dsieger  7523:        directory of the library being built.</p>
                   7524: <p>In the <code class="filename">PLIST</code>, include only the
                   7525:        <code class="filename">.la</code> file, the other files will be
                   7526:        added automatically.</p>
                   7527: </li>
1.23      wiz      7528: <li class="listitem">
1.1       dsieger  7529: <p>When linking shared object (<code class="filename">.so</code>)
1.125     leot     7530:        files, i.e. files that are loaded via <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23      wiz      7531:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   7532:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.1       dsieger  7533:        tacked on.</p>
                   7534: <p>The <code class="filename">PLIST</code> file gets the
                   7535:        <code class="filename">foo.so</code> entry.</p>
                   7536: </li>
1.23      wiz      7537: <li class="listitem">
1.1       dsieger  7538: <p>When linking programs that depend on these libraries
                   7539:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.125     leot     7540:        the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-7.1"><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.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.23      wiz      7541:        --mode=link</span>&#8221;</span>, and it will find the correct
1.1       dsieger  7542:        libraries (static or shared), but please be aware that
                   7543:        libtool will not allow you to specify a relative path in
1.23      wiz      7544:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.1       dsieger  7545:        expects you to change that argument to be the
                   7546:        <code class="filename">.la</code> file. e.g.</p>
                   7547: <pre class="programlisting">
                   7548: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111     sevan    7549: </pre>
1.1       dsieger  7550: <p>should be changed to:</p>
                   7551: <pre class="programlisting">
                   7552: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111     sevan    7553: </pre>
1.1       dsieger  7554: <p>and it will do the right thing with the libraries.</p>
                   7555: </li>
1.23      wiz      7556: <li class="listitem">
1.125     leot     7557: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   7558:        or <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.23      wiz      7559:        --mode=install</span>&#8221;</span>, and change the library name to
1.1       dsieger  7560:        <code class="filename">.la</code>. e.g.</p>
                   7561: <pre class="programlisting">
1.22      jakllsch 7562: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111     sevan    7563: </pre>
1.1       dsieger  7564: <p>This will install the static <code class="filename">.a</code>,
                   7565:        shared library, any needed symlinks, and run
1.125     leot     7566:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1       dsieger  7567: </li>
1.23      wiz      7568: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1       dsieger  7569:        the <code class="filename">.la</code>
                   7570:        file (this is a change from previous behaviour).</p></li>
                   7571: </ol></div>
                   7572: </div>
1.41      asau     7573: <div class="sect2">
1.1       dsieger  7574: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7575: <a name="using-libtool"></a>19.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  7576: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   7577:     package Makefile. This will override the package's own libtool
                   7578:     in most cases.  For older libtool using packages,  libtool is
                   7579:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  7580:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  7581:     configure; find work*/ -name libtool</strong></span>.</p>
                   7582: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   7583:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.23      wiz      7584:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   7585:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.1       dsieger  7586:     package's libtool script(s), set it as appropriate.</p>
                   7587: <p>If you do not need <code class="filename">*.a</code> static
                   7588:     libraries built and installed, then use
                   7589:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   7590: <p>If your package makes use of the platform-independent library
                   7591:     for loading dynamic shared objects, that comes with libtool
                   7592:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   7593: <p>Some packages use libtool incorrectly so that the package
                   7594:     may not work or build in some circumstances. Some of the more
                   7595:     common errors are:</p>
1.41      asau     7596: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7597: <li class="listitem">
1.1       dsieger  7598: <p>The inclusion of a shared object (-module) as a dependent library in an
                   7599:        executable or library. This in itself isn't a problem if one of two things
                   7600:        has been done:</p>
1.23      wiz      7601: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7602: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1       dsieger  7603:            <code class="filename">libfoo.la</code>, not
                   7604:            <code class="filename">foo.la</code></p></li>
1.23      wiz      7605: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1       dsieger  7606: </ol></div>
                   7607: </li>
1.23      wiz      7608: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1       dsieger  7609:        The function lt_dlinit() should be called and the macro
                   7610:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   7611:        executables.</p></li>
                   7612: </ul></div>
                   7613: </div>
1.41      asau     7614: <div class="sect2">
1.1       dsieger  7615: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7616: <a name="autoconf-automake"></a>19.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  7617: <p>If a package needs GNU autoconf or automake to be executed
                   7618:     to regenerate the configure script and Makefile.in makefile
                   7619:     templates, then they should be executed in a pre-configure
                   7620:     target.</p>
                   7621: <p>For packages that need only autoconf:</p>
                   7622: <pre class="programlisting">
                   7623: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   7624: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   7625: ...
                   7626: 
                   7627: pre-configure:
                   7628:         cd ${WRKSRC} &amp;&amp; autoconf
                   7629: 
                   7630: ...
1.111     sevan    7631: </pre>
1.1       dsieger  7632: <p>and for packages that need automake and autoconf:</p>
                   7633: <pre class="programlisting">
                   7634: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   7635: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   7636: ...
                   7637: 
                   7638: pre-configure:
                   7639:         set -e; cd ${WRKSRC}; \
                   7640:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   7641: 
                   7642: ...
1.111     sevan    7643: </pre>
1.1       dsieger  7644: <p>Packages which use GNU Automake will almost certainly
                   7645:     require GNU Make.</p>
                   7646: <p>There are times when the configure process makes
                   7647:     additional changes to the generated files, which then causes
                   7648:     the build process to try to re-execute the automake sequence.
                   7649:     This is prevented by touching various files in the configure
                   7650:     stage. If this causes problems with your package you can set
                   7651:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   7652:     Makefile.</p>
                   7653: </div>
                   7654: </div>
1.41      asau     7655: <div class="sect1">
1.1       dsieger  7656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   7657: <a name="programming-languages"></a>19.4. Programming languages</h2></div></div></div>
1.41      asau     7658: <div class="sect2">
1.1       dsieger  7659: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7660: <a name="basic-programming-languages"></a>19.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  7661: <p>Compilers for the C, C++, and Fortran languages comes with
                   7662:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   7663:     is written in C and will hide all other compilers (via the wrapper
1.10      hubertf  7664:     framework, see <a class="xref" href="#buildlink" title="Chapter 14. Buildlink methodology">Chapter 14, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  7665: <p>To declare which language's compiler a package needs, set
                   7666:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23      wiz      7667:     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
                   7668:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   7669:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.1       dsieger  7670:     written in C++, usually need a C compiler for the configure
                   7671:     phase.</p>
                   7672: </div>
1.41      asau     7673: <div class="sect2">
1.1       dsieger  7674: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7675: <a name="java-programming-language"></a>19.4.2. Java</h3></div></div></div>
1.1       dsieger  7676: <p>If a program is written in Java, use the Java framework in
                   7677:     pkgsrc.  The package must include
                   7678:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   7679:     provides the following variables:</p>
1.41      asau     7680: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7681: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1       dsieger  7682:       dependency on the JDK is added.  If
1.23      wiz      7683:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.1       dsieger  7684:       there is only a runtime dependency on the JDK.  The default is
1.23      wiz      7685:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.1       dsieger  7686:       JDK.</p></li>
1.23      wiz      7687: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1       dsieger  7688:       a package needs a Java2 implementation.  The supported values
1.23      wiz      7689:       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
                   7690:       <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
                   7691:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   7692:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.1       dsieger  7693:       above. This variable is not set by default.</p></li>
1.24      wiz      7694: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   7695:       automatically set to the runtime location of the used Java
                   7696:       implementation dependency. It may be used to set
                   7697:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   7698:       needs this variable to be defined.
                   7699:       </p></li>
1.1       dsieger  7700: </ul></div>
                   7701: </div>
1.41      asau     7702: <div class="sect2">
1.1       dsieger  7703: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7704: <a name="perl-scripts"></a>19.4.3. Packages containing perl scripts</h3></div></div></div>
1.1       dsieger  7705: <p>If your package contains interpreted perl scripts, add
1.23      wiz      7706:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.1       dsieger  7707:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   7708:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   7709:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74      wiz      7710:     that you want adjusted. Every occurrence of
                   7711:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   7712:     replaced with the full path to the perl executable.</p>
1.1       dsieger  7713: <p>If a particular version of perl is needed, set the
                   7714:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.23      wiz      7715:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.10      hubertf  7716: <p>See <a class="xref" href="#perl-modules" title="19.6.6. Packages installing perl modules">Section 19.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.1       dsieger  7717:     about handling perl modules.</p>
                   7718: </div>
1.41      asau     7719: <div class="sect2">
1.1       dsieger  7720: <div class="titlepage"><div><div><h3 class="title">
1.40      wiz      7721: <a name="shell-scripts"></a>19.4.4. Packages containing shell scripts</h3></div></div></div>
                   7722: <p><code class="varname">REPLACE_SH</code>,
                   7723:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   7724:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   7725:     hash bangs in files. Please use the appropriate one, prefering
                   7726:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74      wiz      7727:     Each should contain a list of scripts, relative to
                   7728:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   7729:     occurrence of the matching shell in a she-bang line will be
                   7730:     replaced with the full path to the shell executable.
1.40      wiz      7731:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   7732:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   7733: </div>
1.41      asau     7734: <div class="sect2">
1.40      wiz      7735: <div class="titlepage"><div><div><h3 class="title">
                   7736: <a name="other-programming-languages"></a>19.4.5. Other programming languages</h3></div></div></div>
1.1       dsieger  7737: <p>Currently, there is no special handling for other languages
                   7738:     in pkgsrc.  If a compiler package provides a
                   7739:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   7740:     just add a (build) dependency on the appropriate compiler
                   7741:     package.</p>
                   7742: </div>
                   7743: </div>
1.41      asau     7744: <div class="sect1">
1.1       dsieger  7745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   7746: <a name="fixes.build"></a>19.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  7747: <p>The most common failures when building a package are that
                   7748:        some platforms do not provide certain header files, functions or
                   7749:        libraries, or they provide the functions in a library that the
                   7750:        original package author didn't know. To work around this, you
                   7751:        can rewrite the source code in most cases so that it does not
                   7752:        use the missing functions or provides a replacement function.</p>
1.41      asau     7753: <div class="sect2">
1.1       dsieger  7754: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7755: <a name="fixes.build.cpp"></a>19.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  7756: <p>If a package already comes with a GNU configure script, the
                   7757:        preferred way to fix the build failure is to change the
                   7758:        configure script, not the code. In the other cases, you can
                   7759:        utilize the C preprocessor, which defines certain macros
                   7760:        depending on the operating system and hardware architecture it
                   7761:        compiles for. These macros can be queried using for example
                   7762:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   7763:        system, hardware architecture and compiler has its own macro.
                   7764:        For example, if the macros <code class="varname">__GNUC__</code>,
                   7765:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   7766:        are all defined, you know that you are using NetBSD on an i386
                   7767:        compatible CPU, and your compiler is GCC.</p>
                   7768: <p>The list of the following macros for hardware and
                   7769:        operating system depends on the compiler that is used. For
                   7770:        example, if you want to conditionally compile code on Solaris,
                   7771:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   7772:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41      asau     7773: <div class="sect3">
1.1       dsieger  7774: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   7775: <a name="fixes.build.cpp.os"></a>19.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1       dsieger  7776: <p>To distinguish between 4.4 BSD-derived systems and the
                   7777:         rest of the world, you should use the following code.</p>
                   7778: <pre class="programlisting">
                   7779: #include &lt;sys/param.h&gt;
                   7780: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   7781: /* BSD-specific code goes here */
                   7782: #else
                   7783: /* non-BSD-specific code goes here */
                   7784: #endif
                   7785: </pre>
                   7786: <p>If this distinction is not fine enough, you can also test
                   7787:        for the following macros.</p>
                   7788: <pre class="programlisting">
1.45      obache   7789: Cygwin      __CYGWIN__
                   7790: DragonFly   __DragonFly__
1.1       dsieger  7791: FreeBSD     __FreeBSD__
1.45      obache   7792: Haiku       __HAIKU__
1.1       dsieger  7793: Interix     __INTERIX
                   7794: IRIX        __sgi (TODO: get a definite source for this)
                   7795: Linux       linux, __linux, __linux__
1.83      dholland 7796: Mac OS X    __APPLE__
1.45      obache   7797: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   7798: Minix3      __minix
1.1       dsieger  7799: NetBSD      __NetBSD__
                   7800: OpenBSD     __OpenBSD__
                   7801: Solaris     sun, __sun
                   7802: </pre>
                   7803: </div>
1.41      asau     7804: <div class="sect3">
1.1       dsieger  7805: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   7806: <a name="fixes.build.cpp.arch"></a>19.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1       dsieger  7807: <pre class="programlisting">
                   7808: i386        i386, __i386, __i386__
                   7809: MIPS        __mips
                   7810: SPARC       sparc, __sparc
                   7811: </pre>
                   7812: </div>
1.41      asau     7813: <div class="sect3">
1.1       dsieger  7814: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   7815: <a name="fixes.build.cpp.compiler"></a>19.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1       dsieger  7816: <pre class="programlisting">
                   7817: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   7818: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   7819: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   7820: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   7821: </pre>
                   7822: </div>
                   7823: </div>
1.41      asau     7824: <div class="sect2">
1.1       dsieger  7825: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7826: <a name="compiler-bugs"></a>19.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  7827: <p>Some source files trigger bugs in the compiler, based on
                   7828:         combinations of compiler version and architecture and almost
                   7829:         always relation to optimisation being enabled.  Common symptoms
                   7830:         are gcc internal errors or never finishing compiling a
                   7831:        file.</p>
                   7832: <p>Typically, a workaround involves testing the
                   7833:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   7834:         optimisation for that combination of file,
1.87      tnn      7835:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   7836: <p>This used to be a big problem in the past, but is rarely
                   7837:        needed now as compiler technology has matured. If you still need
                   7838:        to add a compiler specific workaround, please do so in the file
                   7839:        <code class="filename">hacks.mk</code> and describe the symptom and
                   7840:        compiler version as detailed as possible.</p>
1.1       dsieger  7841: </div>
1.41      asau     7842: <div class="sect2">
1.1       dsieger  7843: <div class="titlepage"><div><div><h3 class="title">
1.23      wiz      7844: <a name="undefined-reference"></a>19.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
                   7845: </h3></div></div></div>
1.1       dsieger  7846: <p>This error message often means that a package did not
                   7847:        link to a shared library it needs. The following functions are
                   7848:        known to cause this error message over and over.</p>
                   7849: <div class="informaltable">
1.106     tnn      7850: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1       dsieger  7851: <colgroup>
                   7852: <col>
                   7853: <col>
                   7854: <col>
                   7855: </colgroup>
                   7856: <thead><tr>
                   7857: <th>Function</th>
                   7858: <th>Library</th>
                   7859: <th>Affected platforms</th>
                   7860: </tr></thead>
                   7861: <tbody>
                   7862: <tr>
                   7863: <td>accept, bind, connect</td>
                   7864: <td>-lsocket</td>
                   7865: <td>Solaris</td>
                   7866: </tr>
                   7867: <tr>
                   7868: <td>crypt</td>
                   7869: <td>-lcrypt</td>
                   7870: <td>DragonFly, NetBSD</td>
                   7871: </tr>
                   7872: <tr>
                   7873: <td>dlopen, dlsym</td>
                   7874: <td>-ldl</td>
                   7875: <td>Linux</td>
                   7876: </tr>
                   7877: <tr>
                   7878: <td>gethost*</td>
                   7879: <td>-lnsl</td>
                   7880: <td>Solaris</td>
                   7881: </tr>
                   7882: <tr>
                   7883: <td>inet_aton</td>
                   7884: <td>-lresolv</td>
                   7885: <td>Solaris</td>
                   7886: </tr>
                   7887: <tr>
                   7888: <td>nanosleep, sem_*, timer_*</td>
                   7889: <td>-lrt</td>
                   7890: <td>Solaris</td>
                   7891: </tr>
                   7892: <tr>
                   7893: <td>openpty</td>
                   7894: <td>-lutil</td>
                   7895: <td>Linux</td>
                   7896: </tr>
                   7897: </tbody>
                   7898: </table>
                   7899: </div>
                   7900: <p>To fix these linker errors, it is often sufficient to say
                   7901:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   7902:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10      hubertf  7903:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1       dsieger  7904:     bmake</strong></span>.</p>
1.41      asau     7905: <div class="sect3">
1.1       dsieger  7906: <div class="titlepage"><div><div><h4 class="title">
1.6       rillig   7907: <a name="undefined-reference-sunpro"></a>19.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  7908: <p>When you are using the SunPro compiler, there is another
                   7909: possibility. That compiler cannot handle the following code:</p>
                   7910: <pre class="programlisting">
                   7911: extern int extern_func(int);
                   7912: 
                   7913: static inline int
                   7914: inline_func(int x)
                   7915: {
                   7916:         return extern_func(x);
                   7917: }
                   7918: 
                   7919: int main(void)
                   7920: {
                   7921:         return 0;
                   7922: }
                   7923: </pre>
                   7924: <p>It generates the code for <code class="function">inline_func</code> even if
                   7925: that function is never used. This code then refers to
                   7926: <code class="function">extern_func</code>, which can usually not be resolved. To
                   7927: solve this problem you can try to tell the package to disable inlining
                   7928: of functions.</p>
                   7929: </div>
                   7930: </div>
1.41      asau     7931: <div class="sect2">
1.1       dsieger  7932: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7933: <a name="out-of-memory"></a>19.5.4. Running out of memory</h3></div></div></div>
1.1       dsieger  7934: <p>Sometimes packages fail to build because the compiler runs
                   7935:     into an operating system specific soft limit.  With the
                   7936:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94      wiz      7937:     to unlimit the resources.  Currently, the allowed values are any combination of
                   7938:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   7939:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span>.
1.1       dsieger  7940:     Setting this variable is similar to running the shell builtin
1.10      hubertf  7941:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  7942:     segment size or maximum stack size of a process, respectively, to
                   7943:     their hard limits.</p>
                   7944: </div>
                   7945: </div>
1.41      asau     7946: <div class="sect1">
1.1       dsieger  7947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   7948: <a name="fixes.install"></a>19.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41      asau     7949: <div class="sect2">
1.1       dsieger  7950: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7951: <a name="install-scripts"></a>19.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  7952: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  7953:     with some operating systems cannot create more than one
                   7954:     directory at a time. As such, you should call
                   7955:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   7956: <pre class="programlisting">
                   7957: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   7958: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111     sevan    7959: </pre>
1.23      wiz      7960: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   7961:     dir2</code></span>&#8221;</span> to the
1.1       dsieger  7962:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   7963:     automatically do the right thing.</p>
                   7964: </div>
1.41      asau     7965: <div class="sect2">
1.1       dsieger  7966: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7967: <a name="where-to-install-documentation"></a>19.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  7968: <p>In general, documentation should be installed into
                   7969:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   7970:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   7971:     includes the version number of the package).</p>
                   7972: <p>Many modern packages using GNU autoconf allow to set the
                   7973:     directory where HTML documentation is installed with the
1.23      wiz      7974:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.1       dsieger  7975:     is needed because otherwise the documentation ends up in
                   7976:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   7977:     places.</p>
                   7978: <p>An exception to the above is that library API documentation
1.120     sevan    7979:     generated with the <a href="http://cdn.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.1       dsieger  7980:     browsers (devhelp) should be left at their default location, which
                   7981:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   7982:     documentation can be recognized from files ending in
                   7983:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   7984:     (It is also acceptable to install such files in
                   7985:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   7986:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   7987:     <code class="filename">.devhelp*</code> file must be directly in that
                   7988:     directory then, no additional subdirectory level is allowed in
                   7989:     this case. This is usually achieved by using
1.23      wiz      7990:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.1       dsieger  7991:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   7992:     though.)</p>
                   7993: </div>
1.41      asau     7994: <div class="sect2">
1.1       dsieger  7995: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   7996: <a name="installing-score-files"></a>19.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  7997: <p>Certain packages, most of them in the games category, install
                   7998:     a score file that allows all users on the system to record their
                   7999:     highscores.  In order for this to work, the binaries need to be
                   8000:     installed setgid and the score files owned by the appropriate
1.35      wiz      8001:     group and/or owner (traditionally the "games" user/group).  Set
                   8002:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1       dsieger  8003:     following variables, documented in more detail in
                   8004:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.35      wiz      8005:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8006:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100     leot     8007:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8008:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8009:     <code class="varname">GAMEDATA_PERMS</code> and
                   8010:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8011: <p>An example that illustrates some of the variables described above is
                   8012:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8013:     used to properly set directory permissions of the directory where the
                   8014:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8015:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8016:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8017:     binary:</p>
                   8018: <pre class="programlisting">
1.112     rillig   8019: USE_GAMESGROUP=         yes
1.100     leot     8020: 
1.112     rillig   8021: BUILD_DEFS+=            VARBASE
1.100     leot     8022: 
1.112     rillig   8023: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8024: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8025: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111     sevan    8026: </pre>
1.100     leot     8027: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8028:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8029:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8030:     needed to be accessed by setgid games and
                   8031:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14      jmcneill 8032: <p>A package should therefore never hard code file ownership or
1.100     leot     8033:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8034:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8035:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8036:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1       dsieger  8037: </div>
1.41      asau     8038: <div class="sect2">
1.1       dsieger  8039: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8040: <a name="destdir-support"></a>19.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 8041: <p><code class="varname">DESTDIR</code> support means that a package
                   8042:     installs into a staging directory, not the final location of the
                   8043:     files. Then a binary package is created which can be used for
                   8044:     installation as usual. There are two ways: Either the package must
1.23      wiz      8045:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8046:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.41      asau     8047: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8048: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113     leot     8049:       set to <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>.
                   8050:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38      wiz      8051:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8052:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14      jmcneill 8053:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8054:       the inclusion.</p></li>
1.23      wiz      8055: <li class="listitem"><p>All installation operations have to be prefixed with
1.4       rillig   8056:       <code class="filename">${DESTDIR}</code>.</p></li>
1.23      wiz      8057: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4       rillig   8058:       automatically. Many manual rules and pre/post-install often are
                   8059:       incorrect; fix them.</p></li>
1.23      wiz      8060: <li class="listitem"><p>If files are installed with special owner/group
1.17      imil     8061:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23      wiz      8062: <li class="listitem"><p>In general, packages should support
1.4       rillig   8063:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8064:       DESTDIR.</p></li>
                   8065: </ul></div>
                   8066: </div>
1.41      asau     8067: <div class="sect2">
1.4       rillig   8068: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8069: <a name="hardcoded-paths"></a>19.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8070: <p>Your package may also contain scripts with hardcoded paths to
                   8071:       other interpreters besides (or as well as) perl.  To correct the
                   8072:       full pathname to the script interpreter, you need to set the
                   8073:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  8074:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  8075: <pre class="programlisting">
                   8076: REPLACE_INTERPRETER+=   tcl
                   8077: REPLACE.tcl.old=        .*/bin/tclsh
                   8078: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8079: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8080: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111     sevan    8081: </pre>
1.41      asau     8082: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8083: <h3 class="title">Note</h3>
                   8084: <p>Before March 2006, these variables were called
                   8085:     <code class="varname">_REPLACE.*</code> and
                   8086:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8087: </div>
                   8088: </div>
1.41      asau     8089: <div class="sect2">
1.1       dsieger  8090: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8091: <a name="perl-modules"></a>19.6.6. Packages installing perl modules</h3></div></div></div>
1.1       dsieger  8092: <p>Makefiles of packages providing perl5 modules should include
                   8093:     the Makefile fragment
                   8094:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  8095:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  8096:     configuration for such modules as well as various hooks to tune
                   8097:     this configuration.  See comments in this file for
                   8098:     details.</p>
                   8099: <p>Perl5 modules will install into different places depending
                   8100:     on the version of perl used during the build process.  To
                   8101:     address this, pkgsrc will append lines to the
                   8102:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8103:     the installed <code class="filename">.packlist</code> file generated by
                   8104:     most perl5 modules.  This is invoked by defining
                   8105:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47      wiz      8106:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8107:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8108:     e.g.:</p>
1.1       dsieger  8109: <pre class="programlisting">
1.47      wiz      8110: PERL5_PACKLIST= auto/Pg/.packlist
1.111     sevan    8111: </pre>
1.47      wiz      8112: <p>The perl5 config variables
                   8113:     <code class="varname">installarchlib</code>,
                   8114:     <code class="varname">installscript</code>,
                   8115:     <code class="varname">installvendorbin</code>,
                   8116:     <code class="varname">installvendorscript</code>,
                   8117:     <code class="varname">installvendorarch</code>,
                   8118:     <code class="varname">installvendorlib</code>,
                   8119:     <code class="varname">installvendorman1dir</code>, and
                   8120:     <code class="varname">installvendorman3dir</code> represent those
                   8121:     locations in which components of perl5 modules may be installed,
                   8122:     provided as variable with uppercase and prefixed with
                   8123:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8124:     and may be used by perl5 packages that don't have a packlist.
                   8125:     These variables are also substituted for in the
                   8126:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8127:     <code class="varname">PERL5_SUB_</code>.</p>
1.1       dsieger  8128: </div>
1.41      asau     8129: <div class="sect2">
1.1       dsieger  8130: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8131: <a name="faq.info-files"></a>19.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  8132: <p>Some packages install info files or use the
1.23      wiz      8133:     <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.1       dsieger  8134:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8135:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8136:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8137:     handle registration of the info files in the Info directory
1.23      wiz      8138:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.1       dsieger  8139:     files registration is either provided by the system, or by a
                   8140:     special purpose package automatically added as dependency if
                   8141:     needed.</p>
                   8142: <p><code class="varname">PKGINFODIR</code> is the directory under
                   8143:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8144:     located. <code class="varname">PKGINFODIR</code> defaults to
1.23      wiz      8145:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.1       dsieger  8146: <p>The info files for the package should be listed in the
                   8147:     package <code class="filename">PLIST</code>; however any split info files
                   8148:     need not be listed.</p>
1.23      wiz      8149: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8150:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.1       dsieger  8151:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23      wiz      8152:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.1       dsieger  8153:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8154:     variable in the package <code class="filename">Makefile</code>. By
                   8155:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  8156:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  8157:     does not match the required minimum, a build dependency on the
1.120     sevan    8158:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1       dsieger  8159:     be added automatically.</p>
                   8160: <p>The build and installation process of the software provided
                   8161:     by the package should not use the
1.10      hubertf  8162:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  8163:     info files is the task of the package
                   8164:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  8165:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  8166: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  8167:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8168:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  8169:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  8170: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  8171:     no effect except the logging of a message. The script overriding
1.10      hubertf  8172:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  8173:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  8174:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  8175: </div>
1.41      asau     8176: <div class="sect2">
1.1       dsieger  8177: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8178: <a name="manpages"></a>19.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  8179: <p>All packages that install manual pages should install them
                   8180:     into the same directory, so that there is one common place to look
                   8181:     for them. In pkgsrc, this place is
                   8182:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8183:     should be used in packages. The default for
                   8184:     <code class="varname">PKGMANDIR</code> is
1.23      wiz      8185:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8186:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.41      asau     8187: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8188: <h3 class="title">Note</h3>
                   8189: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8190:     is far from complete.</p>
                   8191: </div>
                   8192: <p>The <code class="filename">PLIST</code> files can just use
                   8193:     <code class="filename">man/</code> as the top level directory for the man
                   8194:     page file entries, and the pkgsrc framework will convert as
                   8195:     needed. In all other places, the correct
                   8196:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8197: <p>Packages that are
                   8198:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23      wiz      8199:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.1       dsieger  8200:     <code class="filename">./configure</code>
                   8201:     --mandir switch to set where the man pages should be installed.
                   8202:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8203:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8204: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8205:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23      wiz      8206:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.1       dsieger  8207:     Or if the <code class="filename">./configure</code> script uses
                   8208:     a non-standard use of --mandir, you can set
                   8209:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.10      hubertf  8210: <p>See <a class="xref" href="#manpage-compression" title="13.5. Man page compression">Section 13.5, &#8220;Man page compression&#8221;</a> for
1.1       dsieger  8211:     information on installation of compressed manual pages.</p>
                   8212: </div>
1.41      asau     8213: <div class="sect2">
1.1       dsieger  8214: <div class="titlepage"><div><div><h3 class="title">
1.7       rillig   8215: <a name="gconf-data-files"></a>19.6.9. Packages installing GConf data files</h3></div></div></div>
1.1       dsieger  8216: <p>If a package installs <code class="filename">.schemas</code> or
1.7       rillig   8217:     <code class="filename">.entries</code> files, used by GConf,
1.1       dsieger  8218:     you need to take some extra steps to make sure they get registered
                   8219:     in the database:</p>
1.23      wiz      8220: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8221: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1       dsieger  8222:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.7       rillig   8223:        takes care of rebuilding the GConf database at installation and
1.1       dsieger  8224:        deinstallation time, and tells the package where to install
1.7       rillig   8225:        GConf data files using some standard configure arguments.  It
1.1       dsieger  8226:        also disallows any access to the database directly from the
                   8227:        package.</p></li>
1.23      wiz      8228: <li class="listitem"><p>Ensure that the package installs its
1.1       dsieger  8229:        <code class="filename">.schemas</code> files under
                   8230:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8231:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8232:        need to manually patch the package.</p></li>
1.23      wiz      8233: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1       dsieger  8234:        directory, as they will be handled automatically.  See
1.84      wiz      8235:        <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.23      wiz      8236: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1       dsieger  8237:        your <code class="filename">Makefile</code> with a list of all
                   8238:        <code class="filename">.schemas</code> files installed by the package, if
                   8239:        any.  Names must not contain any directories in them.</p></li>
1.23      wiz      8240: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1       dsieger  8241:        your <code class="filename">Makefile</code> with a
                   8242:        list of all <code class="filename">.entries</code> files installed by the
                   8243:        package, if any. Names must not contain any directories in
                   8244:        them.</p></li>
                   8245: </ol></div>
                   8246: </div>
1.41      asau     8247: <div class="sect2">
1.1       dsieger  8248: <div class="titlepage"><div><div><h3 class="title">
1.18      snj      8249: <a name="scrollkeeper-data-files"></a>19.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1       dsieger  8250: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18      snj      8251:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1       dsieger  8252:     get registered in the database:</p>
1.23      wiz      8253: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8254: <li class="listitem"><p>Include
1.18      snj      8255:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   8256:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.1       dsieger  8257:        takes care of rebuilding the scrollkeeper database at
                   8258:        installation and deinstallation time, and disallows any access
                   8259:        to it directly from the package.</p></li>
1.23      wiz      8260: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  8261:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8262:        will be handled automatically.</p></li>
1.23      wiz      8263: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18      snj      8264:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   8265:        print-PLIST</strong></span> does this automatically.)</p></li>
1.1       dsieger  8266: </ol></div>
                   8267: </div>
1.41      asau     8268: <div class="sect2">
1.1       dsieger  8269: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8270: <a name="x11-fonts"></a>19.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  8271: <p>If a package installs font files, you will need to rebuild
                   8272:     the fonts database in the directory where they get installed at
                   8273:     installation and deinstallation time.  This can be automatically
                   8274:     done by using the pkginstall framework.</p>
                   8275: <p>You can list the directories where fonts are installed in the
                   8276:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8277:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23      wiz      8278:     <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.1       dsieger  8279:     Also make sure that the database file
                   8280:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   8281: <p>Note that you should not create new directories for fonts;
                   8282:     instead use the standard ones to avoid that the user needs to
                   8283:     manually configure his X server to find them.</p>
                   8284: </div>
1.41      asau     8285: <div class="sect2">
1.1       dsieger  8286: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8287: <a name="gtk2-modules"></a>19.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1       dsieger  8288: <p>If a package installs GTK2 immodules or loaders, you need to
                   8289:     take some extra steps to get them registered in the GTK2 database
                   8290:     properly:</p>
1.23      wiz      8291: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8292: <li class="listitem"><p>Include
1.1       dsieger  8293:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8294:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8295:       rebuilding the database at installation and deinstallation time.</p></li>
1.23      wiz      8296: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1       dsieger  8297:       your package installs GTK2 immodules.</p></li>
1.23      wiz      8298: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1       dsieger  8299:       GTK2 loaders.</p></li>
1.23      wiz      8300: <li class="listitem">
1.1       dsieger  8301: <p>Patch the package to not touch any of the GTK2
                   8302:       databases directly.  These are:</p>
1.41      asau     8303: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8304: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8305: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1       dsieger  8306: </ul></div>
                   8307: </li>
1.23      wiz      8308: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1       dsieger  8309:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8310:       directory, as they will be handled automatically.</p></li>
                   8311: </ol></div>
                   8312: </div>
1.41      asau     8313: <div class="sect2">
1.1       dsieger  8314: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8315: <a name="sgml-xml-data"></a>19.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  8316: <p>If a package installs SGML or XML data files that need to be
                   8317:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8318:     etc.), you need to take some extra steps:</p>
1.23      wiz      8319: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8320: <li class="listitem"><p>Include
1.1       dsieger  8321:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8322:        your <code class="filename">Makefile</code>, which takes care of
                   8323:        registering those files in system-wide catalogs at
                   8324:        installation and deinstallation time.</p></li>
1.23      wiz      8325: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1       dsieger  8326:        any SGML catalogs installed by the package.</p></li>
1.23      wiz      8327: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1       dsieger  8328:        any XML catalogs installed by the package.</p></li>
1.23      wiz      8329: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1       dsieger  8330:        to be added to the SGML catalog.  These come in groups of
                   8331:        three strings; see xmlcatmgr(1) for more information
                   8332:        (specifically, arguments recognized by the 'add' action).
                   8333:        Note that you will normally not use this variable.</p></li>
1.23      wiz      8334: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1       dsieger  8335:        to be added to the XML catalog.  These come in groups of three
                   8336:        strings; see xmlcatmgr(1) for more information (specifically,
                   8337:        arguments recognized by the 'add' action).  Note that you will
                   8338:        normally not use this variable.</p></li>
                   8339: </ol></div>
                   8340: </div>
1.41      asau     8341: <div class="sect2">
1.1       dsieger  8342: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8343: <a name="mime-database"></a>19.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  8344: <p>If a package provides extensions to the MIME database by
                   8345:     installing <code class="filename">.xml</code> files inside
                   8346:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8347:     need to take some extra steps to ensure that the database is kept
                   8348:     consistent with respect to these new files:</p>
1.23      wiz      8349: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8350: <li class="listitem"><p>Include
1.1       dsieger  8351:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8352:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8353:        this same directory, which is reserved for inclusion from
                   8354:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8355:        care of rebuilding the MIME database at installation and
                   8356:        deinstallation time, and disallows any access to it directly
                   8357:        from the package.</p></li>
1.23      wiz      8358: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  8359:        <code class="filename">share/mime</code> directory,
                   8360:        <span class="emphasis"><em>except</em></span> for files saved under
                   8361:        <code class="filename">share/mime/packages</code>.  The former are
                   8362:        handled automatically by
                   8363:        the update-mime-database program, but the latter are
                   8364:        package-dependent and must be removed by the package that
                   8365:        installed them in the first place.</p></li>
1.23      wiz      8366: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1       dsieger  8367:        from the PLIST.  They will be handled by the shared-mime-info
                   8368:        package.</p></li>
                   8369: </ol></div>
                   8370: </div>
1.41      asau     8371: <div class="sect2">
1.1       dsieger  8372: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8373: <a name="intltool"></a>19.6.15. Packages using intltool</h3></div></div></div>
1.1       dsieger  8374: <p>If a package uses intltool during its build, add
                   8375:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   8376:     which forces it to use the intltool package provided by pkgsrc,
                   8377:     instead of the one bundled with the distribution file.</p>
                   8378: <p>This tracks intltool's build-time dependencies and uses the
                   8379:     latest available version; this way, the package benefits of any
                   8380:     bug fixes that may have appeared since it was released.</p>
                   8381: </div>
1.41      asau     8382: <div class="sect2">
1.1       dsieger  8383: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8384: <a name="startup-scripts"></a>19.6.16. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  8385: <p>If a package contains a rc.d script, it won't be copied into
                   8386:     the startup directory by default, but you can enable it, by adding
                   8387:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  8388:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  8389:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   8390:     it will automatically remove the scripts when the package is
                   8391:     deinstalled.</p>
                   8392: </div>
1.41      asau     8393: <div class="sect2">
1.1       dsieger  8394: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8395: <a name="tex-packages"></a>19.6.17. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  8396: <p>If a package installs TeX packages into the texmf tree,
                   8397:     the <code class="filename">ls-R</code> database of the tree needs to be
                   8398:     updated.</p>
1.41      asau     8399: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8400: <h3 class="title">Note</h3>
1.22      jakllsch 8401: <p>Except the main TeX packages such as kpathsea,
1.1       dsieger  8402:     packages should install files
1.22      jakllsch 8403:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8404:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1       dsieger  8405: </div>
1.23      wiz      8406: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8407: <li class="listitem"><p>Include
1.22      jakllsch 8408:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.1       dsieger  8409:       takes care of rebuilding the <code class="filename">ls-R</code>
                   8410:       database at installation and deinstallation time.</p></li>
1.23      wiz      8411: <li class="listitem">
1.1       dsieger  8412: <p>If your package installs files into a texmf
                   8413:       tree other than the one
1.22      jakllsch 8414:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8415:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1       dsieger  8416:       trees that need database update.</p>
                   8417: <p>If your package also installs font map files that need
1.10      hubertf  8418:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.29      dholland 8419:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22      jakllsch 8420:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   8421:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10      hubertf  8422:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  8423:       be run automatically at installation/deinstallation to
                   8424:       enable/disable font map files for TeX output
                   8425:       drivers.</p>
                   8426: </li>
1.23      wiz      8427: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1       dsieger  8428:       databases are included in <code class="filename">PLIST</code>, as
1.29      dholland 8429:       they will be removed only by the kpathsea package.</p></li>
1.1       dsieger  8430: </ol></div>
                   8431: </div>
1.41      asau     8432: <div class="sect2">
1.1       dsieger  8433: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8434: <a name="emulation-packages"></a>19.6.18. Packages supporting running binaries in
1.1       dsieger  8435:     emulation</h3></div></div></div>
                   8436: <p>There are some packages that provide libraries and
                   8437:     executables for running binaries from a one operating system
                   8438:     on a different one (if the latter supports it).  One example
                   8439:     is running Linux binaries on NetBSD.</p>
1.120     sevan    8440: <p>The <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1       dsieger  8441:     helps in extracting and packaging Linux rpm packages.</p>
                   8442: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10      hubertf  8443:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  8444:     if all libraries for each installed executable can be found by
                   8445:     the dynamic linker.  Since the standard dynamic linker is run,
                   8446:     this fails for emulation packages, because the libraries used
                   8447:     by the emulation are not in the standard directories.</p>
                   8448: </div>
1.41      asau     8449: <div class="sect2">
1.1       dsieger  8450: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8451: <a name="hicolor-theme"></a>19.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1       dsieger  8452: <p>If a package installs images under the
                   8453:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   8454:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   8455:     database, you need to take some extra steps to make sure that the
                   8456:     shared theme directory is handled appropriately and that the cache
                   8457:     database is rebuilt:</p>
1.23      wiz      8458: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8459: <li class="listitem"><p>Include
1.1       dsieger  8460:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23      wiz      8461: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1       dsieger  8462:        entry that refers to the theme cache.</p></li>
1.23      wiz      8463: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1       dsieger  8464:          directories from the <code class="filename">share/icons/hicolor</code>
                   8465:          hierarchy because they will be handled automatically.</p></li>
                   8466: </ol></div>
                   8467: <p>The best way to verify that the PLIST is correct with
                   8468:       respect to the last two points is to regenerate it using
1.10      hubertf  8469:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1       dsieger  8470: </div>
1.41      asau     8471: <div class="sect2">
1.1       dsieger  8472: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   8473: <a name="desktop-files"></a>19.6.20. Packages installing desktop files</h3></div></div></div>
1.1       dsieger  8474: <p>If a package installs <code class="filename">.desktop</code> files
                   8475:       under <code class="filename">share/applications</code> and these include
1.53      rodent   8476:       MIME information (MimeType key), you need to take extra steps to
                   8477:       ensure that they are registered into the MIME database:</p>
1.23      wiz      8478: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8479: <li class="listitem"><p>Include
1.1       dsieger  8480:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23      wiz      8481: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1       dsieger  8482:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   8483:          It will be handled automatically.</p></li>
                   8484: </ol></div>
                   8485: <p>The best way to verify that the PLIST is correct with
1.10      hubertf  8486:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.1       dsieger  8487:       print-PLIST</strong></span>.</p>
                   8488: </div>
                   8489: </div>
1.41      asau     8490: <div class="sect1">
1.1       dsieger  8491: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8492: <a name="punting"></a>19.7. Marking packages as having problems</h2></div></div></div>
1.1       dsieger  8493: <p>In some cases one does not have the time to solve a problem
1.22      jakllsch 8494:   immediately. In this case, one can plainly mark a package as broken.  For
                   8495:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   8496:   reason why the package is broken (similar to the
                   8497:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   8498:   the package will immediately be shown this message, and the build
                   8499:   will not be even tried.</p>
                   8500: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1       dsieger  8501:   intervals.</p>
                   8502: </div>
                   8503: </div>
1.41      asau     8504: <div class="chapter">
1.1       dsieger  8505: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   8506: <a name="debug"></a>Chapter 20. Debugging</h2></div></div></div>
1.1       dsieger  8507: <p>To check out all the gotchas when building a package, here are
                   8508:   the steps that I do in order to get a package working.  Please note
                   8509:   this is basically the same as what was explained in the previous
                   8510:   sections, only with some debugging aids.</p>
1.41      asau     8511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8512: <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>
                   8513: <li class="listitem">
1.120     sevan    8514: <p>Install <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.1       dsieger  8515:       create a directory for a new package, change into it, then run
1.10      hubertf  8516:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.1       dsieger  8517: <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>
                   8518: <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>
                   8519: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   8520: </li>
1.23      wiz      8521: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   8522: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   8523: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   8524: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1       dsieger  8525:       configure step to the package's
                   8526:       <code class="filename">Makefile</code>.</p></li>
1.23      wiz      8527: <li class="listitem">
1.1       dsieger  8528: <p>Make the package compile, doing multiple rounds of</p>
                   8529: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   8530: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   8531: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   8532: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   8533: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   8534: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   8535: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   8536: <p>Doing this step as non-root user will ensure that no files
                   8537:       are modified that shouldn't be, especially during the build
1.10      hubertf  8538:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   8539:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.120     sevan    8540:       from the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>
1.1       dsieger  8541:       package.</p>
                   8542: </li>
1.23      wiz      8543: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
                   8544:       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>
                   8545: <li class="listitem">
1.1       dsieger  8546: <p>Generate a <code class="filename">PLIST</code>:</p>
                   8547: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8548: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   8549: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   8550: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8551: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
                   8552: <p>You usually need to be <code class="username">root</code> to do
                   8553:       this.  Look if there are any files left:</p>
                   8554: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8555: <p>If this reveals any files that are missing in
                   8556:       <code class="filename">PLIST</code>, add them.</p>
                   8557: </li>
1.23      wiz      8558: <li class="listitem">
1.1       dsieger  8559: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   8560:       package again and make a binary package:</p>
                   8561: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   8562: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   8563: </li>
1.23      wiz      8564: <li class="listitem">
1.1       dsieger  8565: <p>Delete the installed package:</p>
                   8566: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
                   8567: </li>
1.23      wiz      8568: <li class="listitem">
1.10      hubertf  8569: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  8570:       command, which shouldn't find anything now:</p>
                   8571: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8572: </li>
1.23      wiz      8573: <li class="listitem">
1.1       dsieger  8574: <p>Reinstall the binary package:</p>
                   8575: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
                   8576: </li>
1.23      wiz      8577: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   8578: <li class="listitem">
1.120     sevan    8579: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.1       dsieger  8580:       reports:</p>
                   8581: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   8582: </li>
1.23      wiz      8583: <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.1       dsieger  8584: </ul></div>
                   8585: </div>
1.41      asau     8586: <div class="chapter">
1.1       dsieger  8587: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   8588: <a name="submit"></a>Chapter 21. Submitting and Committing</h2></div></div></div>
1.1       dsieger  8589: <div class="toc">
                   8590: <p><b>Table of Contents</b></p>
1.100     leot     8591: <dl class="toc">
1.6       rillig   8592: <dt><span class="sect1"><a href="#submitting-binary-packages">21.1. Submitting binary packages</a></span></dt>
                   8593: <dt><span class="sect1"><a href="#submitting-your-package">21.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   8594: <dt><span class="sect1"><a href="#general-notes-for-changes">21.3. General notes when adding, updating, or removing packages</a></span></dt>
1.130     wiz      8595: <dt><span class="sect1"><a href="#commit-messages">21.4. Commit Messages</a></span></dt>
                   8596: <dt><span class="sect1"><a href="#committing-importing">21.5. Committing: Adding a package to CVS</a></span></dt>
                   8597: <dt><span class="sect1"><a href="#updating-package">21.6. Updating a package to a newer version</a></span></dt>
                   8598: <dt><span class="sect1"><a href="#renaming-package">21.7. Renaming a package in pkgsrc</a></span></dt>
                   8599: <dt><span class="sect1"><a href="#moving-package">21.8. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  8600: </dl>
                   8601: </div>
1.41      asau     8602: <div class="sect1">
1.1       dsieger  8603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8604: <a name="submitting-binary-packages"></a>21.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  8605: <p>Our policy is that we accept binaries only from pkgsrc
                   8606:        developers to guarantee that the packages don't contain any
                   8607:        trojan horses etc. This is not to annoy anyone but rather to
                   8608:        protect our users! You're still free to put up your home-made
                   8609:        binary packages and tell the world where to get them. NetBSD
                   8610:        developers doing bulk builds and wanting to upload them please
1.66      asau     8611:        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
                   8612: builds)</i></a>.</p>
1.1       dsieger  8613: </div>
1.41      asau     8614: <div class="sect1">
1.1       dsieger  8615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8616: <a name="submitting-your-package"></a>21.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  8617: <p>First, check that your package is complete, compiles and
1.10      hubertf  8618:        runs well; see <a class="xref" href="#debug" title="Chapter 20. Debugging">Chapter 20, <i>Debugging</i></a> and the rest of this
1.125     leot     8619:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1       dsieger  8620:        archive that contains all files that make up the package.
                   8621:        Finally, send this package to the pkgsrc bug tracking system,
1.125     leot     8622:        either with the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1       dsieger  8623:        that, go to the web page
1.10      hubertf  8624:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.21      snj      8625:        which contains some instructions and a link to a form where you
                   8626:        can submit packages.  The
1.120     sevan    8627:        <a href="http://cdn.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.21      snj      8628:        also available as a substitute for either of the above two tools.
                   8629:        </p>
1.1       dsieger  8630: <p>In the form of the problem report, the category should be
1.23      wiz      8631:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.1       dsieger  8632:        and version number, and the description field should contain a
                   8633:        short description of your package (contents of the COMMENT
                   8634:        variable or DESCR file are OK). The uuencoded package data should
1.23      wiz      8635:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.1       dsieger  8636: <p>If you want to submit several packages, please send a
                   8637:        separate PR for each one, it's easier for us to track things
                   8638:        that way.</p>
                   8639: <p>Alternatively, you can also import new packages into
1.23      wiz      8640:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.105     wiz      8641:        homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1       dsieger  8642:        for details.</p>
                   8643: </div>
1.41      asau     8644: <div class="sect1">
1.1       dsieger  8645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   8646: <a name="general-notes-for-changes"></a>21.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  8647: <p>Please note all package additions, updates, moves, and
                   8648:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   8649:        important to keep this file up to date and conforming to the
                   8650:        existing format, because it will be used by scripts to
1.10      hubertf  8651:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  8652:        sites. Additionally, check the
                   8653:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   8654:        for the package you updated or removed, in case it was mentioned
                   8655:        there.</p>
                   8656: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   8657:        bumped, the change should appear in
                   8658:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   8659:        related or otherwise relevant. Mass bumps that result from a
                   8660:        dependency being updated should not be mentioned. In all other
                   8661:        cases it's the developer's decision.</p>
                   8662: <p>There is a make target that helps in creating proper
1.10      hubertf  8663:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  8664:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   8665:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   8666:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   8667:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  8668:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   8669:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  8670:   For new packages, or package moves or removals, set the
                   8671:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   8672:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  8673:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22      jakllsch 8674:   not the same as your NetBSD login name. The target also automatically
                   8675:   removes possibly existing entries for the package in the
                   8676:   <code class="filename">TODO</code> file. Don't forget to commit
1.66      asau     8677:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22      jakllsch 8678:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
                   8679:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   8680:   makes the cvs commands use the main repository.
                   8681:   </p>
1.1       dsieger  8682: </div>
1.41      asau     8683: <div class="sect1">
1.1       dsieger  8684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.130     wiz      8685: <a name="commit-messages"></a>21.4. Commit Messages</h2></div></div></div>
                   8686: <p>For several years, there have been mirrors of pkgsrc in
                   8687:   fossil, git, and hg. Standard practise when using these tools is to
                   8688:   make the first line of a commit message function as a summary that
                   8689:   can be read without the rest, such as is commonly done with "git log
                   8690:   --oneline". For this reason, we have the following guidelines for
                   8691:   pkgsrc commit messages:</p>
                   8692: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8693: <li class="listitem"><p>Start the commit message with a line that explains the
1.131   ! wiz      8694:     big picture in 65 characters or less. When a commit is for one
1.130     wiz      8695:     package, include the name of the package. For updates, include the
                   8696:     version to which it is updated.</p></li>
                   8697: <li class="listitem"><p>Leave the next line empty.</p></li>
                   8698: <li class="listitem"><p>Then come the details for the commit (changes in that
                   8699:     package, reason for a change) and any relevant PRs. Wrap this
                   8700:     section.</p></li>
                   8701: </ul></div>
                   8702: <p>Here is an example:
                   8703:   </p>
                   8704: <pre class="programlisting">
                   8705:   libxslt: update to 1.0.30
                   8706: 
                   8707:   Changes since 1.0.29:
                   8708:   ...
                   8709:   </pre>
                   8710: <p>
                   8711:   </p>
                   8712: <p>Here is another example:
                   8713:   </p>
                   8714: <pre class="programlisting">
                   8715:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   8716: 
                   8717:   (rationale)
                   8718:   </pre>
                   8719: <p>
                   8720:   </p>
                   8721: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   8722:   allowed on the pkgsrc repository to change commit messages.</p>
                   8723: </div>
                   8724: <div class="sect1">
                   8725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   8726: <a name="committing-importing"></a>21.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1       dsieger  8727: <p>This section is only of interest for pkgsrc developers with write
1.33      wiz      8728:   access to the pkgsrc repository.</p>
                   8729: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   8730: Start by adding the directory and then files in the directory. Don't
                   8731: forget to add the new package to the category's
                   8732: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   8733: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   8734: <pre class="programlisting">
                   8735: <code class="prompt">$</code> cd .../pkgsrc/category
                   8736: <code class="prompt">$</code> cvs add pkgname
                   8737: <code class="prompt">$</code> cd pkgname
                   8738: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   8739: <code class="prompt">$</code> cvs add patches/p*
                   8740: <code class="prompt">$</code> cvs status | less
1.34      wiz      8741: <code class="prompt">$</code> cvs commit
1.33      wiz      8742: <code class="prompt">$</code> cd ..
                   8743: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34      wiz      8744: <code class="prompt">$</code> cvs commit Makefile
1.66      asau     8745: <code class="prompt">$</code> cd pkgname
1.73      jnemeth  8746: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33      wiz      8747: </pre>
1.1       dsieger  8748: <p>The commit message of the initial import should include part of the
                   8749:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   8750:   what the package is/does.</p>
1.33      wiz      8751: <p>Also mention the new package in
                   8752: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   8753: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   8754: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.1       dsieger  8755: </div>
1.41      asau     8756: <div class="sect1">
1.1       dsieger  8757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.130     wiz      8758: <a name="updating-package"></a>21.6. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  8759: <p>Please always put a concise, appropriate and relevant summary of the
                   8760:   changes between old and new versions into the commit log when updating
                   8761:   a package. There are various reasons for this:</p>
1.41      asau     8762: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8763: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1       dsieger  8764:   or its information may be overwritten by newer information.</p></li>
1.23      wiz      8765: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  8766:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23      wiz      8767: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  8768:   repository is very useful for people who read the pkgsrc-changes mailing
                   8769:   list, so that they can make tactical decisions about when to upgrade
                   8770:   the package.</p></li>
                   8771: </ul></div>
                   8772: <p>Please also recognize that, just because a new version of a package
                   8773:   has been released, it should not automatically be upgraded in the CVS
                   8774:   repository.  We prefer to be conservative in the packages that are
                   8775:   included in pkgsrc - development or beta packages are not really the
                   8776:   best thing for most places in which pkgsrc is used. Please use your
                   8777:   judgement about what should go into pkgsrc, and bear in mind that
                   8778:   stability is to be preferred above new and possibly untested features.</p>
                   8779: </div>
1.41      asau     8780: <div class="sect1">
1.1       dsieger  8781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.130     wiz      8782: <a name="renaming-package"></a>21.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20      snj      8783: <p>Renaming packages is not recommended.</p>
                   8784: <p>When renaming packages, be sure to fix any references to old name
                   8785:   in other Makefiles, options, buildlink files, etc.</p>
                   8786: <p>Also When renaming a package, please define
                   8787:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   8788:   pattern(s) of the previous package name.
                   8789:   This may be repeated for multiple renames.
                   8790:   The new package would be an exact replacement.
                   8791: </p>
1.23      wiz      8792: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.20      snj      8793:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   8794:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   8795:   not be an exact replacement but is a suggestion for the replaced
                   8796:   functionality.</p>
                   8797: </div>
1.41      asau     8798: <div class="sect1">
1.20      snj      8799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.130     wiz      8800: <a name="moving-package"></a>21.8. Moving a package in pkgsrc</h2></div></div></div>
1.20      snj      8801: <p>It is preferred that packages are not renamed or moved, but if needed
                   8802:   please follow these steps.
                   8803: </p>
1.23      wiz      8804: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8805: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   8806: <li class="listitem">
1.1       dsieger  8807: <p>Remove all CVS dirs.</p>
                   8808: <p>Alternatively to the first two steps you can also do:</p>
                   8809: <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>
                   8810: <p>and use that for further work.</p>
                   8811: </li>
1.23      wiz      8812: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   8813: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   8814: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   8815: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20      snj      8816: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   8817: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   8818: for doing an update using pkgsrc building; for example, it can
1.125     leot     8819: search the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20      snj      8820: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   8821: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   8822: it may have multiple matches, so the tool should also check on the
                   8823: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   8824: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   8825: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.23      wiz      8826: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  8827: place.</p></li>
1.23      wiz      8828: <li class="listitem">
1.1       dsieger  8829: <p>Check if any package depends on it:
                   8830: </p>
                   8831: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   8832: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   8833: </li>
1.23      wiz      8834: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   8835: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   8836: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   8837: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   8838: <li class="listitem">
1.1       dsieger  8839: <p>Commit the changed and removed files:</p>
                   8840: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   8841: <p>(and any packages from step 5, of course).</p>
                   8842: </li>
                   8843: </ol></div>
                   8844: </div>
                   8845: </div>
1.41      asau     8846: <div class="chapter">
1.1       dsieger  8847: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   8848: <a name="devfaq"></a>Chapter 22. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  8849: <p>This section contains the answers to questions that may
                   8850:        arise when you are writing a package. If you don't find your
                   8851:        question answered here, first have a look in the other chapters,
                   8852:        and if you still don't have the answer, ask on the
                   8853:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41      asau     8854: <div class="qandaset">
1.131   ! wiz      8855: <a name="idm86822032"></a><dl>
1.6       rillig   8856: <dt>22.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  8857:        MAKEFLAGS, .MAKEFLAGS and
                   8858:        MAKE_FLAGS?</a>
                   8859: </dt>
1.6       rillig   8860: <dt>22.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  8861:        MAKE, GMAKE and
                   8862:        MAKE_PROGRAM?</a>
                   8863: </dt>
1.6       rillig   8864: <dt>22.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  8865:        CC, PKG_CC and
                   8866:        PKGSRC_COMPILER?</a>
                   8867: </dt>
1.6       rillig   8868: <dt>22.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  8869:        BUILDLINK_LDFLAGS,
                   8870:        BUILDLINK_LDADD and
                   8871:        BUILDLINK_LIBS?</a>
                   8872: </dt>
1.6       rillig   8873: <dt>22.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  8874:        VARNAME=BUILDLINK_PREFIX.foo
                   8875:        say it's empty?</a>
                   8876: </dt>
1.6       rillig   8877: <dt>22.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  8878:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   8879:        don't understand the := inside
                   8880:        it.</a>
                   8881: </dt>
1.6       rillig   8882: <dt>22.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  8883:        developers?</a>
                   8884: </dt>
1.6       rillig   8885: <dt>22.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  8886:        documentation?</a>
                   8887: </dt>
1.6       rillig   8888: <dt>22.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.1       dsieger  8889: do?</a>
                   8890: </dt>
                   8891: </dl>
1.41      asau     8892: <table border="0" style="width: 100%;">
                   8893: <colgroup>
1.1       dsieger  8894: <col align="left" width="1%">
1.23      wiz      8895: <col>
1.41      asau     8896: </colgroup>
1.1       dsieger  8897: <tbody>
1.41      asau     8898: <tr class="question">
1.1       dsieger  8899: <td align="left" valign="top">
1.131   ! wiz      8900: <a name="devfaq.makeflags"></a><a name="idm86821648"></a><p><b>22.1.</b></p>
1.1       dsieger  8901: </td>
                   8902: <td align="left" valign="top"><p>What is the difference between
                   8903:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   8904:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   8905: </tr>
                   8906: <tr class="answer">
                   8907: <td align="left" valign="top"></td>
                   8908: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.125     leot     8909:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1       dsieger  8910:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   8911:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   8912:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   8913: </tr>
1.41      asau     8914: <tr class="question">
1.1       dsieger  8915: <td align="left" valign="top">
1.131   ! wiz      8916: <a name="devfaq.make"></a><a name="idm86817680"></a><p><b>22.2.</b></p>
1.1       dsieger  8917: </td>
                   8918: <td align="left" valign="top"><p>What is the difference between
                   8919:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   8920:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   8921: </tr>
                   8922: <tr class="answer">
                   8923: <td align="left" valign="top"></td>
                   8924: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.125     leot     8925:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1       dsieger  8926:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   8927:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   8928:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   8929:        Make program that is used for building the
                   8930:        package.</p></td>
                   8931: </tr>
1.41      asau     8932: <tr class="question">
1.1       dsieger  8933: <td align="left" valign="top">
1.131   ! wiz      8934: <a name="devfaq.cc"></a><a name="idm86813200"></a><p><b>22.3.</b></p>
1.1       dsieger  8935: </td>
                   8936: <td align="left" valign="top"><p>What is the difference between
                   8937:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   8938:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   8939: </tr>
                   8940: <tr class="answer">
                   8941: <td align="left" valign="top"></td>
                   8942: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   8943:        compiler, which can be configured by the pkgsrc user.
                   8944:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   8945:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   8946:        path to a compiler, but the type of compiler that should be
                   8947:        used. See <code class="filename">mk/compiler.mk</code> for more
                   8948:        information about the latter variable.</p></td>
                   8949: </tr>
1.41      asau     8950: <tr class="question">
1.1       dsieger  8951: <td align="left" valign="top">
1.131   ! wiz      8952: <a name="devfaq.bl3flags"></a><a name="idm86809104"></a><p><b>22.4.</b></p>
1.1       dsieger  8953: </td>
                   8954: <td align="left" valign="top"><p>What is the difference between
                   8955:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   8956:        <code class="varname">BUILDLINK_LDADD</code> and
                   8957:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   8958: </tr>
                   8959: <tr class="answer">
                   8960: <td align="left" valign="top"></td>
                   8961: <td align="left" valign="top"><p>[FIXME]</p></td>
                   8962: </tr>
1.41      asau     8963: <tr class="question">
1.1       dsieger  8964: <td align="left" valign="top">
1.131   ! wiz      8965: <a name="devfaq.bl3prefix"></a><a name="idm86806800"></a><p><b>22.5.</b></p>
1.1       dsieger  8966: </td>
1.10      hubertf  8967: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  8968:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   8969:        say it's empty?</p></td>
                   8970: </tr>
                   8971: <tr class="answer">
                   8972: <td align="left" valign="top"></td>
                   8973: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23      wiz      8974:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   8975:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.10      hubertf  8976:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  8977:        command.</p></td>
                   8978: </tr>
1.41      asau     8979: <tr class="question">
1.1       dsieger  8980: <td align="left" valign="top">
1.131   ! wiz      8981: <a name="devfaq.master_sites"></a><a name="idm86803728"></a><p><b>22.6.</b></p>
1.1       dsieger  8982: </td>
                   8983: <td align="left" valign="top"><p>What does
1.108     rillig   8984:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   8985:        don't understand the <code class="code">:=</code> inside
1.1       dsieger  8986:        it.</p></td>
                   8987: </tr>
                   8988: <tr class="answer">
                   8989: <td align="left" valign="top"></td>
1.108     rillig   8990: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   8991:        assignment operator, although it looks like it.
1.1       dsieger  8992:        Instead, it is a degenerate form of
1.108     rillig   8993:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.125     leot     8994:        which is documented in the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108     rillig   8995:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1       dsieger  8996:        case of <code class="varname">MASTER_SITE_*</code>,
                   8997:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   8998:        <em class="replaceable"><code>new_string</code></em> is
1.108     rillig   8999:        <code class="code">package/</code>. That's where the
                   9000:        <code class="code">:</code> and the <code class="code">=</code> fall
1.1       dsieger  9001:        together.</p></td>
                   9002: </tr>
1.41      asau     9003: <tr class="question">
1.1       dsieger  9004: <td align="left" valign="top">
1.131   ! wiz      9005: <a name="devfaq.mailinglists"></a><a name="idm86796816"></a><p><b>22.7.</b></p>
1.1       dsieger  9006: </td>
                   9007: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9008:        developers?</p></td>
                   9009: </tr>
                   9010: <tr class="answer">
                   9011: <td align="left" valign="top"></td>
1.41      asau     9012: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10      hubertf  9013: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1       dsieger  9014: <dd><p>This is a list for technical discussions related
                   9015:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9016:        pkgsrc infrastructure, proposed new features, questions related
                   9017:        to porting pkgsrc to a new platform, advice for maintaining a
                   9018:        package, patches that affect many packages, help requests moved
                   9019:        from pkgsrc-users when an infrastructure bug is found,
                   9020:        etc.</p></dd>
1.10      hubertf  9021: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1       dsieger  9022: <dd><p>All bug reports in category "pkg" sent with
1.125     leot     9023:        <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1       dsieger  9024:        directly; use one of the other mailing
                   9025:        lists.</p></dd>
                   9026: </dl></div></td>
                   9027: </tr>
1.41      asau     9028: <tr class="question">
1.1       dsieger  9029: <td align="left" valign="top">
1.131   ! wiz      9030: <a name="devfaq.documentation"></a><a name="idm86793104"></a><p><b>22.8.</b></p>
1.1       dsieger  9031: </td>
                   9032: <td align="left" valign="top"><p>Where is the pkgsrc
                   9033:        documentation?</p></td>
                   9034: </tr>
                   9035: <tr class="answer">
                   9036: <td align="left" valign="top"></td>
                   9037: <td align="left" valign="top">
                   9038: <p>There are many places where you can find
                   9039:        documentation about pkgsrc:</p>
1.41      asau     9040: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9041: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1       dsieger  9042:        of chapters that explain large parts of pkgsrc, but some
                   9043:        chapters tend to be outdated. Which ones they are is hard to
                   9044:        say.</p></li>
1.23      wiz      9045: <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.1       dsieger  9046:        about certain features, announcements of new parts of the pkgsrc
                   9047:        infrastructure and sometimes even announcements that a certain
                   9048:        feature has been marked as obsolete. The benefit here is that
                   9049:        each message has a date appended to it.</p></li>
1.23      wiz      9050: <li class="listitem"><p>Many of the files in the
1.1       dsieger  9051:        <code class="filename">mk/</code> directory start with a comment that
                   9052:        describes the purpose of the file and how it can be used by the
                   9053:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  9054:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  9055:        help</strong></span>.</p></li>
1.23      wiz      9056: <li class="listitem"><p>The CVS log messages are a rich source of
1.1       dsieger  9057:        information, but they tend to be highly abbreviated, especially
                   9058:        for actions that occur often. Some contain a detailed
                   9059:        description of what has changed, but they are geared towards the
                   9060:        other pkgsrc developers, not towards an average pkgsrc user.
                   9061:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9062:        don't know what has been before, these messages may not be worth
                   9063:        too much to you.</p></li>
1.23      wiz      9064: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9065:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.1       dsieger  9066:        mind of the developer who wrote the code. To get this
1.10      hubertf  9067:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  9068:        to see who has written it and ask on the
                   9069:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9070:        find your questions later (see above). To be sure that the
                   9071:        developer in charge reads the mail, you may CC him or
                   9072:        her.</p></li>
                   9073: </ul></div>
                   9074: </td>
                   9075: </tr>
1.41      asau     9076: <tr class="question">
1.1       dsieger  9077: <td align="left" valign="top">
1.131   ! wiz      9078: <a name="devfaq.too-much-time"></a><a name="idm86786576"></a><p><b>22.9.</b></p>
1.1       dsieger  9079: </td>
                   9080: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9081: do?</p></td>
                   9082: </tr>
                   9083: <tr class="answer">
                   9084: <td align="left" valign="top"></td>
                   9085: <td align="left" valign="top">
                   9086: <p>This is not really an FAQ yet, but here's the answer
                   9087: anyway.</p>
1.41      asau     9088: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9089: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.120     sevan    9090:     <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package).  It
1.1       dsieger  9091:     will tell you about newer versions of installed packages that are
                   9092:     available, but not yet updated in pkgsrc.</p></li>
1.23      wiz      9093: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14      jmcneill 9094:     &mdash; it contains a list of suggested new packages and a list of
1.1       dsieger  9095:     cleanups and enhancements for pkgsrc that would be nice to
                   9096:     have.</p></li>
1.23      wiz      9097: <li class="listitem"><p>Review packages for which review was requested on
1.71      wiz      9098:     the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1       dsieger  9099:     mailing list.</p></li>
                   9100: </ul></div>
                   9101: </td>
                   9102: </tr>
                   9103: </tbody>
                   9104: </table>
                   9105: </div>
                   9106: </div>
1.41      asau     9107: <div class="chapter">
1.1       dsieger  9108: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9109: <a name="gnome"></a>Chapter 23. GNOME packaging and porting</h2></div></div></div>
1.1       dsieger  9110: <div class="toc">
                   9111: <p><b>Table of Contents</b></p>
1.100     leot     9112: <dl class="toc">
1.6       rillig   9113: <dt><span class="sect1"><a href="#meta-packages">23.1. Meta packages</a></span></dt>
                   9114: <dt><span class="sect1"><a href="#new-package">23.2. Packaging a GNOME application</a></span></dt>
                   9115: <dt><span class="sect1"><a href="#full-update">23.3. Updating GNOME to a newer version</a></span></dt>
                   9116: <dt><span class="sect1"><a href="#patching">23.4. Patching guidelines</a></span></dt>
1.1       dsieger  9117: </dl>
                   9118: </div>
1.10      hubertf  9119: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1       dsieger  9120: site</a>:</p>
                   9121: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9122:   environment, an intuitive and attractive desktop for users, and the
                   9123:   GNOME development platform, an extensive framework for building
                   9124:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9125: <p>pkgsrc provides a seamless way to automatically build and install
                   9126: a complete GNOME environment <span class="emphasis"><em>under many different
                   9127: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9128: the most advanced build and packaging systems for GNOME due to its
                   9129: included technologies buildlink3, the wrappers and tools framework and
                   9130: automatic configuration file management.  Lots of efforts are put into
                   9131: achieving a completely clean deinstallation of installed software
                   9132: components.</p>
1.10      hubertf  9133: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1       dsieger  9134: the above also means that great efforts are put into making GNOME work
1.10      hubertf  9135: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1       dsieger  9136: pkgsrc as its preferred packaging system, contributing lots of
                   9137: portability fixes to make GNOME build and install under it.</p>
                   9138: <p>This chapter is aimed at pkgsrc developers and other people
                   9139: interested in helping our GNOME porting and packaging efforts.  It
                   9140: provides instructions on how to manage the existing packages and some
                   9141: important information regarding their internals.</p>
1.41      asau     9142: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9143: <h3 class="title">We need your help!</h3>
                   9144: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9145:   and GNOME and are willing to learn new exciting stuff, please jump
1.10      hubertf  9146:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1       dsieger  9147:   work</a> list!  There is still a long way to go to get a
                   9148:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9149:   achieve it!</p>
                   9150: </div>
1.41      asau     9151: <div class="sect1">
1.1       dsieger  9152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9153: <a name="meta-packages"></a>23.1. Meta packages</h2></div></div></div>
1.1       dsieger  9154: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41      asau     9155: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.120     sevan    9156: <li class="listitem"><p><a href="http://cdn.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.1       dsieger  9157:     the core GNOME desktop environment.  It only includes the necessary
                   9158:     bits to get it to boot correctly, although it may lack important
                   9159:     functionality for daily operation.  The idea behind this package is
                   9160:     to let end users build their own configurations on top of this one,
                   9161:     first installing this meta package to achieve a functional setup and
                   9162:     then adding individual applications.</p></li>
1.120     sevan    9163: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
1.1       dsieger  9164:     complete installation of the GNOME platform and desktop as defined
                   9165:     by the GNOME project; this is based on the components distributed in
                   9166:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9167:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9168:     official FTP server.  Developer-only tools found in those
                   9169:     directories are not installed unless required by some other
                   9170:     component to work properly.  Similarly, packages from the bindings
                   9171:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9172:     in unless required as a dependency for an end-user component.  This
1.120     sevan    9173:     package "extends" <a href="http://cdn.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>
                   9174: <li class="listitem"><p><a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
1.1       dsieger  9175:     Installs all the tools required to build a GNOME component when
                   9176:     fetched from the CVS repository.  These are required to let the
1.10      hubertf  9177:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1       dsieger  9178: </ul></div>
                   9179: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9180: sorted in a way that eases updates: a package may depend on other
                   9181: packages listed before it but not on any listed after it.  It is very
                   9182: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9183: change it to alphabetical sorting!</em></span></p>
                   9184: </div>
1.41      asau     9185: <div class="sect1">
1.1       dsieger  9186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9187: <a name="new-package"></a>23.2. Packaging a GNOME application</h2></div></div></div>
1.1       dsieger  9188: <p>Almost all GNOME applications are written in C and use a common
                   9189: set of tools as their build system.  Things get different with the new
                   9190: bindings to other languages (such as Python), but the following will
                   9191: give you a general idea on the minimum required tools:</p>
1.41      asau     9192: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9193: <li class="listitem">
1.1       dsieger  9194: <p>Almost all GNOME applications use the GNU Autotools as their
                   9195:     build system.  As a general rule you will need to tell this to your
                   9196:     package:</p>
                   9197: <pre class="programlisting">
                   9198: GNU_CONFIGURE=yes
                   9199: USE_LIBTOOL=yes
                   9200: USE_TOOLS+=gmake
                   9201: </pre>
                   9202: </li>
1.23      wiz      9203: <li class="listitem">
1.1       dsieger  9204: <p>If the package uses pkg-config to detect dependencies, add this
                   9205:     tool to the list of required utilities:</p>
1.111     sevan    9206: <pre class="programlisting">
                   9207: USE_TOOLS+=pkg-config
                   9208: </pre>
1.120     sevan    9209: <p>Also use <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
1.1       dsieger  9210:     the end of the build process to ensure that you did not miss to
                   9211:     specify any dependency in your package and that the version
                   9212:     requirements are all correct.</p>
                   9213: </li>
1.23      wiz      9214: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1       dsieger  9215:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9216:     to handle dependencies and to force the package to use the latest
                   9217:     available version.</p></li>
1.23      wiz      9218: <li class="listitem">
1.1       dsieger  9219: <p>If the package uses gtk-doc (a documentation generation
                   9220:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9221:     tool is rather big and the distfile should come with pregenerated
                   9222:     documentation anyway; if it does not, it is a bug that you ought to
                   9223:     report.  For such packages you should disable gtk-doc (unless it is
                   9224:     the default):</p>
1.111     sevan    9225: <pre class="programlisting">
                   9226: CONFIGURE_ARGS+=--disable-gtk-doc
                   9227: </pre>
1.1       dsieger  9228: <p>The default location of installed HTML files
                   9229:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9230:     and should not be changed unless the package insists on installing
                   9231:     them somewhere else.  Otherwise programs as
1.10      hubertf  9232:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.1       dsieger  9233:     do that with an entry similar to:</p>
1.111     sevan    9234: <pre class="programlisting">
                   9235: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9236: </pre>
1.1       dsieger  9237: </li>
                   9238: </ul></div>
                   9239: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9240: files under the installation prefix to maintain databases.  In this
                   9241: context, shared means that those exact same directories and files are
                   9242: used among several different packages, leading to conflicts in the
                   9243: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9244: handle the most common cases, so you have to forget about using
                   9245: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9246: omitting shared files from them.  If you find yourself doing those,
                   9247: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9248: <p>The following table lists the common situations that result in
                   9249: using shared directories or files.  For each of them, the appropriate
                   9250: solution is given.  After applying the solution be sure to
                   9251: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10      hubertf  9252: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1       dsieger  9253: <div class="table">
1.6       rillig   9254: <a name="plist-handling"></a><p class="title"><b>Table 23.1. PLIST handling for GNOME packages</b></p>
1.106     tnn      9255: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1       dsieger  9256: <colgroup>
                   9257: <col>
                   9258: <col>
                   9259: </colgroup>
                   9260: <thead><tr>
                   9261: <th>If the package...</th>
                   9262: <th>Then...</th>
                   9263: </tr></thead>
                   9264: <tbody>
                   9265: <tr>
                   9266: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.18      snj      9267: <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.1       dsieger  9268: </tr>
                   9269: <tr>
                   9270: <td>Installs icons under the
                   9271:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9272:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.10      hubertf  9273: <td>See <a class="xref" href="#hicolor-theme" title="19.6.19. Packages installing hicolor theme icons">Section 19.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.1       dsieger  9274: </tr>
                   9275: <tr>
                   9276: <td>Installs files under
                   9277:         <code class="filename">share/mime/packages</code>.</td>
1.10      hubertf  9278: <td>See <a class="xref" href="#mime-database" title="19.6.14. Packages installing extensions to the MIME database">Section 19.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.1       dsieger  9279: </tr>
                   9280: <tr>
                   9281: <td>Installs <code class="filename">.desktop</code> files under
                   9282:         <code class="filename">share/applications</code> and these include MIME
                   9283:         information.</td>
1.10      hubertf  9284: <td>See <a class="xref" href="#desktop-files" title="19.6.20. Packages installing desktop files">Section 19.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.1       dsieger  9285: </tr>
                   9286: </tbody>
                   9287: </table></div>
                   9288: </div>
                   9289: <br class="table-break">
                   9290: </div>
1.41      asau     9291: <div class="sect1">
1.1       dsieger  9292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9293: <a name="full-update"></a>23.3. Updating GNOME to a newer version</h2></div></div></div>
1.1       dsieger  9294: <p>When seeing GNOME as a whole, there are two kinds of
                   9295: updates:</p>
1.41      asau     9296: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  9297: <dt><span class="term">Major update</span></dt>
                   9298: <dd>
                   9299: <p>Given that there is still a very long way for GNOME 3 (if it
                   9300:       ever appears), we consider a major update one that goes from a
                   9301:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9302:       where <code class="literal">Y</code> is even and greater than
                   9303:       <code class="literal">X</code>.  These are hard to achieve because they
                   9304:       introduce lots of changes in the components' code and almost all
                   9305:       GNOME distfiles are updated to newer versions.  Some of them can
                   9306:       even break API and ABI compatibility with the previous major
                   9307:       version series.  As a result, the update needs to be done all at
                   9308:       once to minimize breakage.</p>
                   9309: <p>A major update typically consists of around 80 package
                   9310:       updates and the addition of some new ones.</p>
                   9311: </dd>
                   9312: <dt><span class="term">Minor update</span></dt>
                   9313: <dd>
                   9314: <p>We consider a minor update one that goes from a
                   9315:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9316:       one where <code class="literal">Y</code> is greater than
                   9317:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9318:       not update all GNOME components, can be done in an incremental way
                   9319:       and do not break API nor ABI compatibility.</p>
                   9320: <p>A minor update typically consists of around 50 package
                   9321:       updates, although the numbers here may vary a lot.</p>
                   9322: </dd>
                   9323: </dl></div>
                   9324: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9325: release (either major or minor), the following steps should be
                   9326: followed:</p>
1.23      wiz      9327: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9328: <li class="listitem">
1.1       dsieger  9329: <p>Get a list of all the tarballs that form the new release by
                   9330:     using the following commands.  These will leave the full list of the
1.18      snj      9331:     components' distfiles into the <code class="filename">list.txt</code>
1.1       dsieger  9332:     file:</p>
                   9333: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9334:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9335:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9336: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9337:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9338:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9339: </li>
1.23      wiz      9340: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1       dsieger  9341:     bump their version to the release you are updating them to.  The
                   9342:     three meta packages should be always consistent with versioning.
                   9343:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9344:     in them.</p></li>
1.23      wiz      9345: <li class="listitem">
1.1       dsieger  9346: <p>For each meta package, update all its
                   9347:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9348:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9349:     newer version (even if found in the FTP) because the meta packages
                   9350:     are supposed to list the exact versions that form a specific GNOME
                   9351:     release.  Exceptions are permitted here if a newer version solves a
                   9352:     serious issue in the overall desktop experience; these typically
                   9353:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9354:     from the developers.</p>
                   9355: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9356:     should be updated to the latest version available (if found in
                   9357:     pkgsrc).  This is the case, for example, of the dependencies on the
1.120     sevan    9358:     GNU Autotools in the <a href="http://cdn.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.1       dsieger  9359: </li>
1.23      wiz      9360: <li class="listitem">
1.1       dsieger  9361: <p>Generate a patch from the modified meta packages and extract the
                   9362:     list of "new" lines.  This will provide you an outline on what
                   9363:     packages need to be updated in pkgsrc and in what order:</p>
                   9364: <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>
                   9365: </li>
1.23      wiz      9366: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1       dsieger  9367:     installed packages and start over from scratch at this point.</p></li>
1.23      wiz      9368: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1       dsieger  9369:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9370:     it in order.  For major desktop updates none of these should be
                   9371:     committed until the entire set is completed because there are chances
                   9372:     of breaking not-yet-updated packages.</p></li>
1.23      wiz      9373: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1       dsieger  9374:     the tree one by one with appropriate log messages.  At the end,
                   9375:     commit the three meta package updates and all the corresponding
                   9376:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9377:     <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>
                   9378: </ol></div>
                   9379: </div>
1.41      asau     9380: <div class="sect1">
1.1       dsieger  9381: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9382: <a name="patching"></a>23.4. Patching guidelines</h2></div></div></div>
1.1       dsieger  9383: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9384: packages.  Please, it is very important that you always, always,
                   9385: <span class="strong"><strong>always</strong></span> feed back any portability
1.10      hubertf  9386: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="11.3.5. Feedback to the author">Section 11.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.1       dsieger  9387: their attention on portability issues and to ensure that future versions
                   9388: can be built out-of-the box on NetBSD.  The less custom patches in
                   9389: pkgsrc, the easier further updates are.  Those developers in charge of
                   9390: issuing major GNOME updates will be grateful if you do that.</p>
1.10      hubertf  9391: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.1       dsieger  9392: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9393: of them do.  Do not be short on your reports: always provide detailed
                   9394: explanations of the current failure, how it can be improved to achieve
                   9395: maximum portability and, if at all possible, provide a patch against CVS
                   9396: head.  The more verbose you are, the higher chances of your patch being
                   9397: accepted.</p>
                   9398: <p>Also, please avoid using preprocessor magic to fix portability
                   9399: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9400: GNOME to their operating system, the official GNOME sources are now
                   9401: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9402: and similar macros.  This hurts portability.  Please see our patching
1.10      hubertf  9403: guidelines (<a class="xref" href="#components.patches.guidelines" title="11.3.4. Patching guidelines">Section 11.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.1       dsieger  9404: details.</p>
                   9405: </div>
                   9406: </div>
                   9407: </div>
1.41      asau     9408: <div class="part">
1.1       dsieger  9409: <div class="titlepage"><div><div><h1 class="title">
                   9410: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41      asau     9411: <div class="partintro">
1.1       dsieger  9412: <div></div>
                   9413: <p>This part of the guide deals with everything
                   9414:        from the infrastructure that is behind the interfaces described
                   9415:        in the developer's guide. A casual package maintainer should not
                   9416:        need anything from this part.</p>
                   9417: <div class="toc">
                   9418: <p><b>Table of Contents</b></p>
1.100     leot     9419: <dl class="toc">
1.6       rillig   9420: <dt><span class="chapter"><a href="#infr.design">24. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  9421: <dd><dl>
1.6       rillig   9422: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   9423: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   9424: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  9425: <dd><dl>
1.6       rillig   9426: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   9427: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  9428: </dl></dd>
1.6       rillig   9429: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   9430: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  9431: <dd><dl>
1.6       rillig   9432: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   9433: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  9434: </dl></dd>
1.6       rillig   9435: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  9436: <dd><dl>
1.23      wiz      9437: <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>
                   9438: <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.1       dsieger  9439: </dl></dd>
                   9440: </dl></dd>
1.6       rillig   9441: <dt><span class="chapter"><a href="#regression">25. Regression tests</a></span></dt>
1.1       dsieger  9442: <dd><dl>
1.108     rillig   9443: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                   9444: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1       dsieger  9445: <dd><dl>
1.108     rillig   9446: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                   9447: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1       dsieger  9448: </dl></dd>
                   9449: </dl></dd>
1.6       rillig   9450: <dt><span class="chapter"><a href="#porting">26. Porting pkgsrc</a></span></dt>
1.108     rillig   9451: <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.1       dsieger  9452: </dl>
                   9453: </div>
                   9454: </div>
1.41      asau     9455: <div class="chapter">
1.1       dsieger  9456: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9457: <a name="infr.design"></a>Chapter 24. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  9458: <div class="toc">
                   9459: <p><b>Table of Contents</b></p>
1.100     leot     9460: <dl class="toc">
1.6       rillig   9461: <dt><span class="sect1"><a href="#infr.vardef">24.1. The meaning of variable definitions</a></span></dt>
                   9462: <dt><span class="sect1"><a href="#infr.vardef.problems">24.2. Avoiding problems before they arise</a></span></dt>
                   9463: <dt><span class="sect1"><a href="#infr.var">24.3. Variable evaluation</a></span></dt>
1.1       dsieger  9464: <dd><dl>
1.6       rillig   9465: <dt><span class="sect2"><a href="#infr.var.load">24.3.1. At load time</a></span></dt>
                   9466: <dt><span class="sect2"><a href="#infr.var.run">24.3.2. At runtime</a></span></dt>
1.1       dsieger  9467: </dl></dd>
1.6       rillig   9468: <dt><span class="sect1"><a href="#infr.varspec">24.4. How can variables be specified?</a></span></dt>
                   9469: <dt><span class="sect1"><a href="#infr.design.intf">24.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  9470: <dd><dl>
1.6       rillig   9471: <dt><span class="sect2"><a href="#infr.design.intf.proc">24.5.1. Procedures with parameters</a></span></dt>
                   9472: <dt><span class="sect2"><a href="#infr.design.intf.action">24.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  9473: </dl></dd>
1.6       rillig   9474: <dt><span class="sect1"><a href="#infr.order">24.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  9475: <dd><dl>
1.23      wiz      9476: <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>
                   9477: <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.1       dsieger  9478: </dl></dd>
                   9479: </dl>
                   9480: </div>
                   9481: <p>The pkgsrc infrastructure consists of many small Makefile
                   9482:        fragments. Each such fragment needs a properly specified
                   9483:        interface. This chapter explains how such an interface looks
                   9484:        like.</p>
1.41      asau     9485: <div class="sect1">
1.1       dsieger  9486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9487: <a name="infr.vardef"></a>24.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  9488: <p>Whenever a variable is defined in the pkgsrc
                   9489:        infrastructure, the location and the way of definition provide
                   9490:        much information about the intended use of that variable.
                   9491:        Additionally, more documentation may be found in a header
                   9492:        comment or in this pkgsrc guide.</p>
                   9493: <p>A special file is
                   9494:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   9495:        variables that are intended to be user-defined. They are either
                   9496:        defined using the <code class="literal">?=</code> operator or they are
                   9497:        left undefined because defining them to anything would
1.23      wiz      9498:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.1       dsieger  9499:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   9500:        file.</p>
                   9501: <p>Outside this file, the following conventions apply:
                   9502:        Variables that are defined using the <code class="literal">?=</code>
                   9503:        operator may be overridden by a package.</p>
                   9504: <p>Variables that are defined using the <code class="literal">=</code>
                   9505:        operator may be used read-only at run-time.</p>
                   9506: <p>Variables whose name starts with an underscore must not be
                   9507:        accessed outside the pkgsrc infrastructure at all. They may
                   9508:        change without further notice.</p>
1.41      asau     9509: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9510: <h3 class="title">Note</h3>
                   9511: <p>These conventions are currently not applied
                   9512:        consistently to the complete pkgsrc
                   9513:        infrastructure.</p>
                   9514: </div>
                   9515: </div>
1.41      asau     9516: <div class="sect1">
1.1       dsieger  9517: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9518: <a name="infr.vardef.problems"></a>24.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  9519: <p>All variables that contain lists of things should default
                   9520:        to being empty. Two examples that do not follow this rule are
                   9521:        <code class="varname">USE_LANGUAGES</code> and
                   9522:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   9523:        modified using the <code class="literal">+=</code> operator in package
                   9524:        <code class="filename">Makefile</code>s (or other files included by
                   9525:        them), since there is no guarantee whether the variable is
                   9526:        already set or not, and what its value is. In the case of
1.23      wiz      9527:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.1       dsieger  9528:        the default value and just define it as in the following
                   9529:        example.</p>
                   9530: <pre class="programlisting">
                   9531: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   9532: </pre>
                   9533: <p>Because of the selection of this default value, the same
                   9534:        value appears in many package Makefiles. Similarly for
                   9535:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23      wiz      9536:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.1       dsieger  9537:        doesn't stand out. Nevertheless it is mentioned in many
                   9538:        files.</p>
                   9539: </div>
1.41      asau     9540: <div class="sect1">
1.1       dsieger  9541: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9542: <a name="infr.var"></a>24.3. Variable evaluation</h2></div></div></div>
1.41      asau     9543: <div class="sect2">
1.1       dsieger  9544: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9545: <a name="infr.var.load"></a>24.3.1. At load time</h3></div></div></div>
1.1       dsieger  9546: <p>Variable evaluation takes place either at load time or at
                   9547:        runtime, depending on the context in which they occur. The
                   9548:        contexts where variables are evaluated at load time are:</p>
1.41      asau     9549: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9550: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1       dsieger  9551:        and <code class="literal">!=</code> operators,</p></li>
1.23      wiz      9552: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1       dsieger  9553:        <code class="literal">.for</code>,</p></li>
1.23      wiz      9554: <li class="listitem"><p>Dependency lines.</p></li>
1.1       dsieger  9555: </ul></div>
                   9556: <p>A special exception are references to the iteration
                   9557:        variables of <code class="literal">.for</code> loops, which are expanded
                   9558:        inline, no matter in which context they appear.</p>
                   9559: <p>As the values of variables may change during load time,
                   9560:        care must be taken not to evaluate them by accident. Typical
                   9561:        examples for variables that should not be evaluated at load time
                   9562:        are <code class="varname">DEPENDS</code> and
                   9563:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   9564:        clear, here is an example:</p>
                   9565: <pre class="programlisting">
                   9566: CONFIGURE_ARGS=         # none
                   9567: CFLAGS=                 -O
                   9568: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   9569: 
                   9570: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   9571: 
                   9572: CFLAGS+=                -Wall
1.111     sevan    9573: </pre>
1.1       dsieger  9574: <p>This code shows how the use of the <code class="literal">:=</code>
                   9575:        operator can quickly lead to unexpected results. The first
                   9576:        paragraph is fairly common code. The second paragraph evaluates
                   9577:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   9578:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   9579:        <code class="literal">-Wall</code> is appended to the
                   9580:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   9581:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   9582:        paragraphs from above typically occur in completely unrelated
                   9583:        files.</p>
                   9584: </div>
1.41      asau     9585: <div class="sect2">
1.1       dsieger  9586: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9587: <a name="infr.var.run"></a>24.3.2. At runtime</h3></div></div></div>
1.1       dsieger  9588: <p>After all the files have been loaded, the values of the
                   9589:        variables cannot be changed anymore. Variables that are used in
                   9590:        the shell commands are expanded at this point.</p>
                   9591: </div>
                   9592: </div>
1.41      asau     9593: <div class="sect1">
1.1       dsieger  9594: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9595: <a name="infr.varspec"></a>24.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  9596: <p>There are many ways in which the definition and use of a
1.108     rillig   9597:        variable can be restricted in order to detect bugs and violations
                   9598:        of the (mostly unwritten) policies. A package can be checked with
                   9599:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   9600:        rules.</p>
1.1       dsieger  9601: </div>
1.41      asau     9602: <div class="sect1">
1.1       dsieger  9603: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9604: <a name="infr.design.intf"></a>24.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  9605: <p>Most of the <code class="filename">.mk</code> files fall into one
                   9606:        of the following classes. Cases where a file falls into more
                   9607:        than one class should be avoided as it often leads to subtle
                   9608:        bugs.</p>
1.41      asau     9609: <div class="sect2">
1.1       dsieger  9610: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9611: <a name="infr.design.intf.proc"></a>24.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  9612: <p>In a traditional imperative programming language some of
                   9613:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 9614:        procedures. They take some input parameters and&mdash;after
                   9615:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  9616:        variables in <code class="filename">Makefile</code>s have global scope
                   9617:        care must be taken not to use parameter names that have already
                   9618:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   9619:        bad choice for a parameter name.</p>
                   9620: <p>Procedures are completely evaluated at preprocessing time.
                   9621:        That is, when calling a procedure all input parameters must be
                   9622:        completely resolvable. For example,
                   9623:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   9624:        parameter since it is very likely that further text will be
                   9625:        added after calling the procedure, which would effectively apply
                   9626:        the procedure to only a part of the variable. Also, references
1.108     rillig   9627:        to other variables will be modified after calling the
1.1       dsieger  9628:        procedure.</p>
                   9629: <p>A procedure can declare its output parameters either as
                   9630:        suitable for use in preprocessing directives or as only
                   9631:        available at runtime. The latter alternative is for variables
                   9632:        that contain references to other runtime variables.</p>
                   9633: <p>Procedures shall be written such that it is possible to
                   9634:        call the procedure more than once. That is, the file must not
                   9635:        contain multiple-inclusion guards.</p>
                   9636: <p>Examples for procedures are
                   9637:        <code class="filename">mk/bsd.options.mk</code> and
                   9638:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   9639:        that the parameters are evaluated at load time, they should be
                   9640:        assigned using the <code class="literal">:=</code> operator, which should
                   9641:        be used only for this purpose.</p>
                   9642: </div>
1.41      asau     9643: <div class="sect2">
1.1       dsieger  9644: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9645: <a name="infr.design.intf.action"></a>24.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  9646: <p>Action files take some input parameters and may define
                   9647:        runtime variables. They shall not define loadtime variables.
                   9648:        There are action files that are included implicitly by the
                   9649:        pkgsrc infrastructure, while other must be included
                   9650:        explicitly.</p>
                   9651: <p>An example for action files is
                   9652:        <code class="filename">mk/subst.mk</code>.</p>
                   9653: </div>
                   9654: </div>
1.41      asau     9655: <div class="sect1">
1.1       dsieger  9656: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9657: <a name="infr.order"></a>24.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  9658: <p>Package <code class="filename">Makefile</code>s usually consist of
                   9659:        a set of variable definitions, and include the file
                   9660:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   9661:        Before that, they may also include various other
                   9662:        <code class="filename">*.mk</code> files if they need to query the
                   9663:        availability of certain features like the type of compiler or
                   9664:        the X11 implementation. Due to the heavy use of preprocessor
                   9665:        directives like <code class="literal">.if</code> and
                   9666:        <code class="literal">.for</code>, the order in which the files are loaded
                   9667:        matters.</p>
                   9668: <p>This section describes at which point the various files
                   9669:        are loaded and gives reasons for that order.</p>
1.41      asau     9670: <div class="sect2">
1.1       dsieger  9671: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9672: <a name="infr.order.prefs"></a>24.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  9673: </h3></div></div></div>
                   9674: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   9675:        is to define some essential variables like
                   9676:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   9677:        <code class="varname">MACHINE_ARCH</code>.</p>
                   9678: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  9679:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4       rillig   9680:        After that, those variables
1.1       dsieger  9681:        that have not been overridden by the user are loaded from
                   9682:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   9683: <p>After the user settings, the system settings and platform
                   9684:        settings are loaded, which may override the user
                   9685:        settings.</p>
                   9686: <p>Then, the tool definitions are loaded. The tool wrappers
                   9687:        are not yet in effect. This only happens when building a
                   9688:        package, so the proper variables must be used instead of the
                   9689:        direct tool names.</p>
                   9690: <p>As the last steps, some essential variables from the
                   9691:        wrapper and the package system flavor are loaded, as well as the
                   9692:        variables that have been cached in earlier phases of a package
                   9693:        build.</p>
                   9694: </div>
1.41      asau     9695: <div class="sect2">
1.1       dsieger  9696: <div class="titlepage"><div><div><h3 class="title">
1.6       rillig   9697: <a name="infr.order.pkg"></a>24.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  9698: </h3></div></div></div>
                   9699: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   9700: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   9701:        loaded, which fill default values for those variables that have
                   9702:        not been defined by the package. These variables may later
                   9703:        be used even in unrelated files.</p>
                   9704: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   9705:        provides the target <code class="literal">error-check</code> that is added
                   9706:        as a special dependency to all other targets that use
                   9707:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   9708:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   9709: <p>Then, the package-specific hacks from
                   9710:        <code class="filename">hacks.mk</code> are included.</p>
                   9711: <p>Then, various other files follow. Most of them don't have
                   9712:        any dependencies on what they need to have included before or
                   9713:        after them, though some do.</p>
                   9714: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   9715:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   9716:        restricts the use of these variables to all the files that have
                   9717:        been included before. Appearances in later files will be
                   9718:        silently ignored.</p>
                   9719: <p>Then, the files for the main targets are included, in the
                   9720:        order of later execution, though the actual order should not
                   9721:        matter.</p>
                   9722: <p>At last, some more files are included that don't set any
                   9723:        interesting variables but rather just define make targets to be
                   9724:        executed.</p>
                   9725: </div>
                   9726: </div>
                   9727: </div>
1.41      asau     9728: <div class="chapter">
1.1       dsieger  9729: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9730: <a name="regression"></a>Chapter 25. Regression tests</h2></div></div></div>
1.1       dsieger  9731: <div class="toc">
                   9732: <p><b>Table of Contents</b></p>
1.100     leot     9733: <dl class="toc">
1.108     rillig   9734: <dt><span class="sect1"><a href="#regression.run">25.1. Running the regression tests</a></span></dt>
                   9735: <dt><span class="sect1"><a href="#regression.new">25.2. Adding a new regression test</a></span></dt>
1.1       dsieger  9736: <dd><dl>
1.108     rillig   9737: <dt><span class="sect2"><a href="#regression.fun.override">25.2.1. Overridable functions</a></span></dt>
                   9738: <dt><span class="sect2"><a href="#regression.fun.helper">25.2.2. Helper functions</a></span></dt>
1.1       dsieger  9739: </dl></dd>
                   9740: </dl>
                   9741: </div>
                   9742: <p>The pkgsrc infrastructure consists of a large codebase,
                   9743:        and there are many corners where every little bit of a file is
                   9744:        well thought out, making pkgsrc likely to fail as soon as
                   9745:        anything is changed near those parts. To prevent most changes
                   9746:        from breaking anything, a suite of regression tests should go
                   9747:        along with every important part of the pkgsrc infrastructure.
                   9748:        This chapter describes how regression tests work in pkgsrc and
                   9749:        how you can add new tests.</p>
1.41      asau     9750: <div class="sect1">
1.1       dsieger  9751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   9752: <a name="regression.run"></a>25.1. Running the regression tests</h2></div></div></div>
1.120     sevan    9753: <p>You first need to install the <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10      hubertf  9754:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  9755:        can simply run that command, which will run all tests in the
                   9756:        <code class="filename">regress</code> category.</p>
                   9757: </div>
1.41      asau     9758: <div class="sect1">
1.1       dsieger  9759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.108     rillig   9760: <a name="regression.new"></a>25.2. Adding a new regression test</h2></div></div></div>
1.1       dsieger  9761: <p>Every directory in the <code class="filename">regress</code>
                   9762:        category that contains a file called <code class="filename">spec</code>
                   9763:        is considered a regression test. This file is a shell program
1.10      hubertf  9764:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  9765:        The following functions can be overridden to suit your
                   9766:        needs.</p>
1.41      asau     9767: <div class="sect2">
1.1       dsieger  9768: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   9769: <a name="regression.fun.override"></a>25.2.1. Overridable functions</h3></div></div></div>
                   9770: <p>These functions do not take any parameters. Although they
                   9771:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
                   9772:        first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
                   9773:        question</a> for details.</p>
1.41      asau     9774: <div class="variablelist"><dl class="variablelist">
1.108     rillig   9775: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1       dsieger  9776: <dd><p>This function prepares the environment for the
                   9777:        test. By default it does nothing.</p></dd>
1.108     rillig   9778: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   9779: <dd>
                   9780: <p>This function runs the actual test. By default,
1.1       dsieger  9781:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   9782:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   9783:        error messages into the file
1.108     rillig   9784:        <code class="varname">TEST_OUTFILE</code>.</p>
                   9785: <p>When defining this function, make sure that all output that
                   9786:        needs to be checked is written to the correct output file.
                   9787:        Example:</p>
                   9788: <pre class="programlisting">
                   9789: do_test() {
1.112     rillig   9790:         echo "Example output"
1.108     rillig   9791: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   9792: </pre>
                   9793: </dd>
                   9794: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   9795: <dd>
                   9796: <p>This function is run after the test and is
1.1       dsieger  9797:        typically used to compare the actual output from the one that is
                   9798:        expected. It can make use of the various helper functions from
1.108     rillig   9799:        the next section. Example:</p>
                   9800: <pre class="programlisting">
                   9801: check_result() {
1.112     rillig   9802:         exit_status 0
                   9803:         output_require "Example"
                   9804:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   9805:         output_prohibit "no such file or directory"
1.108     rillig   9806: }
                   9807: </pre>
                   9808: </dd>
                   9809: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1       dsieger  9810: <dd><p>This function cleans everything up after the
                   9811:        test has been run. By default it does nothing.</p></dd>
                   9812: </dl></div>
                   9813: </div>
1.41      asau     9814: <div class="sect2">
1.1       dsieger  9815: <div class="titlepage"><div><div><h3 class="title">
1.108     rillig   9816: <a name="regression.fun.helper"></a>25.2.2. Helper functions</h3></div></div></div>
1.41      asau     9817: <div class="variablelist"><dl class="variablelist">
1.108     rillig   9818: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1       dsieger  9819: <dd><p>This function compares the exitcode of the
1.108     rillig   9820:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1       dsieger  9821:        If they differ, the test will fail.</p></dd>
1.108     rillig   9822: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   9823: <dd>
                   9824: <p>This function checks for each of its parameters
                   9825:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1       dsieger  9826:        extended regular expression. If it does not, the test will
1.108     rillig   9827:        fail. Example:</p>
                   9828: <pre class="programlisting">
                   9829: output_require "looks fine"
                   9830: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   9831: </pre>
                   9832: </dd>
1.1       dsieger  9833: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   9834: <dd><p>This function checks for each of its parameters
1.10      hubertf  9835:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  9836:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   9837:        If any of the regular expressions matches, the test will
                   9838:        fail.</p></dd>
                   9839: </dl></div>
                   9840: </div>
                   9841: </div>
                   9842: </div>
1.41      asau     9843: <div class="chapter">
1.1       dsieger  9844: <div class="titlepage"><div><div><h2 class="title">
1.6       rillig   9845: <a name="porting"></a>Chapter 26. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  9846: <div class="toc">
                   9847: <p><b>Table of Contents</b></p>
1.108     rillig   9848: <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.1       dsieger  9849: </div>
                   9850: <p>The pkgsrc system has already been ported to many
                   9851:        operating systems, hardware architectures and compilers. This
                   9852:        chapter explains the necessary steps to make pkgsrc even more
                   9853:        portable.</p>
1.41      asau     9854: <div class="sect1">
1.1       dsieger  9855: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.6       rillig   9856: <a name="porting.opsys"></a>26.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  9857: <p>To port pkgsrc to a new operating system (called
                   9858:        <code class="literal">MyOS</code> in this example), you need to touch the
                   9859:        following files:</p>
1.41      asau     9860: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  9861: <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>
                   9862: <dd><p>This file contains some basic definitions, for
                   9863:        example the name of the C
                   9864:        compiler.</p></dd>
                   9865: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   9866: <dd><p>Insert code that defines the variables
                   9867:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   9868:        <code class="varname">LOWER_OS_VERSION</code>,
                   9869:        <code class="varname">LOWER_VENDOR</code>,
                   9870:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   9871:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   9872:        appear in this file.</p></dd>
                   9873: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   9874: <dd><p>This file contains the platform-specific
                   9875:        definitions that are used by pkgsrc. Start by copying one of the
                   9876:        other files and edit it to your
                   9877:        needs.</p></dd>
                   9878: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   9879: <dd><p>This file defines the paths to all the tools
                   9880:        that are needed by one or the other package in pkgsrc, as well
                   9881:        as by pkgsrc itself. Find out where these tools are on your
                   9882:        platform and add them.</p></dd>
                   9883: </dl></div>
                   9884: <p>Now, you should be able to build some basic packages, like
1.120     sevan    9885:        <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1       dsieger  9886: </div>
                   9887: </div>
                   9888: </div>
1.41      asau     9889: <div class="appendix">
                   9890: <div class="titlepage"><div><div><h1 class="title">
                   9891: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1       dsieger  9892: <div class="toc">
                   9893: <p><b>Table of Contents</b></p>
1.100     leot     9894: <dl class="toc">
1.1       dsieger  9895: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   9896: <dd><dl>
                   9897: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   9898: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   9899: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz      9900: <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.1       dsieger  9901: </dl></dd>
                   9902: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   9903: </dl>
                   9904: </div>
                   9905: <p>We checked to find a piece of software that wasn't in the packages
                   9906:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  9907:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  9908:     present in the tree is beyond us, but it's useful for the purposes of
                   9909:     this exercise.</p>
1.41      asau     9910: <div class="sect1">
1.1       dsieger  9911: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9912: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41      asau     9913: <div class="sect2">
1.1       dsieger  9914: <div class="titlepage"><div><div><h3 class="title">
                   9915: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   9916: <pre class="programlisting">
                   9917: # $NetBSD$
                   9918: #
                   9919: 
                   9920: DISTNAME=       bison-1.25
                   9921: CATEGORIES=     devel
                   9922: MASTER_SITES=   ${MASTER_SITE_GNU}
                   9923: 
1.29      dholland 9924: MAINTAINER=     pkgsrc-users@NetBSD.org
1.1       dsieger  9925: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   9926: COMMENT=        GNU yacc clone
                   9927: 
                   9928: GNU_CONFIGURE=  yes
1.46      wiz      9929: INFO_FILES=     yes
1.1       dsieger  9930: 
                   9931: .include "../../mk/bsd.pkg.mk"
                   9932: </pre>
                   9933: </div>
1.41      asau     9934: <div class="sect2">
1.1       dsieger  9935: <div class="titlepage"><div><div><h3 class="title">
                   9936: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   9937: <pre class="programlisting">
                   9938: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.125     leot     9939: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-7.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1       dsieger  9940: of the NetBSD source tree is beyond me.
                   9941: </pre>
                   9942: </div>
1.41      asau     9943: <div class="sect2">
1.1       dsieger  9944: <div class="titlepage"><div><div><h3 class="title">
                   9945: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   9946: <pre class="programlisting">
                   9947: @comment $NetBSD$
                   9948: bin/bison
                   9949: man/man1/bison.1.gz
                   9950: share/bison.simple
                   9951: share/bison.hairy
                   9952: </pre>
                   9953: </div>
1.41      asau     9954: <div class="sect2">
1.1       dsieger  9955: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  9956: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1       dsieger  9957: </h3></div></div></div>
                   9958: <p>The NetBSD package system comes with
1.120     sevan    9959:         <a href="http://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1       dsieger  9960:        which helps to check the contents of these
                   9961:        files. After installation it is quite easy to use, just change to the
                   9962:        directory of the package you wish to examine and execute
1.10      hubertf  9963:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  9964: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   9965: looks fine.</pre>
                   9966: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10      hubertf  9967:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1       dsieger  9968:        -Wall</strong></span> for a very thorough check.</p>
                   9969: </div>
                   9970: </div>
1.41      asau     9971: <div class="sect1">
1.1       dsieger  9972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9973: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   9974: <p>Create the directory where the package lives,
                   9975:       plus any auxiliary directories:</p>
                   9976: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   9977: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   9978: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   9979: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   9980: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.10      hubertf  9981:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 11. Package components - files, directories and contents">Chapter 11, <i>Package components - files, directories and contents</i></a>)
1.1       dsieger  9982:       then continue with fetching the distfile:</p>
                   9983: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   9984: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   9985: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   9986: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   9987: ftp: Error retrieving file: 500 Internal error
                   9988: 
                   9989: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   9990: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   9991: ftp: Error retrieving file: 500 Internal error
                   9992: 
                   9993: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   9994: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   9995: Successfully retrieved file.</pre>
                   9996: <p>Generate the checksum of the distfile into
                   9997:       <code class="filename">distinfo</code>:</p>
                   9998: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   9999: <p>Now compile:</p>
                   10000: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10001: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10002: ===&gt;  Extracting for bison-1.25
                   10003: ===&gt;  Patching for bison-1.25
                   10004: ===&gt;   Ignoring empty patch directory
                   10005: ===&gt;  Configuring for bison-1.25
                   10006: creating cache ./config.cache
                   10007: checking for gcc... cc
                   10008: checking whether we are using GNU C... yes
                   10009: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10010: checking how to run the C preprocessor... cc -E
                   10011: checking for minix/config.h... no
                   10012: checking for POSIXized ISC... no
                   10013: checking whether cross-compiling... no
                   10014: checking for ANSI C header files... yes
                   10015: checking for string.h... yes
                   10016: checking for stdlib.h... yes
                   10017: checking for memory.h... yes
                   10018: checking for working const... yes
                   10019: checking for working alloca.h... no
                   10020: checking for alloca... yes
                   10021: checking for strerror... yes
                   10022: updating cache ./config.cache
                   10023: creating ./config.status
                   10024: creating Makefile
                   10025: ===&gt;  Building for bison-1.25
                   10026: 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
                   10027: 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
                   10028: 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
                   10029: 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
                   10030: 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
                   10031: 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
                   10032: 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
                   10033: 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
                   10034: 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
                   10035: 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
                   10036: 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
                   10037: 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
                   10038: 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
                   10039: 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
                   10040: 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
                   10041: 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
                   10042: 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
                   10043: 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
                   10044: 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
                   10045: 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
                   10046: 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
                   10047: 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
                   10048: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10049: rm -f bison.s1
                   10050: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10051: <p>Everything seems OK, so install the files:</p>
                   10052: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10053: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10054: ===&gt;  Installing for bison-1.25
                   10055: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10056: rm -f /usr/pkg/bin/bison
                   10057: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10058: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10059: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10060: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10061: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10062: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10063: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10064: ===&gt;  Registering installation for bison-1.25</pre>
                   10065: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10066:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10067:       binary package, do this now:</p>
                   10068: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10069: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10070: ===&gt;  Building package for bison-1.25
                   10071: Creating package bison-1.25.tgz
                   10072: Registering depends:.
                   10073: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10074: <p>Now that you don't need the source and object files
                   10075:       any more, clean up:</p>
                   10076: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10077: ===&gt;  Cleaning for bison-1.25</pre>
                   10078: </div>
                   10079: </div>
1.41      asau     10080: <div class="appendix">
                   10081: <div class="titlepage"><div><div><h1 class="title">
                   10082: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1       dsieger  10083: <div class="toc">
                   10084: <p><b>Table of Contents</b></p>
1.100     leot     10085: <dl class="toc">
1.1       dsieger  10086: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10087: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10088: </dl>
                   10089: </div>
1.41      asau     10090: <div class="sect1">
1.1       dsieger  10091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10092: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10093: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10094: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10095: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10096: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10097: =&gt; [172219 bytes]
                   10098: Connected to ftp.plig.net.
                   10099: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10100: 331 Guest login ok, send your complete e-mail address as password.
                   10101: 230-You are user #5 of 500 simultaneous users allowed.
                   10102: 230-
                   10103: 230-  ___ _             _ _
                   10104: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10105: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10106: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10107: 230-         |_|   |_|     |___|         |___|
                   10108: 230-
                   10109: 230-** Welcome to ftp.plig.org **
                   10110: 230-
                   10111: 230-Please note that all transfers from this FTP site are logged. If you
                   10112: 230-do not like this, please disconnect now.
                   10113: 230-
1.18      snj      10114: 230-This archive is available via
1.1       dsieger  10115: 230-
                   10116: 230-HTTP:  http://ftp.plig.org/
                   10117: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10118: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10119: 230-
                   10120: 230-Please email comments, bug reports and requests for packages to be
                   10121: 230-mirrored to ftp-admin@plig.org.
                   10122: 230-
                   10123: 230-
                   10124: 230 Logged in anonymously.
                   10125: Remote system type is UNIX.
                   10126: Using binary mode to transfer files.
                   10127: 200 Type okay.
                   10128: 250 "/pub" is new cwd.
                   10129: 250-"/pub/figlet" is new cwd.
                   10130: 250-
                   10131: 250-Welcome to the figlet archive at ftp.figlet.org
                   10132: 250-
                   10133: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10134: 250-
                   10135: 250-The official FIGlet web page is:
                   10136: 250-   http://www.figlet.org/
                   10137: 250-
                   10138: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10139: 250-contribute a font or something else, you can email us.
                   10140: 250
                   10141: 250 "/pub/figlet/program" is new cwd.
                   10142: 250 "/pub/figlet/program/unix" is new cwd.
                   10143: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10144: 502 Unimplemented command.
                   10145: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10146: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10147: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10148: 226 Transfer completed.
                   10149: 172219 bytes received in 00:02 (75.99 KB/s)
                   10150: 221 Goodbye.
                   10151: =&gt; Checksum OK for figlet221.tar.gz.
                   10152: ===&gt; Extracting for figlet-2.2.1nb2
                   10153: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10154: ===&gt; Patching for figlet-2.2.1nb2
                   10155: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10156: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10157: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10158: ===&gt; Configuring for figlet-2.2.1nb2
                   10159: ===&gt; Building for figlet-2.2.1nb2
                   10160: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10161: chmod a+x figlet
                   10162: gcc -O2 -o chkfont chkfont.c
                   10163: =&gt; Unwrapping files-to-be-installed.
                   10164: <code class="prompt">#</code>
                   10165: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10166: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10167: ===&gt; Installing for figlet-2.2.1nb2
                   10168: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10169: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10170: mkdir -p /usr/pkg/share/figlet
                   10171: cp figlet /usr/pkg/bin
                   10172: cp chkfont /usr/pkg/bin
                   10173: chmod 555 figlist showfigfonts
                   10174: cp figlist /usr/pkg/bin
                   10175: cp showfigfonts /usr/pkg/bin
                   10176: cp fonts/*.flf /usr/pkg/share/figlet
                   10177: cp fonts/*.flc /usr/pkg/share/figlet
                   10178: cp figlet.6 /usr/pkg/man/man6
                   10179: ===&gt; Registering installation for figlet-2.2.1nb2
                   10180: <code class="prompt">#</code></pre>
                   10181: </div>
1.41      asau     10182: <div class="sect1">
1.1       dsieger  10183: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10184: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10185: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10186: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10187: ===&gt; Packaging figlet-2.2.1nb2
                   10188: ===&gt; Building binary package for figlet-2.2.1nb2
                   10189: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10190: Using SrcDir value of /usr/pkg
                   10191: Registering depends:.
                   10192: <code class="prompt">#</code></pre>
                   10193: </div>
                   10194: </div>
1.41      asau     10195: <div class="appendix">
                   10196: <div class="titlepage"><div><div><h1 class="title">
                   10197: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1       dsieger  10198: <div class="toc">
                   10199: <p><b>Table of Contents</b></p>
1.100     leot     10200: <dl class="toc">
1.23      wiz      10201: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10202: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10203: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10204: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10205: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
                   10206: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10207: source packages</a></span></dt>
                   10208: </dl>
                   10209: </div>
                   10210: <p>As in other big projects, the directory layout of pkgsrc
                   10211:        is quite complex for newbies. This chapter explains where you
                   10212:        find things on the FTP server. The base directory on
1.10      hubertf  10213:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.1       dsieger  10214:        On other servers it may be different, but inside this directory,
                   10215:        everything should look the same, no matter on which server you
                   10216:        are. This directory contains some subdirectories, which are
                   10217:        explained below.</p>
1.41      asau     10218: <div class="sect1">
1.1       dsieger  10219: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10220: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1       dsieger  10221: <p>The directory <code class="filename">distfiles</code> contains lots
                   10222:        of archive files from all pkgsrc packages, which are mirrored
                   10223:        here. The subdirectories are called after their package names
                   10224:        and are used when the distributed files have names that don't
                   10225:        explicitly contain a version number or are otherwise too generic
                   10226:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10227: </div>
1.41      asau     10228: <div class="sect1">
1.1       dsieger  10229: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10230: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1       dsieger  10231: <p>This directory contains things that individual pkgsrc
                   10232:        developers find worth publishing.</p>
                   10233: </div>
1.41      asau     10234: <div class="sect1">
1.1       dsieger  10235: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10236: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3       rillig   10237: <p>This directory contains binary packages for the various
                   10238:        platforms that are supported by pkgsrc.
                   10239:        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.41      asau     10240: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10241: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9       rillig   10242:        operating system for which the packages have been built. The
1.10      hubertf  10243:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9       rillig   10244:        command, so it may differ from the one you are used to
                   10245:        hear.</p></li>
1.23      wiz      10246: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8       rillig   10247:        architecture of the platform for which the packages have been
1.10      hubertf  10248:        built. It also includes the <code class="varname">ABI</code> (Application
                   10249:        Binary Interface) for platforms that have several of
                   10250:        them.</p></li>
1.23      wiz      10251: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8       rillig   10252:        the operating system. For version numbers that change often (for
                   10253:        example NetBSD-current), the often-changing part should be
                   10254:        replaced with an <code class="literal">x</code>, for example
                   10255:        <code class="literal">4.99.x</code>.</p></li>
1.23      wiz      10256: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22      jakllsch 10257:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8       rillig   10258:        for a stable branch, or <code class="literal">head</code> for packages
                   10259:        built from the HEAD branch. The latter should only be used when
                   10260:        the packages are updated on a regular basis. Otherwise the date
                   10261:        from checking out pkgsrc should be appended, for example
                   10262:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   10263: </ul></div>
                   10264: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10265:        can quickly click through the directories on the
                   10266:        server and find the best binary packages for their machines. Since they
                   10267:        usually know the operating system and the hardware architecture, OPSYS
                   10268:        and ARCH are placed first. After these choices, they can select the
                   10269:        best combination of OSVERSION and TAG together, since it is usually the
                   10270:        case that packages stay compatible between different version of the
                   10271:        operating system.</p>
                   10272: <p>In each of these directories, there is a
                   10273:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  10274:        <code class="filename">All</code> which contains all binary packages.
                   10275:        Besides that, there are various category directories that
                   10276:        contain symbolic links to the real binary packages.</p>
                   10277: </div>
1.41      asau     10278: <div class="sect1">
1.1       dsieger  10279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10280: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8       rillig   10281: <p>Here are the reports from bulk builds, for those who want
                   10282:        to fix packages that didn't build on some of the platforms. The
1.23      wiz      10283:        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.8       rillig   10284: </div>
1.41      asau     10285: <div class="sect1">
1.8       rillig   10286: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10287: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
                   10288: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10289: source packages</h2></div></div></div>
1.23      wiz      10290: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.1       dsieger  10291:        that is the files that define how to create binary packages from
                   10292:        source archives.</p>
                   10293: <p>The directory <code class="filename">pkgsrc</code> contains a
                   10294:        snapshot of the CVS repository, which is updated regularly. The
                   10295:        file <code class="filename">pkgsrc.tar.gz</code> contains the same as the
                   10296:        directory, ready to be downloaded as a whole.</p>
                   10297: <p>In the directories for the quarterly branches, there is an
                   10298:        additional file called
1.22      jakllsch 10299:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.gz</code>,
1.1       dsieger  10300:        which contains the state of pkgsrc when it was branched.</p>
                   10301: </div>
                   10302: </div>
1.41      asau     10303: <div class="appendix">
                   10304: <div class="titlepage"><div><div><h1 class="title">
                   10305: <a name="editing"></a>Appendix D. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1       dsieger  10306: <div class="toc">
                   10307: <p><b>Table of Contents</b></p>
1.100     leot     10308: <dl class="toc">
1.1       dsieger  10309: <dt><span class="sect1"><a href="#targets">D.1. Make targets</a></span></dt>
                   10310: <dt><span class="sect1"><a href="#procedure">D.2. Procedure</a></span></dt>
                   10311: </dl>
                   10312: </div>
                   10313: <p>This section contains information on editing the pkgsrc
                   10314:        guide itself.</p>
1.41      asau     10315: <div class="sect1">
1.1       dsieger  10316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10317: <a name="targets"></a>D.1. Make targets</h2></div></div></div>
                   10318: <p>The pkgsrc guide's source code is stored in
                   10319:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   10320:        are created from it:</p>
1.41      asau     10321: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10322: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   10323: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   10324: <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>
                   10325: <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.1       dsieger  10326:        The PDF version of the pkgsrc guide.</p></li>
1.23      wiz      10327: <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.1       dsieger  10328:        PostScript version of the pkgsrc guide.</p></li>
                   10329: </ul></div>
                   10330: </div>
1.41      asau     10331: <div class="sect1">
1.1       dsieger  10332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10333: <a name="procedure"></a>D.2. Procedure</h2></div></div></div>
                   10334: <p>The procedure to edit the pkgsrc guide is:</p>
1.23      wiz      10335: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     10336: <li class="step"><p>Make sure you have the packages needed to
1.1       dsieger  10337:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.45      obache   10338:        documentation) installed. These are automatically installed when
1.120     sevan    10339:        you install the <a href="http://cdn.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.41      asau     10340: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  10341:        right directory. All further steps will take place
                   10342:        here.</p></li>
1.41      asau     10343: <li class="step"><p>Edit the XML file(s) in
1.1       dsieger  10344:        <code class="filename">files/</code>.</p></li>
1.41      asau     10345: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  10346:        guide for valid XML and to build the final output files. If you
                   10347:        get any errors at this stage, you can just edit the files, as
                   10348:        there are only symbolic links in the working directory, pointing
                   10349:        to the files in <code class="filename">files/</code>.</p></li>
1.41      asau     10350: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  10351:        commit)</strong></span></p></li>
1.41      asau     10352: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  10353:        regenerate the output files with the proper RCS
                   10354:        Ids.</p></li>
1.41      asau     10355: <li class="step">
1.10      hubertf  10356: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  10357:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   10358:        <code class="filename">htdocs</code>.</p>
1.41      asau     10359: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  10360: <h3 class="title">Note</h3>
                   10361: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  10362:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   10363:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  10364:        directory.</p>
                   10365: </div>
                   10366: </li>
                   10367: </ol></div>
                   10368: </div>
                   10369: </div>
                   10370: </div></body>
                   10371: </html>

CVSweb <webmaster@jp.NetBSD.org>